API d'appel de rappel

Les appels de rappel sont des appels demandés par un utilisateur final. L'API d'appel de rappel vous permet de planifier et d'annuler des appels de rappel 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 les appels qu'ils ont planifiés. Pour en savoir plus sur l'authentification avec l'API d'appel de rappel, consultez Authentification de base.

Utiliser l'API d'appel 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 à ce qui suit :

{
    "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 planifié, appelez PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel. Spécifiez l'ID de l'appel que vous souhaitez annuler.

Si la requête aboutit, elle 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 à annuler.

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 la résiliation.

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 :

Une fiche est ouverte et un appel planifié est déjà actif : si une recherche d'ID de demande indique que la fiche est ouverte et qu'un appel planifié est déjà actif, l'appel n'est pas planifié. Le commentaire suivant est associé à la fiche 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 ticket indique que le CRM est inaccessible, l'appel est annulé. Le commentaire suivant est associé à la fiche CRM : A scheduled call was canceled because the CRM was unreachable.

Comportement de rappel avec les enregistrements fermés

La façon dont les demandes de rappel sont traitées pour les fiches clôturées varie en fonction du CRM que vous utilisez :

Utilisateurs de Zendesk et ServiceNow : si une recherche d'ID de ticket indique que la fiche est fermée, l'appel n'est pas planifié. Le commentaire suivant est associé à la fiche CRM : A scheduled call was not created because the record is closed.
Utilisateurs Salesforce : consultez Rappels avec Salesforce pour configurer la façon dont votre instance gère les appels planifiés pour les enregistrements clôturés.

Appels de rappel avec Salesforce

Si vous avez intégré la plate-forme CCAI à Salesforce, vous pouvez configurer la façon dont votre instance gère les appels planifiés pour les enregistrements clôturés. Voici les options de configuration des intégrations Salesforce :

Ne vérifiez pas l'état de l'enregistrement.
Vérifiez l'état des enregistrements et rouvrez ceux qui sont fermés.
Vérifiez l'état des enregistrements et annulez les appels programmés pour les enregistrements clôturés.

Ne pas vérifier l'état de l'enregistrement

Vous pouvez configurer CCAI Platform pour 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 la fiche soit ouverte ou fermée.

Pour configurer la plate-forme CCAI 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 Paramètres ne s'affiche pas, cliquez sur Menu.
Accédez à Détails de la création d'une fiche CRM> Options de fiche fermée lors de l'initiation d'un appel planifié par API.
Sélectionnez Ne pas vérifier l'état de l'enregistrement. Initiez 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 planifié et rouvre les enregistrements fermés. Avec cette configuration, si l'état de l'enregistrement est "Fermé", les actions suivantes sont effectuées :

L'appel est effectué 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'il vérifie l'état des enregistrements et rouvre les enregistrements clôturé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'une fiche CRM> Options de fiche fermée lors de l'initiation d'un appel planifié par API.
Sélectionnez Vérifier l'état de l'enregistrement. Si la fiche est fermée >rouvrez-la.
Cliquez sur Enregistrer les paramètres généraux.

Vérifier l'état des enregistrements et annuler les appels planifiés pour les enregistrements clôturés

Vous pouvez configurer CCAI Platform pour qu'il vérifie l'état de l'enregistrement avant de passer un appel programmé et qu'il annule les appels programmés pour les enregistrements clôturés. Avec cette configuration, si l'état de l'enregistrement est "Fermé", les actions suivantes sont effectuées :

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'il vérifie l'état des enregistrements et annule les appels planifiés pour les enregistrements clôturé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'une fiche CRM> Options de fiche fermée lors de l'initiation d'un appel planifié par API.
Sélectionnez Vérifier l'état de l'enregistrement. Si la fiche est fermée >annulez l'appel planifié.
Cliquez sur Enregistrer les paramètres généraux.