發送ChatApp消息。
接口說明
QPS 限制
本接口的單用戶 QPS 限制為 250 次/秒。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。
狀態變更
消息發送狀態可以通過 MNS/HTTP 方式監聽,具體請參考回執消息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cams:SendChatappMessage | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ChannelType | string | 是 | 類型。取值:
| |
Type | string | 是 | 消息類型。取值:
| template |
MessageType | string | 否 | 當 Type 為 message 時,指定消息的詳細類型。 WhatsApp 消息類型:
Viber 消息類型:
說明
詳細字段說明,請參見字段說明。
| text |
TemplateCode | string | 否 | 模板 Code。Type 為 template 時此字段必填。 | 744c4b5c79c9432497a075bdfca3**** |
Language | string | 否 | 模板語言。Type 為 template 時此字段必填,詳細語言代碼列表,請參見語言代碼。 | en |
From | string | 是 | 消息發送方號碼。 說明
當前支持 WhatsApp 賬號且在控制臺審核通過的號碼。
| 861360000**** |
To | string | 是 | 消息接收方號碼。 | 861390000**** |
TemplateParams | object | 否 | 消息模板變量。 | |
string | 否 | 消息模板變量對應的實際值,參數格式為 JSON 格式。如果模板中存在變量,該參數為必填項。 | {"param1":"value1","param2":"value2"} | |
Content | string | 否 | 消息內容。 WhatsApp 消息備注:
Viber 消息備注:
| {"text": "hello whatsapp", "link": "", "caption": "", "fileName": "" } |
Payload | array | 否 | 按鈕的觸發消息。 | |
string | 否 | 模板中按鈕的觸發消息。 | payloadtext1,payloadtext2,payloadtext3 | |
CustWabaIddeprecated | string | 否 | ISV 客戶 wabaId。 說明
過時的參數,請使用 CustSpaceId。
| 65921621816**** |
FallBackId | string | 否 | 失敗回落策略 ID。可以在控制臺創建相關策略并查看。 說明
中國站此字段無效。
| S_00**** |
FallBackContent | string | 否 | 失敗回落消息內容。 說明
中國站此字段無效。
| This is a fallback message. |
IsvCode | string | 否 | ISV 校驗碼,用于校驗子賬號是否由 ISV 授權。 | skdi3kksloslikd**** |
CustSpaceId | string | 否 | 子賬戶空間 ID。 | 28251486512358**** |
ContextMessageId | string | 否 | 回復的消息 ID。 | 61851ccb2f1365b16aee**** |
TrackingData | string | 否 | Viber 消息跟蹤數據值。 | tracking_id:12**** |
Label | string | 否 | Viber 消息類型。當 ChannelType=viber 時為必填,取值:
| promotion |
Ttl | integer | 否 | Viber 消息發送超時時間,單位:秒,取值范圍 30~1209600。 | 50 |
Tag | string | 否 | Viber 消息發送時 tag 信息。 | tag |
TaskId | string | 否 | 任務 ID。 | 10000**** |
FallBackDuration | integer | 否 | 消息在指定時間內沒有返回已到達回執時回落, 不填代表不根據此時間判斷回落,僅發送失敗和有失敗的狀態報告時才會回落。時間單位為秒,最小值為 60,最大值 43200。 說明
中國站此字段無效。
| 120 |
ProductAction | object | 否 | WhatsApp 發送 Catalog/MPM 類型消息時,消息中展示的商品信息。 | |
ThumbnailProductRetailerId | string | 否 | 商品 RetailerId。 | S238SK**** |
Sections | array<object> | 否 | 商品列表(最多可以有 10 個分類,30 個商品)。 | |
object | 否 | 商品分類。 | ||
Title | string | 否 | 分類名稱。 | 測試 |
ProductItems | array<object> | 否 | 商品列表。 | |
object | 否 | 商品信息。 | ||
ProductRetailerId | string | 否 | 商品 RetailerId。 | 9I39E**** |
FallBackRule | string | 否 | 回落規則。取值:
說明
中國站此字段無效。
| undelivered |
FlowAction | object | 否 | Flow 發送數據。 | |
FlowToken | string | 否 | flow token 信息。 | 1122*** |
FlowActionData | object | 否 | flow 默認參數。 | |
string | 否 | flow 默認參數。 | {"name":"test"} | |
TemplateName | string | 否 | 模板名稱。 | test_name |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
"Code": "OK",
"Message": "User not authorized to operate on the specified resource.",
"MessageId": "61851ccb2f1365b16aee****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Product.Unsubscript | You have not subscribed to the specified product. | 您尚未訂閱指定的產品。 |
400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 您無權執行該操作。 |
400 | System.LimitControl | The system is under flow control. | 系統處于流控制之下。 |
400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 資源不屬于當前用戶。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-04-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-03-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-09-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-13 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-09-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-07-15 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |