介面說明
本介面的單使用者QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
單次請求支援最多1,000個號碼。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:
操作:是指具體的許可權點。
存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。
資源類型:是指操作中支援授權的資源類型。具體說明如下:
對於必選的資源類型,用背景高亮的方式表示。
對於不支援資源級授權的操作,用全部資源表示。
條件關鍵字:是指雲產品自身定義的條件關鍵字。
關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
cams:SendChatappMassMessage | Write |
| 無 | 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 | ||||
ChannelType | string | 是 | 通道類型 viber | viber | ||||
TemplateCode | string | 是 | 模板編碼 | 744c4b5c79c9432497a075bdfca36bf5 | ||||
Language | string | 是 | 語言。詳細語言代碼清單,請參見語言代碼。 | en | ||||
From | string | 是 | 發送方 | 2***0 | ||||
FallBackId | string | 否 | 回落策略 ID | S00001 | ||||
FallBackContent | string | 否 | 回落內容 | 回落簡訊 | ||||
TaskId | string | 否 | 任務 ID | 100000001 | ||||
SenderList | object [] | 是 | 發送號碼列表 | |||||
To | string | 是 | 發送號碼 | 2***1 | ||||
TemplateParams | object | 否 | 模板參數 | |||||
string | 否 | 模板參數 | {"param1":"value1","param2":"value2"} | |||||
CustSpaceId | string | 否 | 子賬戶空間 ID。 | 28251486512358**** | ||||
Ttl | long | 否 | Viber 訊息發送逾時時間,單位:秒,取值範圍 30~1209600。 | 50 | ||||
Label | string | 否 | Viber 訊息類型,取值:pormotion 或 transaction | pormotion | ||||
Tag | string | 否 | Viber訊息發送時標籤資訊。 | tag A | ||||
FallBackDuration | integer | 否 | 訊息在指定時間內沒有返回已到達回執時回落, 不填代表不根據此時間判斷回落,只有發送失敗和有失敗的狀態報表時才會回落。時間單位為秒 最小值為 60,最大值 43200 | 120 | ||||
FallBackRule | string | 否 | 回落規則。 說明 取值範圍
| undelivered | ||||
返回參數
名稱 | 類型 | 描述 | 樣本值 |
object | |||
RequestId | string | 請求 ID。 | 90E63D28-E31D-1EB2-8939-A9486641**** |
Code | string | 請求狀態代碼。
| OK |
Message | string | 錯誤提示資訊。 | User not authorized to operate on the specified resource. |
GroupMessageId | string | 批量訊息 ID | 890000010002**** |
AccessDeniedDetail | string | 訪問被拒絕詳細資料 | 無 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Code": "OK",
"Message": "User not authorized to operate on the specified resource.",
"GroupMessageId": "890000010002****",
"AccessDeniedDetail": "無"
}錯誤碼
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. |
訪問錯誤中心查看更多錯誤碼。