摘要
如果您使用了 Wati 的 多個 WhatsApp 號碼 功能,本指南將說明如何跨不同連接的號碼使用 Wati 的 API。
说明
在您的 Wati 帳戶中使用多個 WhatsApp 號碼可讓您從不同的號碼發送和接收消息。 為確保您的 API 呼叫能透過正確的號碼,您需要在負載或 URL 中包含一個額外的金鑰,具體取決於您正在使用的 API。
以下是目前支援多個號碼的 API 及其使用方法。
1. 发送模板消息 API
Endpoint:POST /{tenantId}/api/v1/sendTemplateMessage
必填欄位:
租戶 ID
WhatsApp 号码
channelNumber (在負載中):您希望發送訊息的電話號碼。
例如,如果您希望消息是從預設號碼發送,請將 channelNumber
設定為該預設電話號碼。
2. 更新聊天狀態 API
Endpoint:POST /{tenantId}/api/v1/updateChatStatus
必填欄位:
租戶 ID
channelPhoneNumber (在負載中):將此設置為您要更新聊天狀態的號碼。
聊天狀態將根據「channelPhoneNumber」提交的電話號碼更新。
3. 根據 WhatsApp号码获取消息 API
Endpoint:GET /{tenantId}/api/v1/getMessages/{whatsappNumber}
如下圖所示,必需的查詢參數為 WhatsApp 号码和租戶 ID,並需要在查詢參數中指定要获取消息的连接的號碼。
例如,要從預設號碼提取訊息,請將該號碼設定為 channelPhoneNumber
的值。
4. 发送消息到打开的会话
Endpoint: 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 endpoints細節。
Wati API 及其對多个 WhatsApp 号码的支持
API 名稱 | 執行 |
發送模板消息 | 是 |
發送模板訊息 | 是 |
根據 WhatsApp 号码获取消息 | 是 |
獲取聯絡人列表 | 是 |
更新聯繫人屬性 | 是 |
更新聯繫人屬性列表 | 是 |
添加聯繫人 | 是 |
發送訊息到已打開的會話 | 是 |
更新聊天狀態 | 是 |