Campagnes et contacts dans l'API
Une campagne se compose de trois parties : contacts, pool d'options pour le premier message et comptes associés. Ci-dessous les opérations de la version v2; l'identifiant du client est substitué par le token.
Campagnes#
/v2/campaignsListe des campagnes du client.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/campaignsCréer une campagne. Le corps de la demande est en JSON.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/campaigns/{campaign_id}Fiche de la campagne.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}/updateModifier les paramètres de la campagne. Le corps de la demande est en JSON.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}Supprimer la campagne ainsi que ses contacts et son pool de messages.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
Comptes de campagne#
/v2/campaigns/{campaign_id}/accountsAssocier des comptes à la campagne : les sorties proviendront de ceux-ci. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}/accountsDissocier des comptes de la campagne. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
Contacts#
Les contacts de la campagne sont téléchargés par fichier et exportés dans le même format. Le paramètre format accepte uniquement csv ou xlsx, par défaut csv.
/v2/campaigns/{campaign_id}/contacts/uploadTélécharger la base de contacts par fichier. Le corps de la requête est multipart/form-data avec le champ file.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
csv ou xlsx, par défaut csv
/v2/campaigns/{campaign_id}/contactsListe des contacts de la campagne.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}/contacts/statsRésumé des contacts de la campagne.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}/contacts/exportExporter les contacts de la campagne dans un fichier.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
csv ou xlsx, par défaut csv
/v2/campaigns/{campaign_id}/contactsEffacer la base de contacts de la campagne.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
Pool de messages#
Le pool conserve les variantes du message initial. L'agent NN prend le texte de celui-ci pour le contact suivant, donc le même texte n'est pas envoyé à toute la base consécutivement.
/v2/campaigns/{campaign_id}/message-poolListe des variantes du premier message de la campagne.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}/message-poolAjouter une variante de message au pool. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
/v2/campaigns/{campaign_id}/message-pool/{message_id}Supprimer une variante du pool.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
UUID de la campagne
UUID de la variante de message
Suivant#
- Lancer la première campagne via l'API — ordre des appels dans leur intégralité.
- Dialogues — que se passe-t-il après l'envoi du premier message.
- AI Outreach — la même mécanique dans le bureau.