Les appels de rappel sont des appels demandés par un utilisateur final. Avec l'API d'appel de rappel, vous pouvez programmer des appels de rappel et annuler des appels programmés de manière programmatique. Grâce à ces fonctionnalités, vous pouvez créer des applications permettant aux utilisateurs finaux de demander des appels de rappel à partir d'une file d'attente que vous spécifiez. Les utilisateurs finaux peuvent également annuler les appels qu'ils ont programmés précédemment. Pour en savoir plus sur l'authentification avec l'API d'appel de rappel, consultez la section Authentification de base.
Utiliser l'API d'appel de rappel
Vous pouvez utiliser l'API d'appel de rappel pour programmer des appels de rappel et annuler des appels programmés.
Programmer un appel
Si votre instance est intégrée à Salesforce, cochez le paramètre Closed record options when initiating an API-scheduled call (Options d'enregistrement fermé lors du lancement d'un appel programmé par l'API) sous Settings > Operation Management > CRM Record Creation Details (Paramètres > Gestion des opérations > Détails de création d'enregistrement CRM). Les requêtes de programmation sont
refusées avec 422 lorsque l'option Don't check the record status (Ne pas vérifier l'état de l'enregistrement) est sélectionnée. Cela ne s'applique pas à Zendesk ni à ServiceNow.
Pour programmer un appel, appelez POST https://<subdomain>.<domain>/apps/api/v1/calls
et incluez un corps de requête semblable à celui-ci :
{
"call_type": "ScheduledCall",
"menu_id": 12345,
"end_user_number": "+18005550100",
"scheduled_at": "2025-09-02T14:30:00Z"
}
Une requête réussie renvoie un objet d'appel, y compris l'ID de l'appel.
Annuler un appel programmé
Pour annuler un appel programmé, appelez PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel. Spécifiez l'ID de l'appel que vous souhaitez annuler.
Une requête réussie renvoie des informations sur l'appel annulé.
Annuler plusieurs appels programmés
Pour annuler plusieurs appels programmés, appelez PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel. Incluez un corps de requête contenant un tableau call_ids des ID d'appel, sous forme d'entiers, pour les appels à annuler. Une valeur qui n'est pas un tableau ou qui contient une entrée non entière est refusée avec 400.
Consultez l'exemple de code suivant :
{
"call_ids": [123, 456, 789]
}
Une requête réussie renvoie une réponse avec un en-tête de réponse contenant une URL Location permettant de vérifier l'état de l'annulation.
Utiliser des appels de rappel avec des CRM
Vous pouvez utiliser l'API d'appels de rappel avec les intégrations CRM Salesforce, Zendesk et ServiceNow.
Comportement général des rappels
Si vous utilisez un CRM compatible (Salesforce, Zendesk ou ServiceNow), les conditions suivantes affectent le comportement des rappels programmés :
Un enregistrement est ouvert et comporte déjà un appel programmé actif : si une recherche d'ID de demande indique que l'enregistrement est ouvert et comporte déjà un appel programmé actif, l'appel n'est pas programmé. Le commentaire suivant est associé à l'enregistrement CRM :
A scheduled call was not created because the record already has an active scheduled call.Le CRM est inaccessible : si une recherche d'ID de demande indique que le CRM est inaccessible, l'appel est annulé. Le commentaire suivant est associé à l'enregistrement CRM :
A scheduled call was canceled because the CRM was unreachable.
Comportement des rappels avec des enregistrements fermés
La façon dont les appels de rappel sont gérés pour les enregistrements fermés varie en fonction du CRM que vous utilisez :
Utilisateurs de Zendesk et de ServiceNow : si une recherche d'ID de demande indique que l' enregistrement est fermé, l'appel n'est pas programmé. Le commentaire suivant est associé à l'enregistrement CRM :
A scheduled call was not created because the record is closed.Utilisateurs de Salesforce : consultez Appels de rappel avec Salesforce pour configurer la façon dont votre instance gère les appels programmés pour les enregistrements fermés.
Appels de rappel avec Salesforce
Si vous avez intégré CCAI Platform à Salesforce, vous pouvez configurer la façon dont votre instance gère les appels programmés pour les enregistrements fermés. Voici les options de configuration pour les intégrations Salesforce :
Ne pas vérifier l'état de l'enregistrement
Vous pouvez configurer CCAI Platform pour qu'elle ne vérifie pas l'état de l'enregistrement avant de passer un appel programmé. Lorsque cette option est sélectionnée, les requêtes de programmation d'un appel via l'API d'appel de rappel sont refusées avec 422.
Pour configurer CCAI Platform afin qu'elle ne vérifie pas l'état de l'enregistrement, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Operation Management (Paramètres > Gestion des opérations). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Accédez à CRM Record Creation Details > Closed record options when initiating an API-scheduled call (Détails de création d'enregistrement CRM > Options d'enregistrement fermé lors du lancement d'un appel programmé par l'API).
Sélectionnez Don't check the record status. Always initiate the API-scheduled call (Ne pas vérifier l'état de l'enregistrement. Toujours lancer l'appel programmé par l'API).
Cliquez sur Save General (Enregistrer les paramètres généraux).
Vérifier l'état de l'enregistrement et rouvrir les enregistrements fermés
Vous pouvez configurer CCAI Platform pour qu'elle vérifie l'état de l'enregistrement avant de passer un appel programmé et qu'elle rouvre les enregistrements fermés. Avec cette configuration, si l'état de l'enregistrement est "fermé", les actions suivantes ont lieu :
L'appel est passé comme prévu.
L'enregistrement est rouvert.
Le commentaire suivant est associé à l'enregistrement CRM :
The record was reopened at the time of a scheduled call.
Pour configurer CCAI Platform afin qu'elle vérifie l'état de l'enregistrement et rouvre les enregistrements fermés, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Operation Management (Paramètres > Gestion des opérations). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Accédez à CRM Record Creation Details > Closed record options when initiating an API-scheduled call (Détails de création d'enregistrement CRM > Options d'enregistrement fermé lors du lancement d'un appel programmé par l'API).
Sélectionnez Check the record status. If the record is closed > Reopen the record (Vérifier l'état de l'enregistrement. Si l'enregistrement est fermé > Rouvrir l'enregistrement).
Cliquez sur Save General (Enregistrer les paramètres généraux).
Vérifier l'état de l'enregistrement et annuler les appels programmés pour les enregistrements fermés
Vous pouvez configurer CCAI Platform pour qu'elle vérifie l'état de l'enregistrement avant de passer un appel programmé et qu'elle annule les appels programmés pour les enregistrements fermés. Avec cette configuration, si l'état de l'enregistrement est "fermé", les actions suivantes ont lieu :
L'appel programmé est annulé.
Le commentaire suivant est associé à l'enregistrement CRM :
A scheduled call was canceled because the record is closed.
Pour configurer CCAI Platform afin qu'elle vérifie l'état de l'enregistrement et annule les appels programmés pour les enregistrements fermés, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Operation Management (Paramètres > Gestion des opérations). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Accédez à CRM Record Creation Details > Closed record options when initiating an API-scheduled call (Détails de création d'enregistrement CRM > Options d'enregistrement fermé lors du lancement d'un appel programmé par l'API).
Sélectionnez Check the record status. If the record is closed > Cancel the scheduled call (Vérifier l'état de l'enregistrement. Si l'enregistrement est fermé > Annuler l'appel programmé).
Cliquez sur Save General (Enregistrer les paramètres généraux).