Référentiel v1 : liste complète des opérations
La version v1 est restée de la génération précédente de l'API NN Agent. Elle fonctionne, mais pour une nouvelle intégration, prenez la version v2 : là, l'identifiant client est fourni par le token, et l'action est exprimée par la méthode HTTP, et non par le chemin.
Ci-dessous, toutes les 43 opérations v1 en dehors du parseur sont énumérées. Le parseur est traité séparément sur la page Parseur.
La colonne « Corps » montre ce que l'opération attend dans le corps de la requête : JSON, файл pour le téléchargement multipart/form-data ou un tiret si le corps n'est pas requis. La composition des champs JSON n'est pas décrite dans la spécification publiée.
Client et licences#
| Méthode |
Chemin |
Destination |
Paramètres de chemin et de requête |
Corps |
POST |
/v1/client_create |
Créer un client |
— |
JSON |
GET |
/v1/client_id/{tg_id} |
Identifiant du client par ID Telegram |
tg_id |
— |
POST |
/v1/client_id/resolve |
Déterminer l'identifiant du client |
— |
JSON |
GET |
/v1/client_info/{client_id} |
Données du client |
client_id |
— |
POST |
/v1/change_password |
Changer le mot de passe |
— |
JSON |
GET |
/v1/licenses/{client_id} |
Licences du client |
client_id |
— |
POST |
/v1/activate_code |
Activer le code |
— |
JSON |
POST |
/v1/bot/client_token/reissue |
Réémettre le jeton du client (opération interne du bot) |
— |
JSON |
Campagnes#
| Méthode |
Chemin |
Destination |
Paramètres de chemin et de requête |
Corps |
POST |
/v1/create_campaign |
Créer une campagne |
— |
JSON |
GET |
/v1/campaign_list/{client_id} |
Liste des campagnes du client |
client_id |
— |
GET |
/v1/campaign_info/{client_id}/{campaign_id} |
Fiche de campagne |
client_id, campaign_id |
— |
DELETE |
/v1/campaign |
Supprimer une campagne |
— |
JSON |
POST |
/v1/update_campaign |
Mettre à jour une campagne |
— |
JSON |
POST |
/v1/campaigns/{campaign_id}/message_pool |
Ajouter une variante au pool de messages de la campagne |
campaign_id, client_id |
JSON |
GET |
/v1/campaigns/{campaign_id}/message_pool |
Pool de messages de la campagne |
campaign_id |
— |
DELETE |
/v1/campaigns/{campaign_id}/message_pool/{message_id} |
Supprimer une variante du pool de la campagne |
campaign_id, message_id |
— |
Contacts#
| Méthode |
Chemin |
Destination |
Paramètres de chemin et de requête |
Corps |
POST |
/v1/contacts/upload/csv |
Télécharger des contacts à partir de CSV |
client_id, campaign_id |
fichier |
POST |
/v1/contacts/upload/excel |
Télécharger des contacts à partir d'Excel |
client_id, campaign_id |
fichier |
DELETE |
/v1/contacts/clear |
Effacer les contacts |
client_id, campaign_id |
— |
GET |
/v1/contacts |
Liste des contacts |
— |
— |
GET |
/v1/contacts/short-stats |
Résumé des contacts |
— |
— |
GET |
/v1/contacts/export |
Exporter des contacts en CSV |
— |
— |
GET |
/v1/contacts/export/excel |
Exporter des contacts en Excel |
— |
— |
Pool de messages du client#
| Méthode |
Chemin |
Destination |
Paramètres de chemin et de requête |
Corps |
POST |
/v1/message-pool/upload |
Télécharger le pool de messages du client |
client_id, campaign_id |
JSON |
GET |
/v1/message-pool |
Pool de messages du client |
client_id, campaign_id |
— |
DELETE |
/v1/message-pool/clear |
Vider le pool de messages du client |
client_id, campaign_id |
— |
Comptes et sessions d'autorisation#
| Méthode |
Chemin |
Objet |
Paramètres de chemin et de requête |
Corps |
POST |
/v1/accounts/auth-sessions |
Ouvrir une session d'autorisation |
— |
JSON |
POST |
/v1/accounts/auth-sessions/qr |
Ouvrir une session d'autorisation par QR |
— |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/code |
Transmettre le code de confirmation |
auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/password |
Transmettre le mot de passe cloud |
auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/resend-code |
Renvoyer le code |
auth_id |
— |
GET |
/v1/accounts/auth-sessions/{auth_id} |
État de la session d'autorisation |
auth_id |
— |
DELETE |
/v1/accounts/auth-sessions/{auth_id} |
Interrompre la session d'autorisation |
auth_id |
— |
POST |
/v1/update_account |
Mettre à jour le compte |
— |
JSON |
GET |
/v1/clients/{client_id}/accounts |
Comptes du client |
client_id |
— |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/attach |
Lier des comptes à la campagne |
client_id, campaign_id |
JSON |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/detach |
Délier des comptes de la campagne |
client_id, campaign_id |
JSON |
DELETE |
/v1/clients/{client_id}/accounts/{account_id} |
Désactiver le compte |
client_id, account_id |
— |
GET |
/v1/accounts/{account_id} |
Fiche de compte |
account_id |
— |
Dialogues#
| Méthode |
Chemin |
Destination |
Paramètres de chemin et de requête |
Corps |
GET |
/v1/accounts/{account_id}/dialogs |
Liste des dialogues |
account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/unread |
Dialogues non lus |
account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/{peer_user_id} |
Messages de dialogue |
account_id, peer_user_id |
— |
POST |
/v1/accounts/{account_id}/dialogs/send |
Envoyer un message dans le dialogue |
account_id |
JSON |
Suite#
- Aperçu de l'API — tableau de correspondance
v1 et v2.
- Analyseur — opérations de collecte, disponibles uniquement dans
v1.
- Erreurs — codes de réponse et
request_id.
