概览

API中的活动和联系人

活动由三个部分组成:联系人、第一条消息的选项池和关联账户。以下是版本v2的操作;客户标识符通过令牌插入。

活动#

GET/v2/campaigns

客户的活动列表。

授权
Authorizationstring

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

POST/v2/campaigns

创建活动。请求体为JSON。

授权
Authorizationstring

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

GET/v2/campaigns/{campaign_id}

活动卡片。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

POST/v2/campaigns/{campaign_id}/update

修改活动参数。请求体为JSON。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

删除/v2/campaigns/{campaign_id}

删除活动及其联系人和消息池。

授权
授权字符串

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

路径
campaign_id字符串必填

活动的UUID

活动账户#

POST/v2/campaigns/{campaign_id}/accounts

将账户绑定到活动:将进行外发。请求体为 JSON。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的 UUID

DELETE/v2/campaigns/{campaign_id}/accounts

将账户从活动中解绑。请求体为 JSON。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的 UUID

联系方式#

通过文件加载和导出活动的联系人。参数 format 仅接受 csvxlsx,默认值为 csv

POST/v2/campaigns/{campaign_id}/contacts/upload

通过文件上传联系人数据库。请求体为 multipart/form-data,包含字段 file

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

请求体
formatstring

csvxlsx,默认值为 csv

GET/v2/campaigns/{campaign_id}/contacts

活动的联系人列表。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

GET/v2/campaigns/{campaign_id}/contacts/stats

活动联系人统计摘要。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

GET/v2/campaigns/{campaign_id}/contacts/export

导出活动的联系人文件。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

查询
formatstring

csvxlsx,默认 csv

DELETE/v2/campaigns/{campaign_id}/contacts

清空活动的联系人数据库。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的UUID

消息池#

池存储初始消息的变体。NN Agent 从中获取文本以进行下一个联系,因此相同的文本不会连续发送给整个数据库。

GET/v2/campaigns/{campaign_id}/message-pool

活动的第一个消息变体列表。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的 UUID

POST/v2/campaigns/{campaign_id}/message-pool

将消息变体添加到池中。请求体为 JSON。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的 UUID

DELETE/v2/campaigns/{campaign_id}/message-pool/{message_id}

从池中删除一个变体。

授权
Authorizationstring

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

路径
campaign_idstring必填

活动的 UUID

message_idstring必填

消息变体的 UUID

继续#

Updated

API中的活动和联系人 — NN Agent