Chat App メッセージをバッチで送信します。
操作説明
-
この操作を呼び出してメッセージをバッチで送信するか、コンソールの チャンネル管理 > 管理 > メッセージ送信 ページで、タグを使用して手動でチャットメッセージをバッチ送信できます。
-
この操作を呼び出す前に、チャンネルを作成し、承認済みのテンプレートがあることを確認してください。
-
WhatsApp チャンネルタイプの場合、WABA の登録とバインド および 電話番号の追加 を完了してください。
-
Messenger チャンネルタイプの場合、公開ページアカウントの接続 を完了してください。
-
Instagram チャンネルタイプの場合、プロフェッショナルアカウントの接続 を完了してください。
-
Viber チャンネルタイプの場合、サービス番号の申請 を完了してください。
QPS の制限
-
この操作の QPS 制限は、ユーザーあたり 1 秒間に 10 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。適切なレートでこの操作を呼び出してください。
-
1 回のリクエストで最大値 1,000 個の電話番号をサポートします。
ステータスの変更
MNS または HTTP のフォーマットを介してメッセージの配信ステータスの変更をモニターできます。詳細については、「配信通知メッセージ」を参照してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:SendChatappMassMessage |
create |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ChannelType |
string |
必須 |
チャンネルタイプ。有効な値:
|
|
| TemplateCode |
string |
任意 |
テンプレートコード。コンソールの チャンネル管理 > 管理 > テンプレートデザイン ページでチャットメッセージのテンプレートコードをビューできます。 |
1119*************** |
| Language |
string |
必須 |
言語。言語コードのリストについては、「言語コード」を参照してください。 |
en |
| From |
string |
必須 |
送信者の電話番号。
|
861387777**** |
CustWabaId
deprecated
|
string |
任意 |
ISV 顧客の WABA ID。このパラメーターは非推奨です。代わりに、直接顧客のインスタンス ID である 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 |
任意 |
テンプレートパラメーター。値はキーと値のフォーマットであり、キーはパラメーター名、値はパラメーター値です。 |
{ "param1": "value1", "param2": "value2" } |
|
| FlowAction |
object |
任意 |
Flow メッセージオブジェクト。 |
|
| FlowActionData |
object |
任意 |
デフォルトの Flow パラメーターのコレクション。 |
|
|
any |
任意 |
デフォルトの Flow パラメーター。値はキーと値のフォーマットであり、キーはパラメーター名、値はパラメーター値です。 |
{ "name": "name" } |
|
| FlowToken |
string |
任意 |
カスタム Flow トークン情報のフォーマット。 |
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 サブ顧客のスペース ID、または直接顧客のインスタンス 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 |
エラーメッセージ。 |
指定されたリソースを操作する権限がありません。 |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。