本產品（
ChatApp消息服務/2020-06-06）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
Flow
| API | 標題 | API概述 |
|---|---|---|
| PublishFlow | 發布Flow | 發布Flow。 |
| UpdateFlowJSONAsset | 使用JSON更新Flow內容 | 使用JSON更新Flow內容。 |
| ModifyFlow | 修改Flow基礎信息 | 修改Flow基礎信息。 |
| ListFlow | 查詢Flow列表 | 查詢Flow列表。 |
| GetFlowPreviewUrl | 獲取Flow預覽URL | 獲取Flow預覽URL。 |
| GetFlowJSONAssest | 獲取Flow的JSON內容 | 獲取Flow的JSON格式的內容。 |
| GetFlow | 獲取Flow詳細信息 | 獲取Flow詳細信息。 |
| DeprecateFlow | 棄用Flow | 棄用Flow。 |
| DeleteFlow | 刪除Flow | 刪除Flow（只有在DRAFT狀態的Flow才允許刪除）。 |
| CreateFlow | 創建Flow | 創建Flow。 |
嵌入式相關
號碼管理
| API | 標題 | API概述 |
|---|---|---|
| GetWhatsappHealthStatus | 獲取Whatsapp消息發送健康狀態 | 獲取不同類型的節點發送消息的健康狀態。 |
| UpdateConversationalAutomation | 修改號碼歡迎消息、開場白和命令 | 修改號碼歡迎消息、開場白和命令。 |
| GetConversationalAutomation | 獲取號碼歡迎消息、開場白和命令 | 獲取歡迎消息、開場白和命令。 |
| GetPhoneEncryptionPublicKey | 獲取號碼的加密公鑰 | 獲取號碼的加密公鑰。 |
| UpdatePhoneEncryptionPublicKey | 更新號碼的加密公鑰 | 更新號碼的加密公鑰。 |
| UpdatePhoneMessageQrdl | 修改消息二維碼 | 修改消息二維碼。 |
| ListPhoneMessageQrdl | 查詢消息二維碼列表 | 查詢消息二維碼列表數據。 |
| DeletePhoneMessageQrdl | 刪除消息二維碼 | 刪除消息二維碼。 |
| CreatePhoneMessageQrdl | 創建消息二維碼 | 創建消息二維碼。 |
| QueryChatappPhoneNumbers | 查詢客戶下的所有發送號碼及號碼狀態 | 查詢客戶下的所有發送號碼及號碼狀態。 |
| QueryChatappBindWaba | 查詢客戶綁定的Waba | 查詢客戶綁定的WABA。 |
消息發送
| API | 標題 | API概述 |
|---|---|---|
| SendChatappMassMessage | 批量發送ChatApp消息 | 批量發送ChatApp消息。 |
| SendChatappMessage | 發送ChatApp消息 | 發送ChatApp消息。 |
模板管理
| API | 標題 | API概述 |
|---|---|---|
| CreateChatappTemplate | 創建ChatApp模板 | 創建消息模板，模板審核通過后可以發送消息。 |
| ModifyChatappTemplate | 修改ChatApp模板 | 修改消息模板。只能修改未審核以及審核不通過的模板。 |
| ListChatappTemplate | 查詢ChatApp模板列表 | 獲取消息模板列表。 |
| GetChatappTemplateDetail | 查詢ChatApp模板詳情 | 獲取消息模板的詳細信息。 |
| DeleteChatappTemplate | 刪除ChatApp模板 | 刪除消息模板。 |
商品目錄
| API | 標題 | API概述 |
|---|---|---|
| ListProductCatalog | 商品目錄列表 | 查詢Meta Business平臺的目錄列表。 |
| GetWhatsappConnectionCatalog | 獲取Waba綁定的目錄 | 獲取Waba關聯的目錄。 |
| ListProduct | 商品列表 | 查詢目錄下的商品列表。 |
統計指標
| API | 標題 | API概述 |
|---|---|---|
| GetChatappPhoneNumberMetric | 查詢號碼的發送量指標 | 查詢號碼的發送量指標。 |
| EnableWhatsappROIMetric | 開啟Whatsapp ROI指標統計 | 開啟Whatsapp相關指標統計。 |
| GetChatappTemplateMetric | 獲取Marketing類型模板的相關指標 | 獲取Marketing類型模板的相關指標。 |