Handbuch v1: vollständige Liste der Operationen
Version v1 stammt von der vorherigen Generation der API NN Agent. Sie funktioniert, aber für eine neue Integration verwenden Sie Version v2: dort wird die Kunden-ID über das Token eingefügt, und die Aktion wird durch die HTTP-Methode ausgedrückt, nicht durch den Pfad.
Im Folgenden sind alle 43 Operationen v1 außerhalb des Parsers aufgeführt. Der Parser ist separat auf der Seite Parser aufgeführt.
Die Spalte „Körper“ zeigt, was die Operation im Anfragekörper erwartet: JSON, файл für den Upload multipart/form-data oder einen Strich, wenn kein Körper erforderlich ist. Die Zusammensetzung der JSON-Felder wird in der veröffentlichten Spezifikation nicht beschrieben.
Kunde und Lizenzen#
| Methode | Pfad | Zweck | Pfad- und Anfrageparameter | Körper |
|---|---|---|---|---|
POST |
/v1/client_create |
Kunde erstellen | — | JSON |
GET |
/v1/client_id/{tg_id} |
Kundenidentifikator nach Telegram ID | tg_id |
— |
POST |
/v1/client_id/resolve |
Kundenidentifikator bestimmen | — | JSON |
GET |
/v1/client_info/{client_id} |
Kundendaten | client_id |
— |
POST |
/v1/change_password |
Passwort ändern | — | JSON |
GET |
/v1/licenses/{client_id} |
Kundenlizenzen | client_id |
— |
POST |
/v1/activate_code |
Code aktivieren | — | JSON |
POST |
/v1/bot/client_token/reissue |
Kunden-Token neu ausstellen (interne Bot-Operation) | — | JSON |
Kampagnen#
| Methode | Pfad | Zweck | Pfad- und Anfrageparameter | Körper |
|---|---|---|---|---|
POST |
/v1/create_campaign |
Kampagne erstellen | — | JSON |
GET |
/v1/campaign_list/{client_id} |
Liste der Kampagnen des Kunden | client_id |
— |
GET |
/v1/campaign_info/{client_id}/{campaign_id} |
Kampagnenkarte | client_id, campaign_id |
— |
DELETE |
/v1/campaign |
Kampagne löschen | — | JSON |
POST |
/v1/update_campaign |
Kampagne aktualisieren | — | JSON |
POST |
/v1/campaigns/{campaign_id}/message_pool |
Variante zum Nachrichtenpool der Kampagne hinzufügen | campaign_id, client_id |
JSON |
GET |
/v1/campaigns/{campaign_id}/message_pool |
Nachrichtenpool der Kampagne | campaign_id |
— |
DELETE |
/v1/campaigns/{campaign_id}/message_pool/{message_id} |
Variante aus dem Kampagnenpool löschen | campaign_id, message_id |
— |
Kontakte#
| Methode | Pfad | Zweck | Pfad- und Anfrageparameter | Körper |
|---|---|---|---|---|
POST |
/v1/contacts/upload/csv |
Kontakte aus CSV hochladen | client_id, campaign_id |
Datei |
POST |
/v1/contacts/upload/excel |
Kontakte aus Excel hochladen | client_id, campaign_id |
Datei |
DELETE |
/v1/contacts/clear |
Kontakte löschen | client_id, campaign_id |
— |
GET |
/v1/contacts |
Liste der Kontakte | — | — |
GET |
/v1/contacts/short-stats |
Zusammenfassung der Kontakte | — | — |
GET |
/v1/contacts/export |
Kontakte in CSV exportieren | — | — |
GET |
/v1/contacts/export/excel |
Kontakte in Excel exportieren | — | — |
Client Message Pool#
| Method | Path | Purpose | Path and Query Parameters | Body |
|---|---|---|---|---|
POST |
/v1/message-pool/upload |
Load client message pool | client_id, campaign_id |
JSON |
GET |
/v1/message-pool |
Client message pool | client_id, campaign_id |
— |
DELETE |
/v1/message-pool/clear |
Clear client message pool | client_id, campaign_id |
— |
Konten und Autorisierungssitzungen#
| Methode | Pfad | Zweck | Pfad- und Anfrageparameter | Körper |
|---|---|---|---|---|
POST |
/v1/accounts/auth-sessions |
Autorization Sitzung öffnen | — | JSON |
POST |
/v1/accounts/auth-sessions/qr |
Autorization Sitzung über QR öffnen | — | JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/code |
Bestätigungscode übermitteln | auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/password |
Cloud-Passwort übermitteln | auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/resend-code |
Code erneut senden | auth_id |
— |
GET |
/v1/accounts/auth-sessions/{auth_id} |
Status der Autorization Sitzung | auth_id |
— |
DELETE |
/v1/accounts/auth-sessions/{auth_id} |
Autorization Sitzung abbrechen | auth_id |
— |
POST |
/v1/update_account |
Konto aktualisieren | — | JSON |
GET |
/v1/clients/{client_id}/accounts |
Client-Konten | client_id |
— |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/attach |
Konten mit Kampagne verknüpfen | client_id, campaign_id |
JSON |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/detach |
Konten von Kampagne trennen | client_id, campaign_id |
JSON |
DELETE |
/v1/clients/{client_id}/accounts/{account_id} |
Konto deaktivieren | client_id, account_id |
— |
GET |
/v1/accounts/{account_id} |
Konto-Karte | account_id |
— |
Dialoge#
| Methode | Pfad | Zweck | Pfad- und Anfrageparameter | Körper |
|---|---|---|---|---|
GET |
/v1/accounts/{account_id}/dialogs |
Liste der Dialoge | account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/unread |
Ungelesene Dialoge | account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/{peer_user_id} |
Nachrichten des Dialogs | account_id, peer_user_id |
— |
POST |
/v1/accounts/{account_id}/dialogs/send |
Nachricht im Dialog senden | account_id |
JSON |
Weiter#
- API-Übersicht — Tabelle der Übereinstimmung
v1undv2. - Parser — Sammeloperationen, die nur in
v1verfügbar sind. - Fehler — Antwortcodes und
request_id.