CCaaS_GetRepresentativeAvailabilityForConversation

Use a API CCaaS_GetRepresentativeAvailabilityForConversation para obter a disponibilidade da fila e do representante do serviço durante uma conversa ativa com uma ID de conversa válida.

Por exemplo, quando um cliente que está conversando com um agente de IVR ou IA solicita escalonamento para um representante de serviço, o agente de IA chama essa API para determinar a disponibilidade do representante do serviço e rotear a conversa com base na resposta.

Solicitar detalhes

URL

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

Método

POST

Versão

1.0

Cabeçalhos de solicitação

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

Corpo da solicitação de amostra

Descrição Solicitação de exemplo
Determina a fila e a disponibilidade do representante para uma conversa ativa. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityForConversation \ --header 'Authorization: Bearer token' \ --data '{ "ApiVersion": "1.0", "ConversationId": "2f2508bd-b58e-4982-b142-651e36dc8df3" }'
Determina a fila e a disponibilidade do representante para uma conversa em que as regras de roteamento para filas precisam de mais itens de contexto. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityForConversation \ --header 'Authorization: Bearer token' \ --data '{ "ApiVersion": "1.0", "ConversationId": "cf21df54-6d64-4aea-b668-405b8aa42b07", "CustomContextItems": "{\"contextItem1\": {\"value\": \"contextItemValue1\", \"isDisplayable\": true, \"datatype\": \"DataType1\"}, \"contextItem2\": {\"value\": \"contextItemValue2\", \"isDisplayable\": true, \"datatype\": \"DataType2\"}}" }'
A regra está no item de contexto Survey (tipo: Texto, valor: Índia) curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityForConversation \ --header 'Authorization: Bearer <Token>' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "ConversationId": "94c002c8-b14e-4a0e-8069-78dcf0d6c208", "CustomContextItems": "{\"Survey\": {\"value\": \"India\", \"isDisplayable\": true, \"datatype\": \"192350000\"}}" }'

Note

  • No corpo da solicitação, CustomContextItems é uma cadeia de caracteres 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

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.
isQueueAvailable booleano Exibe TRUE se a fila estiver dentro do horário de operação. FALSO se a fila estiver fora do horário de funcionamento.
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 funcionamento termina para a fila, caso esteja fora desse horário no momento. Retorna 01-01-0001 durante o horário de operação.
nexttransitiontime 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 Número A posição na fila para um cliente aguardando atrás de outros na mesma fila.
isAgenteDisponível booleano Exibe:
  • VERDADEIRO 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 Número 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 do serviço disponíveis no momento 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_GetRepresentativeAvailabilityBeforeConversation

  • Last updated on