如何通过API启动第一个活动
活动在NN Agent中由三个部分组成:联系人、第一条消息的选项池和绑定的账户。以下是版本v2的调用顺序。
在开始之前,请至少连接一个账户 — 请参见 通过API连接账户。
1
创建活动
curl -X POST https://api.nexifyneo.com/v2/campaigns \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'响应中将返回UUID格式的活动标识符。之后它将被用于所有其他请求的路径。
2
上传联系人数据库
联系人通过文件上传,而不是逐行上传。支持CSV和XLSX;格式通过请求参数format指定,默认值为csv。
curl -X POST "https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/contacts/upload?format=csv" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-F "file=@contacts.csv"可以通过摘要检查数据库是否已成功上传:GET /v2/campaigns/{campaign_id}/contacts/stats。
3
填充第一条消息的选项池
curl -X POST https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/message-pool \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'添加多个选项,而不是一个。NN Agent从池中获取下一个联系人的文本,这是避免向整个数据库发送完全相同文本的唯一方法。
4
绑定账户
curl -X POST https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/accounts \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'将从绑定的账户发送出站消息。解绑使用相同的地址和方法DELETE。
5
检查活动组成
curl https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID \
-H "Authorization: Bearer YOUR_API_TOKEN"确认活动是否有联系人、消息池和至少一个账户。没有池或账户的活动无法发送。
如何启动发送#
单独的“启动活动”操作在发布的规范中没有声明。启动通过更新活动(POST /v2/campaigns/{campaign_id}/update)或从仪表板执行;启动具体更改哪些字段,请在机器人 @NN_official_bot 中向经理确认。
接下来对话会发生什么#
在第一次接触后,AI会根据您的剧本进行对话 — 请参见 聊天流程。您可以通过 对话操作 手动阅读和继续对话。
将结果数据库导出回去: GET /v2/campaigns/{campaign_id}/contacts/export?format=xlsx.
继续#
- API中的活动和联系人 — 完整的操作列表。
- 对话 — 阅读聊天记录和发送消息。
- AI外展 — 在仪表板中的表现。