Utiliser CCaaS_GetRepresentativeAvailabilityBeforeConversation

Utilisez le CCaaS_GetRepresentativeAvailabilityBeforeConversation pour obtenir la disponibilité de la file d’attente et du représentant du service avant le démarrage de la conversation.

Par exemple, en appelant cette API pour vérifier la disponibilité des représentants du service, affichez un widget de conversation sur votre site web uniquement lorsque les files d’attente pertinentes sont dans les heures d’exploitation.

Utilisez cette API lorsque les systèmes externes doivent interroger de manière proactive la disponibilité des représentants du service et aider les superviseurs à prendre des décisions d’optimisation de la dotation pour leurs files d’attente.

Détails de la demande

URL

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

Méthode

POST

Version

1.0

En-têtes de demande

Nom Description
Autorisation Obligatoire. Microsoft Entra ID jeton porteur pour l’appelant de l'API dans l’instance du centre de contact. En savoir plus sur le jeton d’installation pour l’autorisation d’API

Exemple de requête

Scénario Exemple de code
Vérifiez la disponibilité du représentant du service pour un flux de travail avec une file d’attente par défaut unique. 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" }'
Déterminez la disponibilité des files d’attente pertinentes pour un flux de travail où des variables de contexte sont utilisées dans les règles de routage vers les files d’attente. 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\"}}" }'
Ajoutez ou remplacez des éléments de contexte. Par exemple, l’enquête. 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\"}}" }'
Déterminez la disponibilité du représentant du service lorsqu'une conversation contient des règles concernant l'entité de contexte d'engagement. 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}"" '
Déterminer la disponibilité du représentant du service lorsque des règles sont présentes sur les éléments de contexte et le contexte d’engagement 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

  • Dans le corps de la requête, CustomContextItems est une chaîne avec les éléments de contexte utilisés dans les règles de routage vers une file d'attente. Exemple de liste d’éléments de contexte :

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

  • isDisplayable indique si l’élément de contexte s’affiche à l’écran. Cette valeur est True ou False.

  • datatype peut uniquement être Text = 192350000 ou Integer = 192350001

Réponse

Si elle réussit, cette méthode retourne un code de réponse 200 OK. La méthode retourne également les codes d’état suivants.

État HTTP Description
400 Mauvaise requête (mauvais paramètres d’entrée)
401 Non autorisé
404 Ressource non trouvée
429 Limite de taux (trop de demandes)
405 API non autorisée
500 Erreur interne du serveur

Valeurs de réponse

Si elle réussit, cette méthode retourne un code de réponse 200 OK. La méthode retourne également les codes d’état suivants.

État HTTP Description
400 Mauvaise requête (mauvais paramètres d’entrée)
401 Non autorisé
404 Ressource non trouvée
429 Limite de taux (trop de demandes)
405 API non autorisée
500 Erreur interne du serveur

Valeurs de réponse

Nom Type Description
queueId String File d’attente cible où la requête est routée en fonction des configurations de règle de routage et des données d’entrée telles que les valeurs d’entité et le contexte qui font partie de la règle de routage.
isQueueAvailable Boolean Affiche TRUE si la file d’attente se trouve dans les heures d’exploitation. FALSE si la file d’attente est en dehors des heures d’exploitation.
Heure de début de la prochaine heure de fonctionnement DateHeure Heure de début (UTC) des heures d’exploitation de la file d’attente si elle est actuellement en dehors des heures d’exploitation. Renvoie 01-01-0001 pendant les heures de fonctionnement.
HeureDeFinDeLaProchaineHeureDeFonctionnement DateHeure Heure (UTC) lorsque les heures d’exploitation se terminent pour la file d’attente, si elles sont actuellement en dehors des heures d’exploitation. Renvoie 01-01-0001 pendant les heures de fonctionnement.
HeureDeLaProchaineTransition DateHeure Heure (UTC) à laquelle la file d’attente est à nouveau opérationnelle si elle est en dehors des heures d’ouverture. Pendant les heures d’exploitation, s’affiche lorsque la file d’attente devient non opérationnelle.
positionInQueue Numéro Position dans la file d’attente d’un client en attente derrière d’autres personnes dans la même file d’attente.
EstAgentDisponible Boolean Écrans:
  • TRUE si les représentants du service dans la file d’attente sont actuellement disponibles pour prendre des demandes en fonction des règles de routage et d’affectation pour le flux de travail.
  • FALSE si les représentants du service ne sont pas disponibles pour prendre des demandes.
averageWaitTime Numéro Temps d’attente moyen en minutes pour les clients dans la file d’attente cible.
TempsAttenteMoyenEnSecondes Nombres Temps d’attente moyen en secondes pour les clients dans la file d’attente cible.
NombreDExpertsDisponiblesDansLaFileDAttente Nombres Nombre de représentants de service actuellement disponibles pour accepter les conversations dans la file d’attente cible.

Exemple de réponse

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

Utiliser des API de disponibilité représentatives
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on