Guía v1: lista completa de operaciones
La versión v1 proviene de la generación anterior de la API NN Agent. Funciona, pero para una nueva integración, utilice la versión v2: allí el identificador del cliente se proporciona a través del token, y la acción se expresa mediante el método HTTP, no por la ruta.
A continuación se enumeran las 43 operaciones v1 fuera del parser. El parser se descompone por separado en la página Parser.
La columna "Cuerpo" muestra lo que la operación espera en el cuerpo de la solicitud: JSON, файл para cargar multipart/form-data o un guion si no se requiere cuerpo. La composición de los campos JSON no está descrita en la especificación publicada.
Cliente y licencias#
| Método | Ruta | Propósito | Parámetros de ruta y solicitud | Cuerpo |
|---|---|---|---|---|
POST |
/v1/client_create |
Crear cliente | — | JSON |
GET |
/v1/client_id/{tg_id} |
Identificador de cliente por ID de Telegram | tg_id |
— |
POST |
/v1/client_id/resolve |
Determinar el identificador del cliente | — | JSON |
GET |
/v1/client_info/{client_id} |
Datos del cliente | client_id |
— |
POST |
/v1/change_password |
Cambiar contraseña | — | JSON |
GET |
/v1/licenses/{client_id} |
Licencias del cliente | client_id |
— |
POST |
/v1/activate_code |
Activar código | — | JSON |
POST |
/v1/bot/client_token/reissue |
Reemitir token del cliente (operación interna del bot) | — | JSON |
Campañas#
| Método | Ruta | Destino | Parámetros de ruta y consulta | Cuerpo |
|---|---|---|---|---|
POST |
/v1/create_campaign |
Crear campaña | — | JSON |
GET |
/v1/campaign_list/{client_id} |
Lista de campañas del cliente | client_id |
— |
GET |
/v1/campaign_info/{client_id}/{campaign_id} |
Ficha de campaña | client_id, campaign_id |
— |
DELETE |
/v1/campaign |
Eliminar campaña | — | JSON |
POST |
/v1/update_campaign |
Actualizar campaña | — | JSON |
POST |
/v1/campaigns/{campaign_id}/message_pool |
Agregar variante al grupo de mensajes de la campaña | campaign_id, client_id |
JSON |
GET |
/v1/campaigns/{campaign_id}/message_pool |
Grupo de mensajes de la campaña | campaign_id |
— |
DELETE |
/v1/campaigns/{campaign_id}/message_pool/{message_id} |
Eliminar variante del grupo de la campaña | campaign_id, message_id |
— |
Contactos#
| Método | Ruta | Propósito | Parámetros de ruta y consulta | Cuerpo |
|---|---|---|---|---|
POST |
/v1/contacts/upload/csv |
Cargar contactos desde CSV | client_id, campaign_id |
archivo |
POST |
/v1/contacts/upload/excel |
Cargar contactos desde Excel | client_id, campaign_id |
archivo |
DELETE |
/v1/contacts/clear |
Limpiar contactos | client_id, campaign_id |
— |
GET |
/v1/contacts |
Lista de contactos | — | — |
GET |
/v1/contacts/short-stats |
Resumen de contactos | — | — |
GET |
/v1/contacts/export |
Exportar contactos a CSV | — | — |
GET |
/v1/contacts/export/excel |
Exportar contactos a Excel | — | — |
Pool de mensajes del cliente#
| Método | Ruta | Destino | Parámetros de ruta y solicitud | Cuerpo |
|---|---|---|---|---|
POST |
/v1/message-pool/upload |
Cargar pool de mensajes del cliente | client_id, campaign_id |
JSON |
GET |
/v1/message-pool |
Pool de mensajes del cliente | client_id, campaign_id |
— |
DELETE |
/v1/message-pool/clear |
Limpiar pool de mensajes del cliente | client_id, campaign_id |
— |
Cuentas y sesiones de autorización#
| Método | Ruta | Propósito | Parámetros de ruta y solicitud | Cuerpo |
|---|---|---|---|---|
POST |
/v1/accounts/auth-sessions |
Abrir sesión de autorización | — | JSON |
POST |
/v1/accounts/auth-sessions/qr |
Abrir sesión de autorización por QR | — | JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/code |
Enviar código de confirmación | auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/password |
Enviar contraseña en la nube | auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/resend-code |
Reenviar código | auth_id |
— |
GET |
/v1/accounts/auth-sessions/{auth_id} |
Estado de la sesión de autorización | auth_id |
— |
DELETE |
/v1/accounts/auth-sessions/{auth_id} |
Interrumpir sesión de autorización | auth_id |
— |
POST |
/v1/update_account |
Actualizar cuenta | — | JSON |
GET |
/v1/clients/{client_id}/accounts |
Cuentas del cliente | client_id |
— |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/attach |
Vincular cuentas a la campaña | client_id, campaign_id |
JSON |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/detach |
Desvincular cuentas de la campaña | client_id, campaign_id |
JSON |
DELETE |
/v1/clients/{client_id}/accounts/{account_id} |
Desactivar cuenta | client_id, account_id |
— |
GET |
/v1/accounts/{account_id} |
Ficha de cuenta | account_id |
— |
Diálogos#
| Método | Ruta | Propósito | Parámetros de ruta y consulta | Cuerpo |
|---|---|---|---|---|
GET |
/v1/accounts/{account_id}/dialogs |
Lista de diálogos | account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/unread |
Diálogos no leídos | account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/{peer_user_id} |
Mensajes del diálogo | account_id, peer_user_id |
— |
POST |
/v1/accounts/{account_id}/dialogs/send |
Enviar mensaje en el diálogo | account_id |
JSON |
Siguiente#
- Resumen de la API — tabla de correspondencia
v1yv2. - Analizador — operaciones de recopilación, disponibles solo en
v1. - Errores — códigos de respuesta y
request_id.