複数の電話番号に WhatsApp メッセージを送信する - Chat App Message Service

API の説明

SendChatappMassMessage を呼び出して、複数の電話番号に WhatsApp メッセージを送信できます。

この操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が出る可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。

1 回のリクエストで最大 1,000 件の電話番号にメッセージを送信できます。

デバッグ

OpenAPI エクスプローラーでこの操作を呼び出すことができます。OpenAPI エクスプローラーは、署名値を自動的に計算し、さまざまな SDK の操作のサンプルコードを動的に生成します。

権限付与情報

次の表に、API に対応する権限付与情報を示します。権限付与情報は、Action ポリシー要素で使用して、RAM ユーザーまたは RAM ロールにこの API 操作を呼び出す権限を付与できます。説明:

操作: リソースに対する操作を指定するために Action 要素で使用できる値。
アクセスレベル: 各操作のアクセスレベル。レベルは、読み取り、書き込み、および一覧表示です。
リソースタイプ: 操作を実行するために RAM ユーザーまたは RAM ロールを承認できるリソースのタイプ。次の項目に注意してください。
- 必須のリソースタイプは、太字で表示されます。
- リソースレベルで権限を付与できない場合は、操作の [リソースタイプ] 列で すべてのリソース が使用されます。
条件キー: クラウドサービスによって定義される条件キー。
関連付けられた操作: 操作を完了するために RAM ユーザーまたは RAM ロールが実行する必要があるその他の操作。操作を完了するには、RAM ユーザーまたは RAM ロールに、関連付けられた操作を実行するための権限が必要です。

操作	アクセスレベル	リソースタイプ	条件キー	関連付けられた操作
cams:SendChatappMassMessage	書き込み	acs:cams::{#accountId}:*	なし	なし

リクエストパラメーター

パラメーター					タイプ	必須	説明	例
ChannelType					文字列	はい	チャネルのタイプ。パラメーターを whatsapp に設定します。	whatsapp
TemplateCode					文字列	はい	テンプレートコード。	744c4b5c79c9432497a075bdfca36bf5
Language					文字列	はい	言語。言語コードの詳細については、「言語コード」をご参照ください。	en
From					文字列	はい	メッセージ送信者の携帯電話番号。	861387777****
FallBackId					文字列	いいえ	フォールバックポリシーの ID。	S00001
FallBackContent					文字列	いいえ	フォールバックメッセージの内容。	フォールバックショートメッセージ
TaskId					文字列	いいえ	タスク ID。	100000001
SenderList					オブジェクト []	はい	メッセージ受信者の携帯電話番号。
	To				文字列	はい	メッセージ受信者の携帯電話番号。	861388988****
	TemplateParams				オブジェクト	いいえ	テンプレートのパラメーター。
					文字列	いいえ	テンプレートのパラメーター。	{"param1":"value1","param2":"value2"}
	Payload				配列	いいえ	ボタンのペイロード。
					文字列	いいえ	ボタンのペイロード。	["payloadtext1","payloadtext2","payloadtext3"]
	ProductAction				オブジェクト	いいえ	製品に関する情報。
		ThumbnailProductRetailerId			文字列	いいえ	製品の小売業者 ID。	skkks999393
		Sections			オブジェクト []	いいえ	製品。最大 30 製品と 10 カテゴリを追加できます。
			Title		文字列	いいえ	カテゴリの名前。	abcd
			ProductItems		オブジェクト []	いいえ	製品。
				ProductRetailerId	文字列	いいえ	製品の小売業者 ID。	ksi399d8
	FlowAction				オブジェクト	いいえ	WhatsApp フローの操作。
		FlowToken			文字列	いいえ	フロートークンに関する情報。	kde99d8
		FlowActionData			オブジェクト	いいえ	フローのデフォルトパラメーター。
					文字列	いいえ	フローのデフォルトパラメーター。	{"name":"name"}
CustSpaceId					文字列	いいえ	RAM ユーザーのスペース ID。	28251486512358****
FallBackDuration					整数	いいえ	メッセージがクライアントに配信されたことを示すメッセージ受信確認が受信されない場合に、フォールバックメッセージが送信されるまでの期間を指定します。このパラメーターを空のままにすると、メッセージの送信に失敗した場合、またはメッセージがクライアントに配信されなかったことを示すメッセージ受信確認が受信された場合にのみ、フォールバックメッセージが送信されます。単位: 秒。有効な値: 60 ～ 43200。	120
FallBackRule					文字列	いいえ	フォールバックルール。有効な値: undelivered: メッセージがクライアントに配信されない場合に、フォールバックがトリガーされます。メッセージの送信時に、テンプレートパラメーターが検証されます。パラメーターが検証に合格しなかった場合、メッセージは送信されません。テンプレートと電話番号が禁止されているかどうかは検証されません。デフォルトでは、FallBackRule が空の場合にこの値が使用されます。 sentFailed: 変数を含むテンプレートパラメーターが検証に合格しなかった場合でも、フォールバックがトリガーされます。 channelType、type、messageType、to、および from パラメーターが検証に合格しなかった場合、フォールバックはトリガーされません。	undelivered

レスポンスパラメーター

パラメーター	タイプ	説明	例
	オブジェクト
RequestId	文字列	リクエストの ID。	90E63D28-E31D-1EB2-8939-A9486641****
Code	文字列	返された状態コード。 OK の値は、リクエストが成功したことを示します。その他の値は、リクエストが失敗したことを示します。詳細については、「エラーコード」をご参照ください。	OK
Message	文字列	返されたエラーメッセージ。	指定されたリソースに対する操作がユーザーに許可されていません。
GroupMessageId	文字列	メッセージグループの ID。	890000010002****
AccessDeniedDetail	文字列	アクセス拒否の詳細。	なし

例

成功レスポンスの例

JSON 形式

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "GroupMessageId": "890000010002****",
  "AccessDeniedDetail": "None"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Product.Unsubscript	指定されたプロダクトをサブスクライブしていません。
400	Ram.PermissionDeny	操作を実行する権限がありません。
400	System.LimitControl	システムはフロー制御中です。
400	Unknown.ResourceOwnerId	リソースは現在のユーザーに属していません。

エラーコードの一覧については、サービスエラーコードをご覧ください。