Resumen

Cuentas en la API y sesiones de autorización

Cuenta — cuenta conectada del mensajero, en nombre de la cual NN Agent escribe y lee. La conexión se realiza a través de una sesión de autorización: abres una sesión, el mensajero envía un código, tú pasas el código a la sesión.

Todas las solicitudes requieren un token bearer, ver Autorización.

Sesiones de autorización#

POST/v2/accounts/auth-sessions

Abre una sesión de autorización por número de teléfono. Devuelve el identificador de la sesión, al que luego se vinculan el código y la contraseña. El cuerpo de la solicitud es JSON.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

POST/v2/accounts/auth-sessions/qr

Abre una sesión de autorización mediante un código QR — alternativa al código del mensaje. El cuerpo de la solicitud es JSON.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

GET/v2/accounts/auth-sessions/{auth_id}

Estado de la sesión: espera código, espera contraseña, completada, rechazada. Consulta esta operación entre los pasos de conexión.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
auth_idstringrequerido

UUID de la sesión de autorización

POST/v2/accounts/auth-sessions/{auth_id}/code

Enviar el código de confirmación que el mensajero envió al número. El cuerpo de la solicitud es JSON.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
auth_idstringrequerido

UUID de la sesión de autorización

POST/v2/accounts/auth-sessions/{auth_id}/password

Enviar la contraseña en la nube si la cuenta tiene habilitada la autenticación de dos factores. El cuerpo de la solicitud es JSON.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
auth_idstringrequerido

UUID de la sesión de autorización

POST/v2/accounts/auth-sessions/{auth_id}/resend-code

Solicitar el reenvío del código de confirmación.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
auth_idstringrequerido

UUID de la sesión de autorización

DELETE/v2/accounts/auth-sessions/{auth_id}

Interrumpir una sesión de autorización no finalizada.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
auth_idstringrequerido

UUID de la sesión de autorización

Desglose paso a paso de esta secuencia — Conectar cuenta a través de la API.

Cuentas#

GET/v2/accounts

Lista de cuentas conectadas del cliente. El cliente se identifica por el token.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

GET/v2/accounts/{account_id}

Tarjeta de una cuenta.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
account_idstringrequerido

UUID de la cuenta

POST/v2/accounts/{account_id}/update

Modificar los parámetros de la cuenta. El cuerpo de la solicitud es JSON.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
account_idstringrequerido

UUID de la cuenta

ELIMINAR/v2/accounts/{account_id}

Desconectar la cuenta de NN Agent.

Autorización
Autorizaciónstring

Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.

Ruta
account_idstringrequerido

UUID de la cuenta

Vinculación de cuentas a la campaña#

Las cuentas por sí solas no envían nada: se vinculan a la campaña. Las operaciones de vinculación y desvinculación se describen en la página Campañas y contactos.

Siguiente#

Updated

¿Fue útil esta página?

Cuentas en la API y sesiones de autorización — NN Agent