Les appels de rappel sont des appels demandés par un utilisateur final. Avec l'API d'appel de rappel, vous pouvez planifier des appels de rappel et annuler des appels planifiés de manière programmatique. Grâce à ces fonctionnalités, vous pouvez créer des applications qui permettent aux utilisateurs finaux de demander des rappels à partir d'une file d'attente que vous spécifiez. Les utilisateurs finaux peuvent également annuler des appels qu'ils ont programmés. Pour en savoir plus sur l'authentification avec l'API d'appel de rappel, consultez Authentification de base.
Utiliser l'API de rappel
Vous pouvez utiliser l'API d'appel de rappel pour planifier des appels de rappel et annuler des appels planifiés.
Planifier un appel
Pour planifier 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 d'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 un 200 OK avec l'objet d'appel mis à jour. La valeur status de l'objet d'appel est cancelled lorsque l'appel attendait l'heure programmée, ou entrait ou attendait dans la file d'attente, et completed lorsque vous annulez un rappel d'agent virtuel actif qui a déjà effectué sa première tentative de numérotation.
Si l'appel a déjà été annulé, la requête renvoie 204 No Content avec un corps vide. Une requête pour un appel qui a déjà échoué pour une raison autre qu'une annulation, ou qui est dans un état qui ne peut pas être annulé, renvoie 400.
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 des appels à annuler.
Consultez l'exemple de code suivant :
{
"call_ids": [123, 456, 789]
}
Une requête réussie renvoie un code 202 Accepted avec un en-tête de réponse Location pointant vers une ressource de job que vous pouvez interroger pour vérifier l'état d'avancement. La réponse 202 Accepted ne signifie pas que tous les appels sont déjà annulés. Suivez l'en-tête Location pour confirmer l'achèvement et inspecter les échecs partiels.
Utiliser les appels de rappel avec les 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 un appel est déjà planifié : si une recherche d'ID de demande indique que l'enregistrement est ouvert et qu'un appel est déjà planifié, l'appel n'est pas planifié. 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 les 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 ServiceNow : si une recherche d'ID de ticket indique que l'enregistrement est fermé, l'appel n'est pas planifié. 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 manière dont votre instance gère les appels planifiés pour les enregistrements fermés.
Appels de rappel avec Salesforce
Si vous avez intégré la plate-forme CCAI à Salesforce, vous pouvez configurer la manière dont votre instance gère les appels planifié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 de sorte qu'il ne vérifie pas l'état de l'enregistrement avant de passer un appel programmé. Avec cette configuration, l'appel est effectué comme prévu, que l'enregistrement soit ouvert ou fermé.
Pour configurer CCAI Platform de sorte qu'il 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Accédez à Détails de la création d'un enregistrement CRM> Options d'enregistrement fermé lors du lancement d'un appel planifié par API.
Sélectionnez Ne pas vérifier l'état de l'enregistrement. Lancez toujours l'appel planifié par l'API.
Cliquez sur Enregistrer les paramètres généraux.
Vérifier l'état des enregistrements et rouvrir les enregistrements fermés
Vous pouvez configurer CCAI Platform pour qu'il vérifie l'état de l'enregistrement avant de passer un appel programmé et rouvre les enregistrements fermés. Avec cette configuration, si l'état de l'enregistrement est "closed", les actions suivantes se produisent :
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 la plate-forme CCAI afin de vérifier l'état des enregistrements et de rouvrir 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Accédez à Détails de la création d'un enregistrement CRM> Options d'enregistrement fermé lors du lancement d'un appel planifié par API.
Sélectionnez Vérifier l'état de l'enregistrement. Si l'enregistrement est fermé > Rouvrez l'enregistrement.
Cliquez sur 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'il vérifie l'état de l'enregistrement avant de passer un appel planifié et annule les appels planifiés pour les enregistrements fermés. Avec cette configuration, si l'état de l'enregistrement est fermé, les actions suivantes se produisent :
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 la plate-forme CCAI 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Accédez à Détails de la création d'un enregistrement CRM> Options d'enregistrement fermé lors du lancement d'un appel planifié par API.
Sélectionnez Vérifier l'état de l'enregistrement. Si l'enregistrement est fermé > annulez l'appel programmé.
Cliquez sur Enregistrer les paramètres généraux.