ChatApp メッセージを一括送信します。
操作説明
-
この API 操作を呼び出して、メッセージをバッチで送信できます。[チャンネル管理] > [管理] > [メッセージの送信] ページで手動でメッセージをバッチで送信することもできます。
-
この API 操作を呼び出す前に、チャンネルを作成し、承認済みのテンプレートがあることを確認してください。
-
WhatsApp チャンネルタイプの場合、WABA の登録とバインドおよび電話番号の追加を完了する必要があります。
-
Messenger チャンネルタイプの場合、Facebook ページアカウントを接続する必要があります。
-
Instagram チャンネルタイプの場合、プロフェッショナルアカウントを接続する必要があります。
-
Viber チャンネルタイプの場合、サービス ID をリクエストする必要があります。
QPS 制限
-
この API 操作の単一ユーザーに対する 1 秒あたりのクエリ数 (QPS) 制限は、毎秒 10 回の呼び出しです。制限を超えると、API 呼び出しはスロットルされます。これはビジネスに影響を与える可能性があります。それに応じて呼び出しを計画してください。
-
1 回のリクエストには最大 1,000 件の電話番号を含めることができます。
ステータスの変更
MNS または HTTP を使用してメッセージ送信ステータスをモニターできます。詳細については、「レシート」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:SendChatappMassMessage |
create |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ChannelType |
string |
必須 |
チャンネルタイプ。有効な値:
|
|
| TemplateCode |
string |
任意 |
テンプレートコード。[チャンネル管理] > [管理] > [テンプレートデザイン] ページでテンプレートコードを表示します。 |
1119*************** |
| Language |
string |
必須 |
言語。言語コードのリストについては、「言語コード」をご参照ください。 |
en |
| From |
string |
必須 |
送信者の番号。
|
861387777**** |
CustWabaId
deprecated
|
string |
任意 |
独立系ソフトウェアベンダー (ISV) 顧客の WhatsApp Business Account (WABA) ID。このパラメーターは非推奨です。直接の顧客のインスタンス ID である CustSpaceId を使用してください。[チャンネル管理] ページで ID を表示します。 |
cams-8c8********* |
| FallBackId |
string |
任意 |
フォールバックポリシー ID。このパラメーターは国際サイト (alibabacloud.com) 用です。中国サイト (aliyun.com) をご利用の場合は、このパラメーターを無視できます。 [フォールバック戦略] ページでポリシー ID を表示します。 |
S0**** |
| FallBackContent |
string |
任意 |
カスタムフォールバックコンテンツ。このパラメーターは国際サイト (alibabacloud.com) 用です。中国サイト (aliyun.com) をご利用の場合は、このパラメーターを無視できます。 |
Fallback SMS |
| TaskId |
string |
任意 |
カスタムタスク ID。 |
10000**** |
| SenderList |
array<object> |
任意 |
メッセージを送信する受信者のリスト。 |
|
|
array<object> |
任意 |
受信者の電話番号。 |
||
| TemplateParams |
object |
任意 |
テンプレートパラメーターのコレクション。 |
|
|
string |
任意 |
テンプレートパラメーター。キーと値の形式です。キーはパラメーター名、値はパラメーター値です。 |
{ "param1": "value1", "param2": "value2" } |
|
| FlowAction |
object |
任意 |
Flow メッセージオブジェクト。 |
|
| FlowActionData |
object |
任意 |
デフォルトのフローパラメーターのコレクション。 |
|
|
any |
任意 |
デフォルトのフローパラメーター。キーと値の形式です。キーはパラメーター名、値はパラメーター値です。 |
{ "name": "name" } |
|
| FlowToken |
string |
任意 |
カスタムフロートークン情報。 |
kde**** |
| Payload |
array |
任意 |
ボタンのペイロードのリスト。 |
|
|
string |
任意 |
ボタンのペイロード。 |
payloadtext |
|
| To |
string |
任意 |
受信者の番号。
|
861386666**** |
| ProductAction |
object |
任意 |
プロダクト情報。このパラメーターは whatsapp チャンネルタイプ専用です。Meta にアップロードしたプロダクト情報です。 |
|
| ThumbnailProductRetailerId |
string |
任意 |
製品カタログ ID。ListProductCatalog API 操作を呼び出して取得します。 |
skkks99**** |
| Sections |
array |
任意 |
製品カテゴリのリスト。最大 10 個のカテゴリと 30 個のプロダクトを持つことができます。 |
|
|
array<object> |
任意 |
製品カテゴリ。 |
||
| Title |
string |
任意 |
カテゴリ名。[チャンネル管理] > [管理] > [カタログ管理] > [製品管理] ページで表示するか、ListProduct API 操作を呼び出して取得します。 |
abcd |
| ProductItems |
array |
任意 |
プロダクト情報のリスト。 |
|
|
object |
任意 |
プロダクト情報。 |
||
| ProductRetailerId |
string |
任意 |
プロダクト ID。[チャンネル管理] > [管理] > [カタログ管理] > [製品管理] ページで表示するか、ListProduct API 操作を呼び出して取得します。 |
ksi3**** |
IsvCode
deprecated
|
string |
任意 |
ISV チェックサム。RAM ユーザーが ISV によって承認されているかどうかを検証するために使用されます。このパラメーターは非推奨です。無視できます。 |
skdi3kksloslikd**** |
| CustSpaceId |
string |
任意 |
ISV のサブ顧客の SpaceId で、直接の顧客のインスタンス ID です。[チャンネル管理] ページで表示します。 |
cams-8c8********* |
| Ttl |
integer |
任意 |
Viber メッセージを送信するためのタイムアウト期間。このパラメーターは国際サイト (alibabacloud.com) 用です。中国サイト (aliyun.com) をご利用の場合は、このパラメーターを無視できます。 単位: 秒。有効な値: 30~1209600。 |
46 |
| Label |
string |
任意 |
Viber メッセージタイプ。このパラメーターは国際サイト (alibabacloud.com) 用です。中国サイト (aliyun.com) をご利用の場合は、このパラメーターを無視できます。 有効な値:
|
promotion |
| Tag |
string |
任意 |
タグ情報。これは Viber メッセージを送信するためのカスタムタグです。 |
Tag |
| FallBackDuration |
integer |
任意 |
フォールバックトリガー時間。このパラメーターは国際サイト (alibabacloud.com) 用です。中国サイト (aliyun.com) をご利用の場合は、このパラメーターを無視できます。 指定された時間内に配信レシートが返されない場合、フォールバックがトリガーされます。このパラメーターを空のままにすると、フォールバックは時間によって決定されません。フォールバックは、メッセージの送信に失敗した場合、または失敗したステータスレポートを受信した場合にのみトリガーされます。単位: 秒。最小値: 60。最大値: 43200。 |
120 |
| FallBackRule |
string |
任意 |
フォールバックルール。このパラメーターは国際サイト (alibabacloud.com) 用です。中国サイト (aliyun.com) をご利用の場合は、このパラメーターを無視できます。 有効な値:
|
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 |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Message": "User not authorized to operate on the specified resource.",
"GroupMessageId": "890000010002****",
"Code": "OK"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。