参考手册 v1: 完整操作列表
版本 v1 仍然来自于前一代 API NN Agent。它可以工作，但对于新的集成，请使用 版本 v2: 在那里，客户标识符通过令牌插入，操作通过 HTTP 方法表示，而不是通过路径。
以下列出了所有 43 个操作 v1 在解析器之外。解析器单独在页面 解析器 上进行了说明。
列“主体”显示操作在请求主体中期望的内容: JSON, файл 用于上传 multipart/form-data 或者如果不需要主体则为破折号。JSON 字段的组成在发布的规范中没有描述。
客户端和许可证#
| 方法 | 路径 | 目的 | 路径和请求参数 | 主体 |
|---|---|---|---|---|
POST |
/v1/client_create |
创建客户端 | — | JSON |
GET |
/v1/client_id/{tg_id} |
通过 Telegram ID 获取客户端标识符 | tg_id |
— |
POST |
/v1/client_id/resolve |
确定客户端标识符 | — | JSON |
GET |
/v1/client_info/{client_id} |
客户端数据 | client_id |
— |
POST |
/v1/change_password |
更改密码 | — | JSON |
GET |
/v1/licenses/{client_id} |
客户端许可证 | client_id |
— |
POST |
/v1/activate_code |
激活代码 | — | JSON |
POST |
/v1/bot/client_token/reissue |
重新发行客户端令牌（机器人内部操作） | — | JSON |
活动#
| 方法 | 路径 | 目的 | 路径和请求参数 | 主体 |
|---|---|---|---|---|
POST |
/v1/create_campaign |
创建活动 | — | JSON |
GET |
/v1/campaign_list/{client_id} |
客户的活动列表 | client_id |
— |
GET |
/v1/campaign_info/{client_id}/{campaign_id} |
活动详情 | client_id, campaign_id |
— |
DELETE |
/v1/campaign |
删除活动 | — | JSON |
POST |
/v1/update_campaign |
更新活动 | — | JSON |
POST |
/v1/campaigns/{campaign_id}/message_pool |
向活动消息池添加选项 | campaign_id, client_id |
JSON |
GET |
/v1/campaigns/{campaign_id}/message_pool |
活动消息池 | campaign_id |
— |
DELETE |
/v1/campaigns/{campaign_id}/message_pool/{message_id} |
从活动池中删除选项 | campaign_id, message_id |
— |
联系人#
| 方法 | 路径 | 目的 | 路径和请求参数 | 主体 |
|---|---|---|---|---|
POST |
/v1/contacts/upload/csv |
从CSV中加载联系人 | client_id, campaign_id |
文件 |
POST |
/v1/contacts/upload/excel |
从Excel中加载联系人 | client_id, campaign_id |
文件 |
DELETE |
/v1/contacts/clear |
清除联系人 | client_id, campaign_id |
— |
GET |
/v1/contacts |
联系人列表 | — | — |
GET |
/v1/contacts/short-stats |
联系人摘要 | — | — |
GET |
/v1/contacts/export |
导出联系人为CSV | — | — |
GET |
/v1/contacts/export/excel |
导出联系人为Excel | — | — |
客户消息池#
| 方法 | 路径 | 目的 | 路径和请求参数 | 主体 |
|---|---|---|---|---|
POST |
/v1/message-pool/upload |
加载客户消息池 | client_id, campaign_id |
JSON |
GET |
/v1/message-pool |
客户消息池 | client_id, campaign_id |
— |
DELETE |
/v1/message-pool/clear |
清空客户消息池 | client_id, campaign_id |
— |
账户和授权会话#
| 方法 | 路径 | 目的 | 路径和请求参数 | 主体 |
|---|---|---|---|---|
POST |
/v1/accounts/auth-sessions |
打开授权会话 | — | JSON |
POST |
/v1/accounts/auth-sessions/qr |
通过二维码打开授权会话 | — | JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/code |
传递确认代码 | auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/password |
传递云密码 | auth_id |
JSON |
POST |
/v1/accounts/auth-sessions/{auth_id}/resend-code |
重新发送代码 | auth_id |
— |
GET |
/v1/accounts/auth-sessions/{auth_id} |
授权会话状态 | auth_id |
— |
DELETE |
/v1/accounts/auth-sessions/{auth_id} |
中断授权会话 | auth_id |
— |
POST |
/v1/update_account |
更新账户 | — | JSON |
GET |
/v1/clients/{client_id}/accounts |
客户账户 | client_id |
— |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/attach |
将账户绑定到活动 | client_id, campaign_id |
JSON |
POST |
/v1/clients/{client_id}/campaigns/{campaign_id}/accounts/detach |
将账户解绑活动 | client_id, campaign_id |
JSON |
DELETE |
/v1/clients/{client_id}/accounts/{account_id} |
禁用账户 | client_id, account_id |
— |
GET |
/v1/accounts/{account_id} |
账户卡片 | account_id |
— |
对话#
| 方法 | 路径 | 用途 | 路径和请求参数 | 主体 |
|---|---|---|---|---|
GET |
/v1/accounts/{account_id}/dialogs |
对话列表 | account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/unread |
未读对话 | account_id |
— |
GET |
/v1/accounts/{account_id}/dialogs/{peer_user_id} |
对话消息 | account_id, peer_user_id |
— |
POST |
/v1/accounts/{account_id}/dialogs/send |
在对话中发送消息 | account_id |
JSON |