SparkTG

Documentation de Obtenir les pauses effectives (v2)

Obtenir les pauses effectives (v2)

v2

Obtenir les pauses effectives (v2)

Statuts de pause utilisables par les agents, éventuellement pour un agent

API v2v21 point de terminaison

Présentation

Liste les statuts de pause que les agents peuvent utiliser dans votre service, par exemple pour remplir la liste déroulante de statut d'un agent dans un CRM ou un CTI. « Effectives » désigne les pauses que les agents peuvent utiliser actuellement : les pauses par défaut que votre administrateur n'a pas désactivées, plus les pauses personnalisées qu'il a activées. Les pauses désactivées pour tout le service ne figurent pas dans la liste. La liste concerne toujours le service du jeton. Envoyez agent-id pour voir aussi quelles pauses un administrateur a masquées pour cet agent. Non facturé.

Points de terminaison disponibles

GET/api/v2/effective-breaks

Paramètres clés

agent-id(Integer)

L'ID de l'agent (l'id renvoyé par GET /api/v2/agents). S'il est envoyé, les pauses qu'un administrateur a masquées pour cet agent reviennent avec "disabled": true. Omettez-le, ou envoyez-le vide, pour obtenir la liste du service sans indicateurs propres à l'agent. L'agent doit être actif et appartenir au service du jeton.

Scénarios d'utilisation

Pauses de tout le service

Aucun paramètre. À utiliser lorsque vous n'avez pas d'agent précis en tête, par exemple pour afficher les noms des pauses dans un rapport. Réponse abrégée ; un service type compte une douzaine de pauses.

0 paramètreDisponible dans les exemples

Pauses d'un agent

Envoyez agent-id. Ici, un administrateur a masqué Leave pour l'agent 319, elle revient donc avec "disabled": true. La pause reste dans la liste pour que vous puissiez afficher son nom et sa couleur ; ne laissez simplement pas l'agent la choisir.

0 paramètreDisponible dans les exemples

Exemple rapide

Essayez cette API avec une simple commande cURL

Appel d'API de base
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'
💡 Remplacez <YOUR_TOKEN> par votre jeton d’API

Aperçu de la réponse

Exemple de réponse de cette API

Exemple de réponse
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...
Voir le format de réponse complet dans la section Réponse