Cette page explique comment utiliser la pagination et le suivi lors de l'appel des points de terminaison de l'API Manager.
Pagination
La pagination est compatible avec la plupart des points de terminaison de l'API Manager. Pour connaître les exceptions, consultez Suivre un point de terminaison pour les enregistrements mis à jour.
Définir la taille de la page
Par défaut, les points de terminaison de l'API Manager renvoient des pages contenant 100 enregistrements. Vous pouvez modifier ce nombre à l'aide du paramètre de requête per, jusqu'à un maximum de 100. Une valeur supérieure est réduite à 100.
Pour définir la taille de la page, utilisez le point de terminaison suivant :
/manager/api/v1/agents?per=50
La taille de la page est ainsi définie sur 50 enregistrements.
Demander une page spécifique
Vous pouvez demander une page d'enregistrements spécifique à l'aide du paramètre de requête page.
Pour demander une page spécifique, utilisez le point de terminaison suivant :
/manager/api/v1/agents?page=2
Cela renvoie la deuxième page d'enregistrements.
Obtenir tous les enregistrements disponibles
Par défaut, l'API Manager renvoie 100 enregistrements dans une page de réponse, mais vous pouvez modifier le nombre d'enregistrements d'une page en définissant la taille de la page. Pour les points de terminaison compatibles avec la pagination, l'en-tête de réponse inclut le nombre total d'enregistrements disponibles. Si ce nombre dépasse la taille de votre page, vous devez appeler l'API plusieurs fois pour obtenir tous les enregistrements. Pour les points de terminaison compatibles avec la pagination, la réponse inclut un en-tête Link conformément à la RFC 5988. Un lien rel="next" est présent chaque fois que d'autres enregistrements sont disponibles, et un lien rel="last" indique le numéro de la dernière page. La réponse inclut également les en-têtes Total et Per-Page.
Pour obtenir tous les enregistrements disponibles, procédez comme suit :
Appelez un point de terminaison de l'API de gestionnaire compatible avec la pagination. Pour en savoir plus, consultez Pagination. L'en-tête de réponse indique le nombre d'enregistrements à renvoyer.
Comparez le nombre d'enregistrements à renvoyer avec la taille de votre page. Si le nombre d'enregistrements à renvoyer est inférieur à la taille de votre page, tous les enregistrements ont été renvoyés. Sinon, passez à l'étape suivante.
Appelez à nouveau le point de terminaison en spécifiant la page d'enregistrements suivante. Pour en savoir plus, consultez Demander une page spécifique. Répétez cette étape jusqu'à ce que tous vos enregistrements soient renvoyés.
Suivre un point de terminaison pour les enregistrements mis à jour
Google déconseille d'utiliser la pagination pour les points de terminaison d'API call, chat et agent activity, car nous ne pouvons pas garantir des résultats optimaux. Nous vous recommandons plutôt de suivre ces points de terminaison d'API pour les enregistrements mis à jour. Suivre un point de terminaison d'API signifie l'appeler en continu pour obtenir les enregistrements nouveaux ou mis à jour depuis votre dernière requête.
Suivre le point de terminaison de l'API Calls
Chaque fois qu'un enregistrement d'appel est modifié, son code temporel updated_at est mis à jour. Vous pouvez utiliser le code temporel pour spécifier les enregistrements d'appels que vous souhaitez récupérer lorsque vous appelez le point de terminaison de l'API Calls.
Pour suivre le point de terminaison de l'API Calls toutes les 60 minutes, procédez comme suit :
Envoyez une requête au point de terminaison de l'API Calls (
/manager/api/v1/calls) en spécifiant les paramètres de requête suivants :updated_at[from]: spécifiez que vous souhaitez obtenir les enregistrements mis à jour à cette date ou après.sort_column: spécifiez le champ selon lequel trier les enregistrements.sort_direction. Spécifiez le sens de tri des enregistrements dans la réponse.
Voici un exemple de script Bash qui utilise la commande
curl:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/calls?updated_at[from]=${TIMESTAMP}&sort_column=updated_at&sort_direction=asc" | jqL'API Calls renvoie une réponse semblable à la suivante :
[ { "id": 100, ... "updated_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "updated_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "updated_at": "2025-01-03T00:00:00Z" } ]Les objets de réponse mis à jour à la date et l'heure spécifiées ou après sont renvoyés, triés par date, dans l'ordre croissant. Utilisez le code temporel
updated_atdu dernier objet de cette réponse pour le code temporel de votre prochain appel au point de terminaison. Le filtrefromest inclusif. Par conséquent, la réponse suivante répète l'enregistrement à ce code temporel. Dédupliquez les ID d'enregistrement ou enregistrez les ID déjà traités à ce code temporel et ignorez-les.Appelez le point de terminaison de l'API d'appel 60 minutes plus tard. Les enregistrements d'appels mis à jour depuis votre dernière requête sont renvoyés.
Répétez l'étape précédente pour continuer à suivre le point de terminaison.
Suivre le point de terminaison de l'API Chats
Utilisez le code temporel updated_at du dernier objet de cette réponse pour le code temporel de votre prochain appel au point de terminaison. Le filtre updated_at[from] est inclusif. Par conséquent, la réponse suivante répète l'enregistrement à ce code temporel. Dédupliquez les ID d'enregistrement ou enregistrez les ID déjà traités à ce code temporel et ignorez-les.
Chaque fois qu'un enregistrement de chat est modifié, son code temporel updated_at est mis à jour. Vous pouvez utiliser le code temporel pour spécifier les enregistrements de chat que vous souhaitez récupérer lorsque vous appelez le point de terminaison de l'API Chats.
Pour suivre le point de terminaison de l'API Chats toutes les 60 minutes, procédez comme suit :
Envoyez une requête au point de terminaison de l'API Chats (
/manager/api/v1/chats) en spécifiant les paramètres de requête suivants :updated_at[from]: spécifiez que vous souhaitez obtenir les enregistrements mis à jour à cette date ou après.sort_column: spécifiez le champ selon lequel trier les enregistrements.sort_direction. Spécifiez le sens de tri des enregistrements dans la réponse.
Voici un exemple de script Bash qui utilise la commande
curl:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3.. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/chats?updated_at[from]=${TIMESTAMP}&sort_column=updated_at&sort_direction=asc" | jqL'API Chats renvoie une réponse semblable à la suivante :
[ { "id": 100, ... "updated_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "updated_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "updated_at": "2025-01-03T00:00:00Z" } ]Les objets de réponse mis à jour à la date et l'heure spécifiées ou après sont renvoyés, triés par date, dans l'ordre croissant. Utilisez le code temporel
updated_atdu dernier objet de cette réponse pour le code temporel de votre prochain appel au point de terminaison.Appelez à nouveau le point de terminaison de l'API 60 minutes plus tard. Les enregistrements de chat mis à jour depuis votre dernière requête sont renvoyés.
Répétez l'étape précédente pour continuer à suivre le point de terminaison.
Suivre le point de terminaison de l'API Agent Activity
Contrairement aux enregistrements de chat et d'appel, les journaux d'activité des agents ne sont pas mis à jour et ne comportent donc pas de code temporel updated_at. Vous pouvez utiliser le code temporel started_at pour spécifier les enregistrements d'activité que vous souhaitez récupérer lorsque vous appelez le point de terminaison de l'API Agent Activity. Le filtre started_at[from] est inclusif. Par conséquent, la réponse suivante répète l'enregistrement à ce code temporel. Dédupliquez l'ID d'enregistrement ou enregistrez les ID déjà traités à ce code temporel et ignorez-les.
Pour suivre le point de terminaison de l'API Agent Activity toutes les 60 minutes, procédez comme suit :
Envoyez une requête au point de terminaison de l'API Agent Activity (
/manager/api/v1/agent_activity_logs) en spécifiant les paramètres de requête suivants :started_at[from]: spécifiez que vous souhaitez obtenir les journaux d'activité qui ont été démarrés à cette date ou après.ended_at[from]. Spécifiez que vous souhaitez obtenir les journaux d'activité qui se sont terminés à cette date ou après. Utilisez cette option au lieu destarted_at[from]pour capturer les sessions qui ont commencé avant votre fenêtre, mais qui se sont terminées à l'intérieur de celle-ci.page: incluez ce paramètre pour que la réponse renvoie des en-têtes de pagination. Sanspage, la réponse est limitée à la taille de page par défaut de 100 enregistrements sans renvoyer les en-têtesLink,TotalouPer-Page.sort_column: spécifiez le champ selon lequel trier les enregistrements.sort_direction. Spécifiez le sens de tri des enregistrements dans la réponse.
Voici un exemple de script Bash qui utilise la commande
curl:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/agent_activity_logs?started_at[from]=${TIMESTAMP}&sort_column=started_at&sort_direction=asc" | jqL'API Agent Activity renvoie une réponse semblable à celle-ci :
[ { "id": 100, ... "started_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "started_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "started_at": "2025-01-03T00:00:00Z" } ]Les objets de réponse démarrés à la date et l'heure spécifiées ou après sont renvoyés, triés par date, dans l'ordre croissant. Utilisez le code temporel
started_atdu dernier objet de cette réponse pour le code temporel de votre prochain appel au point de terminaison.Appelez à nouveau le point de terminaison de l'API Agent Activity 60 minutes plus tard. Les enregistrements du journal d'activité de l'agent mis à jour depuis votre dernière requête sont renvoyés.
Répétez l'étape précédente pour continuer à suivre le point de terminaison.