Comptes dans l'API et sessions d'autorisation
Un compte est un compte de messagerie connecté, au nom duquel l'Agent NN écrit et lit. La connexion se fait via une session d'autorisation : vous ouvrez une session, le messager envoie un code, vous transmettez le code à la session.
Toutes les requêtes nécessitent un jeton bearer, voir Autorisation.
Sessions d'autorisation#
/v2/accounts/auth-sessionsOuvrir une session d'autorisation par numéro de téléphone. Renvoie l'identifiant de la session, auquel le code et le mot de passe sont ensuite liés. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/accounts/auth-sessions/qrOuvrir une session d'autorisation par QR code — alternative au code du message. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/accounts/auth-sessions/{auth_id}État de la session : attend le code, attend le mot de passe, terminée, rejetée. Interrogez cette opération entre les étapes de connexion.
Envoyé en tant qu'en-tête Authorization. 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 session d'autorisation
/v2/accounts/auth-sessions/{auth_id}/codeTransmettre le code de confirmation que le messager a envoyé au numéro. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête Authorization. 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 session d'autorisation
/v2/accounts/auth-sessions/{auth_id}/passwordTransmettre le mot de passe cloud si la protection par deux facteurs est activée pour le compte. 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 session d'autorisation
/v2/accounts/auth-sessions/{auth_id}/resend-codeDemander l'envoi à nouveau du code de confirmation.
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 session d'autorisation
/v2/accounts/auth-sessions/{auth_id}Interrompre une session d'autorisation inachevée.
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 session d'autorisation
Analyse étape par étape de cette séquence — Connecter un compte via l'API.
Comptes#
/v2/accountsListe des comptes connectés du client. Le client est identifié par le token.
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.
/v2/accounts/{account_id}Fiche d'un compte.
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 du compte
/v2/accounts/{account_id}/updateModifier les paramètres du compte. 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 du compte
/v2/accounts/{account_id}Déconnecter le compte de NN Agent.
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 du compte
Liaison des comptes à la campagne#
Les comptes eux-mêmes n'envoient rien — ils sont liés à la campagne. Les opérations de liaison et de déliaison sont décrites sur la page Campagnes et contacts.
Suite#
- Connecter un compte via l'API — ordre des appels dans son intégralité.
- Dialogues — quoi lire et envoyer après la connexion.
- Multi-comptabilité — la même mécanique dans le bureau.