Use CCaaS_GetRepresentativeAvailabilityBeforeConversation

Use o CCaaS_GetRepresentativeAvailabilityBeforeConversation para obter a fila e a disponibilidade do representante de serviço antes de a conversa começar.

Por exemplo, ao aceder a esta API para verificar a disponibilidade dos representantes de serviço, mostre um widget de chat no seu site apenas quando as filas relevantes estiverem dentro do horário de funcionamento.

Use esta API quando sistemas externos precisam de consultar proativamente a disponibilidade dos representantes de serviço e ajudar os supervisores a tomar decisões de otimização de pessoal para as suas filas.

Detalhes do pedido

URL

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

Método

POST

Versão

1.0

Cabeçalhos de solicitação

Nome Descrição
Authorization Obrigatório. Token portador do Microsoft Entra ID para o chamador da API na instância do Centro de Contacto. Saiba mais em Token de configuração para autorização de API

Pedido de amostra

Scenario Código de exemplo
Verifique a disponibilidade de representante de serviço para um fluxo de trabalho com uma única fila predefinida. 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" }'
Determinar a disponibilidade relevante da fila para um fluxo de trabalho onde variáveis de contexto são usadas nas regras de rota para fila. 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\"}}" }'
Adicionar ou sobrepor elementos de contexto. Por exemplo, inquérito. 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 a disponibilidade dos representantes de serviço quando uma conversa tem regras relativas à entidade de contexto de envolvimento. 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 a disponibilidade dos representantes de serviço quando as regras estão presentes tanto em itens de contexto como no contexto de envolvimento 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 }}" }'

Observação

  • No corpo do pedido, CustomContextItems é uma string com os elementos de contexto usados nas regras de rota para fila. A lista de exemplos de itens de contexto:

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

  • isDisplayable indica se o elemento de contexto é exibido no ecrã. Este valor é Verdadeiro ou Falso.

  • datatype só pode ser Texto = 192350000 ou Inteiro = 192350001

Resposta

Se for bem-sucedido, este método devolve um código de resposta de 200 OK. O método também devolve os seguintes códigos de estado.

Estado HTTP Descrição
400 Pedido Mau (Parâmetros de entrada errados)
401 Não autorizado
404 Recurso não encontrado
429 Limite de taxa (pedidos a mais)
405 API não permitida
500 Erro interno do servidor

Valores de resposta

Se for bem-sucedido, este método devolve um código de resposta de 200 OK. O método também devolve os seguintes códigos de estado.

Estado HTTP Descrição
400 Pedido Mau (Parâmetros de entrada errados)
401 Não autorizado
404 Recurso não encontrado
429 Limite de taxa (pedidos a mais)
405 API não permitida
500 Erro interno do servidor

Valores de resposta

Nome Type Descrição
queueId String A fila alvo onde o pedido é encaminhado com base nas configurações das regras de encaminhamento e nos dados de entrada, como valores de entidades e contexto, que fazem parte da regra de encaminhamento.
isQueueDisponível booleano Mostra TRUE se a fila estiver dentro do horário de funcionamento. FALSE se a fila estiver fora do horário de funcionamento.
Hora de Início da Próxima Hora de Funcionamento DateTime A hora de início (UTC) do horário de funcionamento da fila, caso esta esteja atualmente fora do horário de funcionamento. Retorna a 01-01-0001 durante o horário de funcionamento.
Hora de Término da Próxima Operação DateTime A hora (UTC) em que o horário de funcionamento termina para a fila, caso esta esteja atualmente fora do horário de funcionamento. Retorna a 01-01-0001 durante o horário de funcionamento.
nextTransitionTime DateTime A hora (UTC) em que a fila está operacional novamente se estiver fora do horário de funcionamento. Durante o horário de funcionamento, aparece quando a fila deixa de funcionar.
positionInQueue Number Posição na fila para um cliente que está atrás de outros na mesma fila.
isAgentAvailable booleano Apresenta:
  • VERDADE se os representantes de serviço na fila estiverem atualmente disponíveis para receber pedidos com base nas regras de encaminhamento e atribuição do fluxo de trabalho.
  • FALSE se os representantes do serviço não estiverem disponíveis para aceitar pedidos.
TempoDeEspera Médio Number Tempo médio de espera em minutos para os clientes na fila alvo.
TempoDeEsperaMédioEmSegundos Números Tempo médio de espera em segundos para os clientes na fila alvo.
NúmeroDeEspecialistasDisponíveisNa Fila Números O número de representantes de atendimento atualmente disponíveis para aceitar conversas na fila específica.

Resposta de exemplo

{  
"@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  
}

Utilizar APIs de disponibilidade representativa
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on