Uso de CCaaS_GetRepresentativeAvailabilityBeforeConversation

Use el CCaaS_GetRepresentativeAvailabilityBeforeConversation para obtener la disponibilidad representativa de la cola y del servicio antes de que se inicie la conversación.

Por ejemplo, llamando a esta API para comprobar la disponibilidad representativa del servicio, muestre un widget de chat en el sitio web solo cuando las colas pertinentes estén dentro de las horas de funcionamiento.

Use esta API cuando los sistemas externos necesiten consultar proactivamente la disponibilidad representativa del servicio y ayudar a los supervisores a tomar decisiones de optimización de personal para sus colas.

Detalles de la solicitud

URL

/\<orgurl\>/api/data/v9.2/CCaaS\_ GetRepresentativeAvailabilityBeforeConversation

Método

POST

Versión

1.0

Cabeceras de solicitud

Nombre Description
Authorization Obligatorio. Microsoft Entra ID token de autenticación para el solicitante de API en la instancia del Centro de contactos. Más información en Configuración del token para la autorización de API

Solicitud de ejemplo

Escenario Código de ejemplo
Verifique la disponibilidad de representantes del servicio para un flujo de trabajo con una única cola predeterminada. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63" }'
Determine la disponibilidad de cola pertinente para una secuencia de trabajo en la que se usan variables de contexto en reglas de ruta a cola. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "cf21df54-6d64-4aea-b668-405b8aa42b07", "CustomContextItems": "{\"contextItem1\": {\"value\": \"contextItemValue1\", \"isDisplayable\": true, \"datatype\": \"DataType1\"}, \"contextItem2\": {\"value\": \"contextItemValue2\", \"isDisplayable\": true, \"datatype\": \"DataType2\"}}" }'
Agregar o invalidar elementos de contexto. Por ejemplo, encuesta. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer <Token>' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "CustomContextItems": "{\"Survey\": {\"value\": \"India\", \"isDisplayable\": true, \"datatype\": \"192350000\"}}" }'
Determine la disponibilidad representativa del servicio cuando una conversación tiene reglas sobre la entidad de contexto de interacción. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "ChannelEngagementContext": "{"msdyn_browser": "Edge",\n "msdyn_city": "florida"\n}"" '
Determinar la disponibilidad representativa del servicio cuando las reglas están presentes en los elementos de contexto y el contexto de interacción curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "ChannelEngagementContext": "{"msdyn_browser": "Edge", \n "msdyn_city": "florida"\n}", "CustomContextItems": "{\"contextItem1\": {\n \"value\": \"contextItemValue1\",\n \"isDisplayable\": true,\n \"datatype\": \"DataType1\"\n },\"contextItem12\": {\n \"value\": \"contextItemValue2\",\n \"isDisplayable\": true,\n \"datatype\": \"DataType2\"\n }}" }'

Nota:

  • En el cuerpo de la solicitud, CustomContextItems es una cadena con los elementos de contexto usados en las reglas de ruta a cola. Lista de ejemplos de elementos de contexto:

    {
  "contextItemName1": {
    "value": "contextItemValue1",
    "isDisplayable": true,
    "datatype": "DataType1"
  },
  "contextItemName2": {
    "value": "contextItemValue2",
    "isDisplayable": true,
    "datatype": "DataType2"
  }
}

  • isDisplayable indica si el elemento de contexto se muestra en la pantalla. Este valor es True o False.

  • datatype solo puede ser Text = 192350000 o Integer = 192350001

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK. El método también devuelve los siguientes códigos de estado.

Estado HTTP Description
400 Petición incorrecta (parámetros de entrada incorrectos)
401 No autorizado
404 Recurso no encontrado
429 Límite de tasa (demasiadas solicitudes)
405 API no autorizada
500 Error interno del servidor

Valores de la respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK. El método también devuelve los siguientes códigos de estado.

Estado HTTP Description
400 Petición incorrecta (parámetros de entrada incorrectos)
401 No autorizado
404 Recurso no encontrado
429 Límite de tasa (demasiadas solicitudes)
405 API no autorizada
500 Error interno del servidor

Valores de la respuesta

Nombre Tipo Description
queueId String La cola de destino en la que se enruta la solicitud en función de las configuraciones de reglas de enrutamiento y los datos de entrada, como los valores de entidad y el contexto que forman parte de la regla de enrutamiento.
isQueueAvailable Booleano Muestra TRUE si la cola está dentro de las horas de funcionamiento. FALSE si la cola está fuera del horario operativo.
HoraDeInicioDeLaPróximaHoraOperativa DateTime La hora de inicio (UTC) de las horas de funcionamiento de la cola si está actualmente fuera del horario operativo. Devuelve 01-01-0001 durante las horas de funcionamiento.
HoraFinalDelSiguienteHoraOperativa DateTime La hora (UTC) en que finaliza el horario de funcionamiento de la cola, si actualmente está fuera de dicho horario. Devuelve 01-01-0001 durante las horas de funcionamiento.
próximohorariodetransición DateTime La hora (UTC) en la que la cola vuelve a estar operativa si está fuera del horario de atención. Durante las horas de funcionamiento, se muestra cuando la cola deja de funcionar.
positionInQueue Number Posición en la cola para un cliente que espera detrás de otros en la misma cola.
¿EstáDisponibleElAgente? Booleano Muestra:
  • TRUE si los representantes de servicio de la cola están actualmente disponibles para tomar solicitudes según las reglas de enrutamiento y asignación del flujo de trabajo.
  • FALSE si los representantes de servicio no están disponibles para atender solicitudes.
tiempoDeEsperaPromedio Number Tiempo medio de espera en minutos para los clientes de la cola objetivo.
AverageWaitTimeInSeconds Números Tiempo de espera promedio en segundos para usuarios en la cola objetivo.
NúmeroDeExpertosDisponiblesEnCola Números Número de representantes de servicio disponibles actualmente para aceptar conversaciones en la cola de destino.

Respuesta de ejemplo

{  
"@odata.context": "https://<org-url>/api/data/v9.2/\$metadata#Microsoft.Dynamics.CRM.CCaaS_GetRepresentativeAvailabilityForConversationResponse",  
"NextTransitionTime": "9999-12-31T23:59:59Z",
"NumberOfExpertsAvailableInQueue": 5,
"AverageWaitTimeInSeconds": 45  
"PositionInQueue": 1,  
"AverageWaitTime": null,  
"StartTimeOfNextOperatingHour": "0001-01-01T00:00:00Z",  
"EndTimeOfNextOperatingHour": "0001-01-01T00:00:00Z",  
"QueueId": "85e55877-f27a-e911-a81a-000d3a1ca610",  
"IsAgentAvailable": true,  
"IsQueueAvailable": true  
}

Uso de API de disponibilidad representativas
CCaaS_ObtenerDisponibilidadDelRepresentanteParaConversación

  • Last updated on