Skip to navigation

Assign Appointment to Operator_External

View as Markdown

Este método permite asignar una cita existente a un agente utilizando el identificador externo del usuario (userExternalId) y el identificador externo de la organización o entidad (companyExternalId). Esta variante es ideal para integraciones con CRMs o sistemas legados del cliente, ya que permite realizar la asignación sin necesidad de conocer los identificadores numéricos internos de la base de datos de OVAC.

Detalles de la Solicitud

  • Método HTTP: POST

  • URL PRE: https://api.ovac.pre.councilbox.com/graphql

  • URL PRO: https://api.ovac.councilbox.com/graphql

Autenticación

Tipo: API Key**
Header:** x-jwt-token
Ubicación: Header HTTP_
Ejemplo:_ x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6...

Referencia de la API

Parámetros de Entrada (Variables)

ParámetroDescripciónRequeridoTipo
councilIdIdentificador numérico único de la cita en la plataforma.SIInteger
userExternalIdIdentificador único del usuario en el sistema de origen del cliente.SIString
companyExternalIdIdentificador único de la entidad u organización en el sistema de origen del cliente.SIString

Campos de Respuesta (Payload)

La mutación devuelve un objeto assignCouncilToUser con el resultado de la asignación de personal:

ParámetroDescripciónTipo
dataObjeto datoObject
data.assignCouncilToUserObjeto del usuarioObject
data.assignCouncilToUser.successValor booleano de verificación de asignación.Boolean
data.assignCouncilToUser.messageError que devuelve, por defecto nullString

Ejemplos de Código y Peticiones

1. Mutación GraphQL

mutation AssignCouncilToUser(
$councilId: Int!,
$userId: Int,
$userExternalId: String,
$companyExternalId: String
) {
assignCouncilToUser(
councilId: $councilId,
userId: $userId,
userExternalId: $userExternalId,
companyExternalId: $companyExternalId
) {
success
message
}
}

2. Variables de la Petición (JSON Payload)

{
"councilId": 64886,
"userExternalId": "TEST001",
"companyExternalId": "API_TEST"
}

3. Ejemplo de comando cURL

curl --location "https://api.ovac.pre.councilbox.com/graphql" \
--header "Content-Type: application/json" \
--header "x-jwt-token: {{token}}" \
--data '{"query":"mutation AssignCouncilToUser($councilId: Int!, $userId: Int, $userExternalId: String, $companyExternalId: String) { assignCouncilToUser(councilId: $councilId, userId: $userId, userExternalId: $userExternalId, companyExternalId: $companyExternalId) { success message } }","variables":{"councilId":64886,"userExternalId":"TEST001","companyExternalId":"API_TEST"}}'

4. Respuesta Esperada (200 OK)

{
"data": {
"assignCouncilToUser": {
"success": true,
"message": null
}
}
}

Nota OpenAPI/Fern: esta operación GraphQL se documenta como /graphql/assigncounciltouser-2 para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es POST /graphql.

Authentication

x-jwt-tokenstring
JWT token obtained from Login.

Request

This endpoint expects an object.
querystringRequired
GraphQL operation
variablesobjectOptional
GraphQL variables

Response

Successful response. GraphQL business errors may be returned inside the JSON errors field while transport status remains HTTP 200.