批次傳送 ChatApp 訊息。
介面說明
-
您可呼叫此介面批次傳送訊息,也可在通道管理>管理>訊息傳送介面手動批次傳送訊息。
-
在呼叫此介面前,請確保您已成功建立通道,且已有審核通過的範本。
-
WhatsApp 通道類型需已完成 WABA 註冊及綁定、新增號碼。
-
Messenger 通道類型需已完成連結公共粉絲專頁帳號。
-
Instagram 通道類型需已完成連結專業帳號。
-
Viber 通道類型需已完成申請服務帳號。
QPS 限制
-
本介面的單一使用者 QPS 限制為每秒 10 次。超過限制時,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。
-
單次請求支援最多 1,000 個號碼。
狀態變更
訊息傳送狀態可以透過 MNS/HTTP 方式監聽,詳細資訊請參閱回執訊息。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cams:SendChatappMassMessage |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ChannelType |
string |
是 |
通道類型。取值:
|
|
| TemplateCode |
string |
否 |
範本編碼。在通道管理>管理>範本設計介面檢視。 |
1119*************** |
| Language |
string |
是 |
語言。詳細語言代碼清單,請參見語言代碼。 |
en |
| From |
string |
是 |
傳送方號碼。 |
861387777**** |
CustWabaId
deprecated
|
string |
否 |
ISV 客戶 wabaId。已過時的參數,請使用 CustSpaceId(直客客戶執行個體 ID)。在通道管理介面檢視。 |
cams-8c8********* |
| FallBackId |
string |
否 |
回落策略 ID。該參數為國際站設定參數,中國站可忽略此參數。在回落策略介面檢視策略 ID。 |
S0**** |
| FallBackContent |
string |
否 |
自訂回落內容。該參數為國際站設定參數,中國站可忽略此參數。 |
Fallback SMS |
| TaskId |
string |
否 |
自訂工作 ID。 |
10000**** |
| SenderList |
array<object> |
否 |
接收方號碼清單。 |
|
|
array<object> |
否 |
接收方號碼。 |
||
| TemplateParams |
object |
否 |
範本參數集合。 |
|
|
string |
否 |
範本參數。Key-Value 格式,Key 為參數名稱,Value 為參數取值。 |
{ "param1": "value1", "param2": "value2" } |
|
| FlowAction |
object |
否 |
Flow 訊息物件。 |
|
| FlowActionData |
object |
否 |
Flow 預設參數集合。 |
|
|
any |
否 |
Flow 預設參數。Key-Value 格式,Key 為參數名稱,Value 為參數取值。 |
{ "name": "name" } |
|
| FlowToken |
string |
否 |
自訂 Flow Token 資訊。 |
kde**** |
| Payload |
array |
否 |
按鈕的觸發訊息識別碼清單。 |
|
|
string |
否 |
按鈕的觸發訊息。 |
payloadtext |
|
| To |
string |
否 |
接收方號碼。
|
861386666**** |
| ProductAction |
object |
否 |
商品資訊,此參數僅適用於 whatsapp 類型通道。即為您在 Meta 上傳的商品資訊。 |
|
| ThumbnailProductRetailerId |
string |
否 |
商品目錄 ID。可透過 ListProductCatalog 介面取得。 |
skkks99**** |
| Sections |
array<object> |
否 |
商品分類清單(最多可以有 10 個分類,30 個商品)。 |
|
|
array<object> |
否 |
商品分類。 |
||
| Title |
string |
否 |
分類名稱。在通道管理>管理>目錄管理>商品管理介面查看或通過 ListProduct 介面擷取。 |
abcd |
| ProductItems |
array<object> |
否 |
商品資訊列表。 |
|
|
object |
否 |
商品資訊。 |
||
| ProductRetailerId |
string |
否 |
商品 ID。在通道管理>管理>目錄管理>商品管理介面查看或通過 ListProduct 介面擷取。 |
ksi3**** |
| RecipientType |
string |
否 |
individual |
|
IsvCode
deprecated
|
string |
否 |
ISV 驗證碼,用於驗證子帳號是否由 ISV 授權,已棄用,可忽略此參數。 |
skdi3kksloslikd**** |
| CustSpaceId |
string |
否 |
ISV 子客戶的 SpaceId,直客客戶執行個體 ID。在通道管理介面檢視。 |
cams-8c8********* |
| Ttl |
integer |
否 |
Viber 訊息傳送逾時時間。此參數為國際站參數,中國站可忽略此參數。單位:秒,取值範圍 30~1209600。 |
46 |
| Label |
string |
否 |
Viber 訊息類型,此參數為國際站參數,中國站可忽略此參數。 取值:
|
promotion |
| Tag |
string |
否 |
標籤資訊,Viber 訊息傳送時自訂標籤資訊。 |
Tag |
| FallBackDuration |
integer |
否 |
回落觸發時間。此參數為國際站參數,中國站可忽略此參數。訊息在指定時間內沒有返回已送達回執訊息時進行回落,不填代表不根據此時間判斷回落,只有傳送失敗和有失敗的狀態報告時才會回落。單位:秒。最小值:60,最大值:43200。 |
120 |
| FallBackRule |
string |
否 |
回落規則。此參數為國際站參數,中國站可忽略此參數。 取值:
|
undelivered |
| TemplateName |
string |
否 |
範本名稱。在通道管理>管理>範本設計介面檢視範本名稱。 |
test_name |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資料。 |
||
| AccessDeniedDetail |
string |
存取被拒絕詳細資訊。 |
None |
| RequestId |
string |
請求 ID。 |
90E63D28-E31D-1EB2-8939-A9486641**** |
| Message |
string |
錯誤提示資訊。 |
User not authorized to operate on the specified resource. |
| GroupMessageId |
string |
批次訊息 ID。 |
890000010002**** |
| Code |
string |
請求狀態碼。
|
OK |
樣本
正常返回樣本
JSON格式
{
"AccessDeniedDetail": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Message": "User not authorized to operate on the specified resource.",
"GroupMessageId": "890000010002****",
"Code": "OK"
}
錯誤碼
|
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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。