Usar CCaaS_GetRepresentativeAvailabilityBeforeConversation

Use o CCaaS_GetRepresentativeAvailabilityBeforeConversation para obter a disponibilidade da fila e do representante do serviço antes do início da conversa.

Por exemplo, ao chamar essa API para verificar a disponibilidade do representante do serviço, exiba um widget de chat em seu site somente quando as filas relevantes estiverem dentro do horário de funcionamento.

Use essa API quando os sistemas externos precisarem consultar proativamente a disponibilidade do representante do serviço e ajudar os supervisores a tomar decisões de otimização de pessoal para suas filas.

Solicitar detalhes

URL

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

Method

POST

Versão

1.0

Cabeçalhos de solicitação

Nome Descrição
Authorization Obrigatório. Microsoft Entra ID token de autenticação para o chamador de API na instância do Contact Center. Saiba mais no token de instalação para autorização de API

Solicitação de exemplo

Cenário Código de exemplo
Verifique a disponibilidade do representante do serviço para um fluxo de trabalho com uma única fila padrão. 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 a disponibilidade de fila relevante para um fluxo de trabalho em que variáveis de contexto são usadas em 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 substituir itens de contexto. Por exemplo, pesquisa. 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 do representante do serviço quando uma conversa tiver regras sobre a 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 do representante do serviço quando as regras estão presentes nos itens de contexto e 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 }}" }'

Note

  • No corpo da solicitação, CustomContextItems é uma string com os itens de contexto usados nas regras de roteamento 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 item de contexto é exibido na tela. Esse valor é True ou False.

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

Resposta

Se tiver êxito, esse método retornará um código de resposta 200 OK. O método também retorna os seguintes códigos de status.

HTTP Status Descrição
400 Solicitação ruim (parâmetros de entrada errados)
401 Desautorizado
404 Recurso não encontrado
429 Limite de taxa (Pedidos demais)
405 API não permitida
500 Erro interno do servidor

Valores da resposta

Se tiver êxito, esse método retornará um código de resposta 200 OK. O método também retorna os seguintes códigos de status.

HTTP Status Descrição
400 Solicitação ruim (parâmetros de entrada errados)
401 Desautorizado
404 Recurso não encontrado
429 Limite de taxa (Pedidos demais)
405 API não permitida
500 Erro interno do servidor

Valores da resposta

Nome Tipo Descrição
queueId String A fila de destino em que a solicitação é roteada com base em configurações de regra de roteamento e dados de entrada, como valores de entidade e contexto que fazem parte da regra de roteamento.
filaEstáDisponível booleano Exibe TRUE se a fila estiver dentro do horário de operação. FALSE se a fila estiver fora do horário de operação.
HoraDeInícioDaPróximaHoraOperacional DateTime A hora de início (UTC) das horas de operação da fila se ela estiver atualmente fora do horário de operação. Retorna 01-01-0001 durante o horário de operação.
HoraFinalDoPróximoPeríodoDeOperação DateTime A hora (UTC) em que o horário de operação termina para a fila, caso esteja atualmente fora desse período. Retorna 01-01-0001 durante o horário de operação.
proximahoradetransição DateTime A hora (UTC) em que a fila está operacional novamente se estiver fora do horário de funcionamento. Durante o horário operacional, é exibido quando a fila se torna não operacional.
positionInQueue Number Posição na fila para um cliente aguardando atrás de outros na mesma fila.
isAgenteDisponível booleano Apresenta:
  • TRUE se os representantes do serviço na fila estiverem disponíveis no momento para atender solicitações com base nas regras de roteamento e atribuição para fluxo de tarefas.
  • FALSE se os representantes do serviço não estiverem disponíveis para receber solicitações.
tempoMédioDeEspera Number Tempo médio de espera em minutos para clientes na fila específica.
TempoMédioDeEsperaEmSegundos Números Tempo médio de espera, em segundos, para clientes na fila alvo.
NúmeroDeEspecialistasDisponíveisNaFila Números O número de representantes de serviço atualmente disponíveis para aceitar conversas na fila de destino.

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  
}

Usar APIs de disponibilidade representativas
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on