借助 Papo 的 REST API,你无需打开面板即可自动化团队管理:列出团队、创建团队、列出某个团队的成员、将用户添加到团队,以及列出或创建收件箱。这是以编程方式让服务结构与外部系统、大型运营和 white label 转售保持同步的方法。
Papo API 以与平台其他端点相同的身份验证方式提供团队和收件箱资源。借助这些资源,你的团队可以配置新结构、审计每个群组的成员,并在无需手动操作面板的情况下准备对话路由。
通过 API 进行团队和成员操作的概览
| 操作 | 作用 | 使用场景 |
|---|---|---|
| 列出团队 | 返回账户中已注册的团队。 | 在创建新团队前审计结构。 |
| 创建团队 | 创建一个包含名称和可选描述的团队。 | 通过脚本、ERP 或 CRM 配置新团队。 |
| 列出团队成员 | 返回属于该团队的用户。 | 检查已包含哪些人,避免错误访问。 |
| 将用户添加到团队 | 通过逗号分隔的 ID 添加一个或多个用户。 | 让团队与当前坐席名单保持同步。 |
| 列出收件箱 | 以管理员视图返回带渠道的收件箱。 | 检查可用渠道及其组织方式。 |
| 创建收件箱 | 创建新的收件箱。 | 在配置团队结构的同时配置新渠道。 |
API 身份验证如何工作
写入操作(包括团队和成员相关操作)需要账户密钥。它必须作为 Bearer token 在授权标头中发送。账户公钥是可选的,但如果发送,则必须与密钥属于同一账户。
API 基础 URL 是 https://app.papo.global/api/v1。密钥在 Papo 面板的开发者区域生成。密钥在创建时只显示一次;请将其保存在安全位置,如有泄露嫌疑请撤销。
通过 API 管理团队和成员的分步指南
- 进入 Papo 面板中的开发者/API 区域并生成密钥。如需额外验证,也请复制账户公钥。
- 在每个请求中,使用密钥作为 Bearer token 进行身份验证。如果要加强验证,请在文档指定的标头中发送公钥。
- 列出已有团队,以便在创建新团队前映射当前结构。
- 通过发送包含名称以及可选描述的 JSON payload 来创建团队。确切格式请查阅官方文档。
- 列出团队成员,以审计已包含哪些人并避免重复。
- 通过逗号分隔的 ID 将用户添加到团队。此步骤会让团队与当前坐席名单保持同步。
- 以管理员视图列出收件箱,检查现有渠道,并在需要时也使用 API 创建收件箱。
由于 API 是 REST 并使用 JSON,任何支持 HTTP 的语言都可用于将团队和成员集成到脚本、ERP、CRM 或自动化工具中。官方文档 https://papo.global/pt/docs 提供了身份验证、参数、响应和代码示例的详细信息。
这种集成适合谁
- 大型运营:需要频繁创建和调整团队,而不想手动打开面板。
- IT 和自动化团队:将坐席结构与目录、HR 或内部系统同步。
- white label 转售商:以标准化方式为客户配置账户,复用相同的团队和收件箱逻辑。
- 已使用 Papo API 处理联系人和对话,并希望通过团队管理完善流程的公司。
API 管理团队结构和成员添加。用户角色(如坐席或管理员)以及细粒度权限仍在面板中定义。将用户添加到团队并将其连接到相关收件箱后,你就可以控制对对话的操作访问权限。
常见问题
Papo API 会定义用户角色(如坐席或管理员)吗?
不会。团队和成员 API 专注于创建团队、列出成员和添加用户。每个用户的角色和权限定义在面板中完成。将用户加入团队和正确的收件箱后,你可以限制其对操作对话的访问。
我可以在同一步骤中创建团队而不添加成员吗?
可以。API 允许创建一个包含名称和可选描述的团队,而无需立即添加用户。之后,你可以使用批量添加操作添加成员。
API 如何在请求中识别账户?
通过作为 Bearer token 发送的密钥。公钥是可选的,如果发送,则必须与密钥属于同一账户。
此 API 适用于 white label 转售吗?
适用。转售商可以使用 API 以标准化方式在客户账户中配置团队和成员,减少手动配置并保持各运营之间的一致性。
在哪里可以找到确切的路径和 payload 格式?
在官方 API 文档中,地址为 https://papo.global/pt/docs。那里有团队、成员及其他资源的身份验证、参数、响应和代码示例等详细信息。
另请阅读
第一个用户永久免费,因此你可以在构建运营之前验证集成。