Aperçu

Comment connecter un compte de messagerie via l'API

La connexion d'un compte à NN Agent via l'API se fait par le biais d'une session d'autorisation : vous ouvrez une session, le messager envoie un code au numéro, vous renvoyez le code à la session. Avec la protection à deux facteurs activée, une étape supplémentaire est ajoutée : le mot de passe cloud.

Avant de commencer, obtenez un jeton bearer, voir Autorisation.

1
Ouvrez une session d'autorisation
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

La réponse renverra un identifiant de session au format UUID. Toutes les étapes suivantes s'adressent à celui-ci, et non à l'identifiant du compte : le compte n'existe pas encore.

Une alternative pour se connecter par QR code au lieu du code du message — POST /v2/accounts/auth-sessions/qr.

2
Attendez que le messager envoie le code

Interrogez l'état de la session jusqu'à ce qu'elle passe en attente du code :

curl https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Si le code n'est pas arrivé, demandez un nouvel envoi : POST /v2/accounts/auth-sessions/{auth_id}/resend-code.

3
Transmettez le code de confirmation
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID/code \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

Après cela, vérifiez à nouveau l'état de la session : elle se terminera soit avec succès, soit demandera le mot de passe cloud.

4
Transmettez le mot de passe cloud, si la protection à deux facteurs est activée
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID/password \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

Cette étape est nécessaire uniquement pour les comptes avec protection à deux facteurs. Sans cela, la session se termine immédiatement après le code.

5
Assurez-vous que le compte est apparu
curl https://api.nexifyneo.com/v2/accounts \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Le nouveau compte est présent dans la liste avec son UUID. Cet UUID est ensuite utilisé pour les dialogues et pour lier à la campagne.

Si quelque chose ne va pas#

  • Une session inachevée peut être interrompue : DELETE /v2/accounts/auth-sessions/{auth_id}.
  • La réponse 401 signifie un problème avec le jeton, et non avec le compte — voir Authentification.
  • Une rupture lors de la vérification du certificat TLS n'est liée ni au jeton ni à la session : api.nexifyneo.com renvoie un certificat auto-signé, voir Limitations connues.

Quels comptes connecter#

Pour les sortants, connectez des comptes séparés, et non personnels. La décision de blocage est prise par la plateforme, et en cas de perte d'un compte, la correspondance et les contacts restent dans NN Agent — vous continuerez avec un autre. Analyse dans les questions fréquentes.

Suite#

Updated

Comment connecter un compte de messagerie via l'API — NN Agent