概览

API中的账户和授权会话

账户是连接的消息应用账户,NN Agent以该账户的名义进行写入和读取。连接通过授权会话进行:您打开会话,消息应用发送代码,您将代码传递到会话中。

所有请求都需要bearer令牌,见授权

授权会话#

POST/v2/accounts/auth-sessions

通过电话号码打开授权会话。返回会话标识符,后续将绑定代码和密码。请求体为 JSON。

授权
Authorizationstring

作为 Authorization 头发送。您的密钥仅由您的浏览器用于此请求 — 它不会发送到 Docsbook 或存储。

POST/v2/accounts/auth-sessions/qr

通过二维码打开授权会话 — 替代消息中的代码。请求体为 JSON。

授权
Authorizationstring

作为 Authorization 头发送。您的密钥仅由您的浏览器用于此请求 — 它不会发送到 Docsbook 或存储。

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

会话状态:等待代码,等待密码,已完成,已拒绝。在连接步骤之间轮询此操作。

授权
Authorizationstring

作为 Authorization 头发送。您的密钥仅由您的浏览器用于此请求 — 它不会发送到 Docsbook 或存储。

路径
auth_idstring必填

授权会话的 UUID

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

传递确认代码,消息应用程序已发送到该号码。请求体为 JSON。

授权
Authorizationstring

作为 Authorization 头发送。您的密钥仅由您的浏览器用于此请求 — 它不会发送到 Docsbook 或存储。

路径
auth_idstring必填

授权会话的 UUID

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

如果账户启用了双因素认证,请传递云密码。请求体为 JSON。

授权
授权字符串

作为授权头发送。您的密钥仅由您的浏览器用于此请求——从未发送到 Docsbook 或存储。

路径
auth_id字符串必填

授权会话的 UUID

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

请求重新发送确认代码。

授权
授权字符串

作为授权头发送。您的密钥仅由您的浏览器用于此请求——从未发送到 Docsbook 或存储。

路径
auth_id字符串必填

授权会话的 UUID

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

终止未完成的授权会话。

授权
授权字符串

作为授权头发送。您的密钥仅由您的浏览器用于此请求——从未发送到 Docsbook 或存储。

路径
auth_id字符串必填

授权会话的 UUID

此序列的逐步解析 - 通过 API 连接账户

账户#

GET/v2/accounts

客户已连接账户的列表。客户通过令牌确定。

授权
Authorizationstring

作为授权头发送。您的密钥仅由您的浏览器用于此请求——它不会发送到Docsbook或存储。

GET/v2/accounts/{account_id}

单个账户的卡片。

授权
Authorizationstring

作为授权头发送。您的密钥仅由您的浏览器用于此请求——它不会发送到Docsbook或存储。

路径
account_idstring必填

账户的UUID

POST/v2/accounts/{account_id}/update

修改账户参数。请求体为JSON。

授权
Authorizationstring

作为授权头发送。您的密钥仅由您的浏览器用于此请求——它不会发送到Docsbook或存储。

路径
account_idstring必填

账户的UUID

DELETE/v2/accounts/{account_id}

从NN Agent中断开账户。

授权
Authorizationstring

作为授权头发送。您的密钥仅由您的浏览器用于此请求——它不会发送到Docsbook或存储。

路径
account_idstring必填

账户的UUID

将账户绑定到活动#

账户本身不发送任何内容——它们被绑定到活动。绑定和解绑操作在页面 活动和联系人 中描述。

继续#

Updated

API中的账户和授权会话 — NN Agent