API標準及多語言預置SDK
本產品（cams/2020-06-06）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
IM 群組管理
|
API |
標題 |
API概述 |
| AddChatGroup | 建立IM群 | 建立IM群。 |
| AddChatGroupInviteLink | 添加IM群邀請連結 | 添加IM群邀請連結。 |
| DeleteChatGroupInviteLink | 刪除IM群邀請連結 | 刪除IM群邀請連結。 |
| DeleteChatGroupParticipants | 刪除IM群成員 | 刪除進入IM群的成員。 |
| ListChatGroup | IM群列表 | 擷取IM群列表。 |
| UpdateChatGroup | 修改IM群資訊 | 修改IM群資訊。 |
| DeleteChatGroup | 刪除IM群 | 刪除已建立成功的IM群。 |
Messenger 行銷訊息
|
API |
標題 |
API概述 |
| SyncMessengerSubscriptionToken | 同步自訂受眾Token | 查詢Messenger訂閱token。 |
| SyncMessageCampaign | 同步預算資訊 | 同步查詢預算。 |
| ListMessengerSubscriptionToken | 查詢自訂受眾、訂閱token列表 | 查詢自訂受眾、訂閱token列表。 |
| ListMessageCampaign | 查詢預算列表 | 查詢預算列表。 |
| ListCustomAudience | 自訂受眾查詢 | 自訂受眾列表查詢。 |
| ListChatGroupParticipants | IM群成員列表 | 擷取IM群成員列表。 |
| GetMessageCampaignInsights | 擷取營銷活動預算的成效分析資料 | 查詢預算指標。 |
| DeleteMessageCampaign | 刪除messenger訊息營銷活動預算 | 刪除發送Messenger訊息建立的營銷活動預算。 |
| CreateMessageCampaign | 建立預算 | 建立預算。 |
| CreateCustomAudience | 建立自訂受眾 | 建立自訂受眾。 |
| AddCustomAudienceUser | 增加自訂受眾 | 增加自訂受眾。 |
執行個體/Space 管理
|
API |
標題 |
API概述 |
| ListInstance | 查詢執行個體列表 | 查詢執行個體列表。 |
| QueryInstance | 查詢執行個體 | 查詢執行個體。 |
| ListInstance | 查詢執行個體列表 | 查詢執行個體列表。 |
| QueryInstance | 查詢執行個體 | 查詢執行個體。 |
| UpdateInstance | 修改執行個體 | 修改執行個體。 |
流程編輯器
|
API |
標題 |
API概述 |
| TriggerChatFlow | 觸發已上線的流程版本 | 觸發已上線且觸發器類型為手動的流程版本。 |
Whatsapp Flow
|
API |
標題 |
API概述 |
| CreateFlow | 建立Flow | 建立Flow。 |
| ListFlow | 查詢Flow列表 | 查詢Flow列表。 |
| GetFlow | 擷取Flow詳細資料 | 擷取Flow詳細資料。 |
| ModifyFlow | 修改Flow基礎資訊 | 修改Flow基礎資訊。 |
| UpdateFlowJSONAsset | 使用JSON更新Flow內容 | 使用JSON更新Flow內容。 |
| GetFlowJSONAssest | 擷取Flow的JSON內容 | 擷取Flow的JSON格式的內容。 |
| GetFlowPreviewUrl | 擷取Flow預覽URL | 擷取Flow預覽URL。 |
| PublishFlow | 發布Flow | 發布Flow。 |
| DeprecateFlow | 棄用Flow | 棄用Flow。 |
| DeleteFlow | 刪除Flow | 刪除Flow（只有在DRAFT狀態的Flow才允許刪除）。 |
嵌入式相關
|
API |
標題 |
API概述 |
| IsvGetAppId | 擷取App ID | ISV擷取App ID。 |
| ChatappBindWaba | 綁定waba | 北向介面綁定Waba。 |
| GetPermissionByCode | 根據嵌入式得到的Code擷取授權許可權 | 根據嵌入式得到的Code擷取授權許可權。 |
| ChatappSyncPhoneNumber | 同步號碼資訊 | 同步號碼資訊。 |
| AddChatappPhoneNumber | 增加Whatsapp號碼 | 增加號碼到Waba中。 |
| GetPhoneNumberVerificationStatus | 查詢號碼驗證狀態 | 擷取號碼驗證狀態。 |
| GetChatappVerifyCode | 擷取號碼驗證碼 | 北向介面擷取驗證碼。 |
| ChatappVerifyAndRegister | 號碼校正並註冊 | 北向介面校正驗證碼並註冊。 |
| ChatappPhoneNumberRegister | 號碼註冊 | 北向介面註冊號碼。 |
| ChatappPhoneNumberDeregister | 取消註冊Whatsapp號碼 | 從Waba中取消註冊號碼。 |
| QueryWabaBusinessInfo | 查詢waba商業資訊 | 擷取Waba帳號Business平台資訊。 |
| UpdatePhoneWebhook | 修改號碼回調地址資訊 | 修改號碼回調地址資訊。 |
| UpdateAccountWebhook | 修改帳號回調地址資訊 | 修改帳號回調地址資訊。 |
| QueryPhoneBusinessProfile | 查詢號碼商業資訊 | 查詢號碼商業資訊。 |
| ModifyPhoneBusinessProfile | 修改號碼商業資訊 | 修改號碼商業資訊。 |
| CreateChatappMigrationInitiate | 建立需要遷移號碼 | 新增遷移號碼。 |
| GetMigrationVerifyCode | 擷取遷移號碼的驗證碼 | 擷取遷移號碼的驗證碼。 |
| ChatappMigrationVerified | 遷移號碼校正 | 遷移號碼校正。 |
| ChatappMigrationRegister | 遷移號碼註冊 | 遷移號碼註冊。 |
| GetChatappUploadAuthorization | 擷取上傳檔案的鑒權資訊 | 擷取上傳檔案的鑒權資訊。 |
| GetCommerceSetting | 擷取號碼商業設定狀態 | 擷取號碼商業設定狀態。 |
| UpdateCommerceSetting | 修改號碼商業設定狀態 | 修改號碼商業設定狀態。 |
號碼管理
|
API |
標題 |
API概述 |
| GetWhatsappHealthStatus | 擷取Whatsapp訊息發送健康狀態 | 擷取不同類型的節點發送訊息的健康狀態。 |
| UpdateConversationalAutomation | 修改號碼歡迎訊息、開場白和命令 | 修改號碼歡迎訊息、開場白和命令。 |
| GetConversationalAutomation | 擷取號碼歡迎訊息、開場白和命令 | 擷取歡迎訊息、開場白和命令。 |
| GetPhoneEncryptionPublicKey | 擷取號碼的加密公開金鑰 | 擷取號碼的加密公開金鑰。 |
| UpdatePhoneEncryptionPublicKey | 更新號碼的加密公開金鑰 | 更新號碼的加密公開金鑰。 |
| UpdatePhoneMessageQrdl | 修改訊息二維碼 | 修改訊息二維碼。 |
| ListPhoneMessageQrdl | 查詢訊息二維碼列表 | 查詢訊息二維碼列表資料。 |
| DeletePhoneMessageQrdl | 刪除訊息二維碼 | 刪除訊息二維碼。 |
| CreatePhoneMessageQrdl | 建立訊息二維碼 | 建立訊息二維碼。 |
| QueryChatappPhoneNumbers | 查詢客戶下的所有發送號碼及號碼狀態 | 查詢客戶下的所有發送號碼及號碼狀態。 |
| QueryChatappBindWaba | 查詢客戶綁定的Waba | 查詢客戶綁定的WABA。 |
訊息發送
|
API |
標題 |
API概述 |
| SendChatappMassMessage | 批量發送ChatApp訊息 | 批量發送ChatApp訊息。 |
| SendChatappMessage | 發送ChatApp訊息 | 發送ChatApp訊息。 |
| WhatsappCall | Whatsapp語音電話 | 呼叫、接聽、掛斷Whatsapp語音電話。 |
範本管理
|
API |
標題 |
API概述 |
| CreateChatappTemplate | 建立ChatApp模板 | 建立訊息模板，模板審核通過後可以發送訊息。 |
| ModifyChatappTemplate | 修改ChatApp模板 | 修改訊息模板。只能修改未審核以及審核不通過的模板。 |
| ListChatappTemplate | 查詢ChatApp模板列表 | 擷取訊息模板列表。 |
| GetChatappTemplateDetail | 查詢ChatApp模板詳情 | 擷取訊息模板的詳細資料。 |
| DeleteChatappTemplate | 刪除ChatApp模板 | 刪除訊息模板。 |
商品目錄
|
API |
標題 |
API概述 |
| ListProductCatalog | 商品目錄列表 | 查詢Meta Business平台的目錄列表。 |
| GetWhatsappConnectionCatalog | 擷取Waba綁定的目錄 | 擷取Waba關聯的目錄。 |
| ListProduct | 商品列表 | 查詢目錄下的商品列表。 |
統計指標
|
API |
標題 |
API概述 |
| GetChatappPhoneNumberMetric | 查詢號碼的發送量指標 | 查詢WhatsApp類型通道號碼的發送量指標。 |
| EnableWhatsappROIMetric | 開啟Whatsapp ROI指標統計 | 開啟Whatsapp相關指標統計。 |
| GetChatappTemplateMetric | 擷取營銷類型模板的相關指標 | 擷取營銷類型模板的相關指標。 |
其他
|
API |
標題 |
API概述 |
| GetPreValidatePhoneId | 擷取預校正號碼的ID | 預註冊號碼擷取ID，用來在嵌入式中選擇，不用重新擷取驗證碼。 |
| BeeBotAssociate | 機器人聯想 | 根據使用者請求，聯想知識庫中的FAQ。 |
| ChatappEmbedSignUp | 嵌入式入口 | 北向介面嵌入式。 請在調用嵌入式SDK時使用v2版本，此介面即可忽略。 |
| SubmitIsvCustomerTerms | 提交Isv客戶的協議資訊 | 提交Isv客戶的協議資訊。 |
| AddAuditViberOpen | 註冊viber帳號，開戶 | 註冊viber帳號，開戶。 |
| GetViberByRequestNo | 查詢申請單 | 通過requestNo查詢申請單。 |
| UpdateAuditRequest | 修改viber申請單 | 修改viber申請單。 |
| CreateInstance | 建立執行個體 | 建立執行個體。 |
| DeleteInstance | 刪除執行個體 | 刪除執行個體。 |