NN Agent API 概述
NN Agent API 为您的产品提供了与经理的办公室相同的功能：连接消息应用账户、活动、联系人和对话。管理仍然保留在您的界面中。
基本地址： https://api.nexifyneo.com
通过API可以访问的内容#
| 组 | 功能 | 页面 |
|---|---|---|
| 客户端和许可证 | 账户数据、激活和续订许可证 | 在本页下方 |
| 账户和授权会话 | 连接和断开消息应用账户 | 账户 |
| 活动、联系人、消息池 | 构建外发活动 | 活动和联系人 |
| 对话 | 读取聊天记录和发送消息 | 对话 |
| 解析器 | 收集参与者和验证实体 | 解析器 |
总共发布的规范声明了96个操作：版本v2中有35个，版本v1中有60个，以及服务状态检查。
版本 v1 和 v2#
v2 — 当前版本。它是基于资源模型构建的：路径中的实体，HTTP 方法中的操作。 v1 继承自前一代，其中操作被放置在路径中。
| 任务 | v1 | v2 |
|---|---|---|
| 活动列表 | GET /v1/campaign_list/{client_id} |
GET /v2/campaigns |
| 创建活动 | POST /v1/create_campaign |
POST /v2/campaigns |
| 更新活动 | POST /v1/update_campaign |
POST /v2/campaigns/{campaign_id}/update |
| 删除活动 | DELETE /v1/campaign |
DELETE /v2/campaigns/{campaign_id} |
| 发送消息 | POST /v1/accounts/{account_id}/dialogs/send |
POST /v2/accounts/{account_id}/dialogs/{peer_user_id}/messages |
| 上传联系人 | POST /v1/contacts/upload/csv 和 /excel |
POST /v2/campaigns/{campaign_id}/contacts/upload?format=csv|xlsx |
实践中的主要区别在于：在 v2 中，客户标识符不在路径中传递 — 它由令牌确定。在 v1 中，许多操作需要 client_id 作为显式参数。
从 v2 开始。 如果您已经有一个有效的集成或需要解析器，请联系 v1：它仅在 v1 中发布。完整列表 — 参考 v1。
检查可用性#
/health检查服务状态。无需授权。
作为 Authorization 头发送。您的密钥仅由您的浏览器用于此请求——它从未发送到 Docsbook 或存储。
{ "status": "ok" }客户端和许可证#
/v2/client与令牌关联的帐户数据。
作为授权头发送。您的密钥仅由您的浏览器用于此请求——它从未发送到Docsbook或存储。
/v2/client/licenses客户许可证列表：活动插槽和期限。
作为授权头发送。您的密钥仅由您的浏览器用于此请求——它从未发送到Docsbook或存储。
/v2/client/licenses/activate通过代码激活许可证。请求体为JSON。
作为授权头发送。您的密钥仅由您的浏览器用于此请求——它从未发送到Docsbook或存储。
/v2/client/licenses/renew续订现有许可证。请求体为JSON。
作为授权头发送。您的密钥仅由您的浏览器用于此请求——它从未发送到Docsbook或存储。
/v2/client/telegram-profiles将Telegram个人资料绑定到帐户。请求体为JSON。
作为授权头发送。您的密钥仅由您的浏览器用于此请求——它从未发送到Docsbook或存储。
/v2/client/telegram-profiles/{tg_id}解除绑定 Telegram 个人资料。
作为授权头发送。您的密钥仅由您的浏览器用于此请求——从未发送到 Docsbook 或存储。
Telegram 个人资料的标识符
已知限制#
主机的TLS证书 api.nexifyneo.com 是自签名的。 浏览器和大多数HTTP客户端默认拒绝连接，并显示证书验证错误。在证书被公共证书颁发机构签发的证书替换之前，来自页面的交互请求和严格客户端的请求将无法通过。请向 @NN_official_bot 机器人的经理确认当前状态。
请求体在规范中未被类型化。 发布的OpenAPI文档将POST请求的主体描述为自由的JSON对象，没有字段列表。文档页面上列出了规范确实声明的内容：方法、路径、路径参数和请求参数。请求体的确切组成请向机器人的经理确认。
继续#
- 认证 — 如何传递令牌。
- 错误 — 拒绝时的响应格式以及如何引用特定请求。
- 通过API启动第一个活动 — 全流程场景。