要通过 API 在 Papo 中管理跟进序列,你可以列出可用的节奏、将联系人加入序列,并通过更新自定义属性来暂停某个线索的参与——全部通过已认证的请求完成,无需打开面板。这是将线索培育与 CRM、ERP 和外部自动化流程集成的方式。
API 操作概览
| 操作 | 说明 | API 如何实现 |
|---|---|---|
| 列出序列 | 获取账户中所有跟进节奏,包括名称、标识符和状态(启用/停用)。 | 在 flows 端点发起已认证的 GET 请求,并按类型 "sequence" 过滤。 |
| 将联系人加入序列 | 将现有联系人加入启用的序列,开始消息旅程。 | 在加入端点使用联系人 ID 和序列 ID 发起 POST 请求。 |
| 暂停某个联系人的节奏 | 暂时停止向某个线索发送消息,但不将其从序列中移除。 | 通过联系人 API 更新联系人的自定义属性(例如:status_pausa),并结合 Flow 中的条件。 |
认证和端点如何工作
所有操作都使用 Papo REST API,并通过账户的密钥(Bearer token)进行认证。基础 URL 是 https://app.papo.global/api/v1。密钥在面板的开发者区域生成。
序列相关资源集中在 flows 端点中。API 允许列出所有 flows,包括类型为 "sequence" 的 flows,也可以启用/停用整个 flow。要将联系人加入序列,有一个特定端点接收联系人标识符和 flow 标识符。
每个端点的确切细节(参数、payload 和示例)可在 Papo API 官方文档中查看。这里我们聚焦于管理跟进序列的工作流程。
分步指南:列出、加入和暂停
1. 列出可用序列
在将线索加入序列之前,你需要知道有哪些序列及其标识符。列表调用会返回包含名称、ID 和状态(启用/停用)的列表。只有启用的序列才接受新的加入。
拿到列表后,你的外部系统就可以为每个线索映射要使用的序列。
2. 将联系人加入序列
有了联系人 ID(通过联系人 API 搜索或创建获得)和启用序列的 ID 后,你发送请求将其插入旅程开头。联系人必须存在于 Papo CRM 中;否则,请先使用联系人端点创建它。
加入后会立即开始发送已编排的消息,并遵守 Flow 中配置的间隔。联系人的历史记录会被保留。
3. 暂停特定联系人的节奏
Papo API 没有直接“暂停”联系人在序列中参与的命令。不过,你可以通过将联系人 API 与 Flow 中的条件结合来达到同样效果。
前提条件: 序列必须已使用一个条件节点构建,该节点会检查自定义属性(例如:status_pausa)。如果属性等于 "pausado",条件会阻止发送后续消息;否则放行。(有关 Flow 搭建细节,请参阅关于临时暂停的文章。)
有了 Flow 中的这个结构,暂停可通过 API 分两步完成:
- 识别联系人:通过 ID,或使用联系人列表端点按电话/电子邮件搜索。
- 更新联系人的自定义属性为 "pausado"(或你的条件所期望的值)。使用联系人更新端点,发送自定义字段。
从那时起,当流程到达条件时,它会识别值 "pausado" 并且不发送消息。要恢复,只需将属性更新为任何其他值(例如:"ativo")或清除它,联系人将从停止处继续。
这种方法会让联系人保持已加入状态和节奏进度,而不会丢失历史记录。
这种集成对谁有用
- SDR 和 B2B 销售运营:从外部事件触发序列(例如:某个线索下载了资料,CRM 中创建了商机)。
- 白标经销商:自动为新客户配置跟进旅程,无需手动操作即可加入初始联系人。
- 营销和自动化团队:使用 n8n 或 Zapier 等工具将 Papo 连接到数十个系统,并需要对节奏进行精细控制。
- 具有条件暂停流程的公司:某个线索要求暂缓,销售人员希望中断序列但不丢失节奏进度——全部由外部 CRM 中的按钮触发。
常见问题
列出序列需要密钥吗?
需要。所有返回账户数据的操作都需要使用密钥进行认证,并在 Authorization 请求头中作为 Bearer token 发送。
我可以加入一个在 Papo 中尚不存在的联系人吗?
不可以。联系人必须存在于 Papo CRM 中。你可以先通过联系人 API 创建它(包含姓名、电话或电子邮件),然后再将其加入序列。
API 允许从序列中移除联系人吗?
在当前版本中,移除(取消加入)没有作为特定端点提供。要中断发送,替代方案是按所述通过自定义属性暂停,或停用整个 flow,但这会影响所有联系人。
如何知道通过属性暂停是否生效?
更新属性后,序列会继续处理等待节点。当到达条件时,它会检查该值。如果为 "pausado",则不会发送消息。你可以在“联系人”模块的联系人资料中确认,该联系人仍处于已加入状态,但后续消息不会触发。
我可以通过 API 暂停整个序列吗?
可以。API 允许将 flow 状态改为停用,从而为所有联系人暂停该序列。使用 flow 启用/停用端点。要恢复,只需重新启用它。
在哪里可以找到确切的端点和代码示例?
完整 API 文档位于 https://papo.global/pt/docs。在那里你可以找到 flows、联系人端点以及请求格式。
另请参阅
使用 Papo API,你可以将线索培育直接集成到你的技术栈中,无需打开面板——首个用户免费,供你测试。