摘要
如果您使用 Wati 的 多个 WhatsApp 号码 功能,本指南将介绍如何在不同已连接的号码之间使用 Wati 的 API。
说明
在您的 Wati 账户中使用多个 WhatsApp 号码,可以让您从不同的号码发送和接收消息。为了确保您的 API 调用通过正确的号码,您需要在有效载荷(payload)或 URL 中包含一个额外的键(key),具体取决于您正在使用的 API。
以下是当前支持多个号码的 API 及其使用方法。
1. 发送模板消息 API
端点:POST /{tenantId}/api/v1/sendTemplateMessage
必填字段:
租户ID
WhatsApp号码
channelNumber(在有效载荷中):要发送消息的电话号码。
例如,如果要从默认号码发送消息,请将 channelNumber
设置为该默认电话号码。
2. 更新聊天状态 API
端点:POST /{tenantId}/api/v1/updateChatStatus
必填字段:
租户ID
channelPhoneNumber(在有效载荷中):将其设置为您要更新其聊天状态的号码。
提交的“channelPhoneNumber”值将更新该电话号码的聊天状态。
3. 通过 WhatsApp 号码获取消息 API
端点:GET /{tenantId}/api/v1/getMessages/{whatsappNumber}
如下图所示,需要的查询参数是 WhatsApp 号码和租户 ID。要获取消息的内容,需要在查询参数中指定号码。
例如,要获取默认号码的消息,请将该号码设置为 channelPhoneNumber
的值。
4. 向已开启的会话发送消息
端点: POST /{tenantId}/api/v1/sendSessionMessage/{whatsappNumber}
如下图所示,需要参数“租户ID”、“WhatsApp号码”和 “消息正文”,并且需要在有效载荷中指定“channelPhoneNumber”。
例如:要从默认号码发送会话消息,请在有效载荷中将默认号码作为“channelPhoneNumber”值指定。
5. 不需要指定号码的其他 API
以下 API 不 需要设置特定电话号码,因为联系人数据在所有已连接的号码之间共享:
添加联系人:
POST /{tenantId}/api/v1/addContact/{whatsappNumber}
更新联系人属性:
POST /{tenantId}/api/v1/updateContactAttributes/{whatsappNumber}
更新联系人属性列表:
获取联系人列表:
注意:您可以在 Wati 环境中的 API 文档 页面找到 访问令牌 和 API 端点详细信息。
Wati API 及其对多个 WhatsApp 号码的支持
API 名称 | 可用 |
发送模板消息 | 是 |
发送模板消息 | 是 |
通过 WhatsApp 号码获取消息 | 是 |
获取联系人列表 | 是 |
更新联系人属性 | 是 |
更新联系人属性列表 | 是 |
添加联系人 | 是 |
向已开启的会话发送消息 | 是 |
更新聊天状态 | 是 |