SendChatappMessage API でマルチチャネルメッセージを送信 - Chat App Message Service - Alibaba Cloud -

Chat App Message サービスのメッセージを送信します。

操作説明

この操作を呼び出してメッセージを送信するか、チャンネル管理 > 管理 > メッセージ送信 ページで手動でメッセージを送信できます。
この操作を呼び出す前に、チャンネルを作成し、承認済みのテンプレートを用意していることを確認してください。
WhatsApp チャンネルタイプの場合、WABA の登録とバインドおよび電話番号の追加を完了する必要があります。
Messenger チャンネルタイプの場合、公開ページアカウントの接続を完了する必要があります。
Instagram チャンネルタイプの場合、プロフェッショナルアカウントの接続を完了する必要があります。
Viber チャンネルタイプの場合、サービス ID の申請を完了する必要があります。

QPS 制限

この操作の単一ユーザー QPS 制限は、1 秒あたり 250 回の呼び出しです。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。必要に応じてこの操作を呼び出してください。

ステータスの変更

MNS または HTTP を介してメッセージの配信ステータスをモニターできます。詳細については、「受信確認メッセージ」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cams:SendChatappMessage

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ChannelType	string	必須	チャンネルタイプ。有効な値: whatsapp messenger instagram telegram viber	whatsapp
Type	string	必須	メッセージタイプ。有効な値: template: コンソールで承認済みのメッセージテンプレート。このタイプのメッセージはいつでも送信できます。 message: 任意のフォーマットのメッセージ。このタイプのメッセージは、ユーザーから最後のメッセージを受信してから 24 時間以内のみ送信できます。重要 Type が template に設定されている場合、TemplateCode を指定する必要があります。Type が message に設定されている場合、MessageType を指定する必要があります。	message
MessageType	string	任意	Type が message に設定されている場合の詳細なメッセージタイプ。有効な値: WHATSAPP text: テキストメッセージ。 image: イメージメッセージ。 video: 動画メッセージ。 audio: 音声メッセージ。 document: ドキュメントメッセージ。 interactive: インタラクティブなメッセージ。 location: 位置情報メッセージ。 contacts: 連絡先メッセージ。 reaction: リアクションメッセージ。 sticker: ステッカーメッセージ。 typing_indicator: 入力インジケーターメッセージ。 pin: ピン留めまたはピン留め解除メッセージ (グループメッセージでのみ使用可能)。 carousel: カルーセルメッセージ。 VIBER text: テキストメッセージ。 image: イメージメッセージ。 text_image_button: テキスト + イメージ + ボタンメッセージ。 text_button: テキスト + ボタンメッセージ。 document: ドキュメントメッセージ。 video: 動画メッセージ。 text_video: テキスト + 動画メッセージ。 text_video_button: テキスト + 動画 + ボタンメッセージ。 text_image: テキスト + イメージメッセージ。 MESSENGER / INSTAGRAM text: テキストメッセージ。 image: イメージメッセージ。 video: 動画メッセージ。 document: ドキュメントメッセージ。 audio: 音声メッセージ。 interactive: インタラクティブなメッセージ。 couponTemplate: クーポンテンプレートメッセージ。 regularTemplate: 通常テンプレートメッセージ。 quickReply: クイックリプライメッセージ。 buttonTemplate: ボタンテンプレートメッセージ。 TELEGRAM text: テキストメッセージ。 image: イメージメッセージ。 video: 動画メッセージ。 audio: 音声メッセージ。 document: ドキュメントメッセージ。 location: 位置情報メッセージ。 gif: アニメーション GIF メッセージ。 sticker: ステッカーメッセージ。	text
TemplateCode	string	任意	テンプレートコード。テンプレートコードは、チャンネル管理 > 管理 > テンプレートデザインページで確認できます。	1119***************
Language	string	任意	言語。言語コードのリストについては、「言語コード」をご参照ください。	en
From	string	必須	送信者番号。 ChannelType が whatsapp に設定されている場合、これは WhatsApp に登録およびバインドされた電話番号です。チャンネル管理 > 管理 > WABA 管理 > 電話番号管理ページで確認できます。 ChannelType が messenger に設定されている場合、これはページ ID です。チャンネル管理 > 管理 > 公開ページページで確認できます。 ChannelType が instagram に設定されている場合、これは Instagram プロフェッショナルアカウント ID (アカウント ID) です。チャンネル管理 > 管理 > プロフェッショナルアカウントページで確認できます。 ChannelType が viber に設定されている場合、これは Viber サービス ID です。チャンネル管理 > 管理 > サービス ID 管理ページで確認できます。	861387777****
To	string	必須	受信者番号。 ChannelType が whatsapp に設定されている場合、これはメッセージ受信者の電話番号です。 ChannelType が messenger に設定されている場合、これはユーザーが Facebook ページと対話したときに生成される Page-Scoped User ID です。 ChannelType が instagram に設定されている場合、これはユーザーが Instagram ビジネスまたはクリエイターアカウントと対話したときに生成される Instagram User ID です。 ChannelType が viber に設定されている場合、これはメッセージ受信者の電話番号です。	861388988****
TemplateParams	object	任意	テンプレートパラメーターのコレクション。
	string	任意	テンプレートパラメーター。パラメーターはキーと値のフォーマットであり、Key はパラメーター名、Value はパラメーター値です。	{ "param1": "value1", "param2": "value2" }
Content	string	任意	メッセージ本文。 WhatsApp メッセージに関する注意事項: messageType が text の場合、text フィールドは必須で、Caption フィールドは指定できません。 messageType が image の場合、Link フィールドは必須です。 messageType が video の場合、Link フィールドは必須です。 messageType が audio の場合、Link フィールドは必須で、Caption フィールドは無効です。 messageType が document の場合、Link および FileName フィールドは必須で、Caption フィールドは無効です。 messageType が interactive の場合、type および action フィールドは必須です。 messageType が contacts の場合、name フィールドは必須です。 messageType が location の場合、longitude および latitude フィールドは必須です。 messageType が sticker の場合、Link フィールドは必須で、Caption および FileName フィールドは無効です。 messageType が reaction の場合、messageId および emoji フィールドは必須です。 Messenger メッセージに関する注意事項: messageType が text の場合、text フィールドは必須です。 messageType が image、video、audio、または document の場合、link フィールドは必須です。 Instagram メッセージに関する注意事項: messageType が text の場合、text フィールドは必須です。 messageType が image、video、または audio の場合、link フィールドは必須です。 Viber メッセージに関する注意事項: messageType が text の場合、text フィールドは必須です。 messageType が image の場合、link フィールドは必須です。 messageType が video の場合、link、thumbnail、fileSize、および duration フィールドは必須です。 messageType が document の場合、link、fileName、および fileType フィールドは必須です。 messageType が text_button の場合、text、caption、および action フィールドは必須です。 messageType が text_image_button の場合、text、link、caption、および action フィールドは必須です。 messageType が text_video の場合、text、link、thumbnail、fileSize、および duration フィールドは必須です。 messageType が text_video_button の場合、text、link、thumbnail、fileSize、duration、および caption フィールドは必須で、action フィールドは空にできません。	{ "text": "hello,whatsapp", "link": "https://*****", "caption": "", "fileName": "**" }
Payload	array	任意	ボタントリガーメッセージのコレクション。	payloadtext1,payloadtext2,payloadtext3
	string	任意	テンプレート内のボタンのトリガーメッセージ。	payloadtext
CustWabaId `deprecated`	string	任意	ISV 顧客 WABA ID。このパラメーターは非推奨です。代わりに CustSpaceId (直接の顧客インスタンス ID) を使用してください。チャンネル管理ページで確認できます。	cams-8c8*********
FallBackId	string	任意	フォールバックポリシー ID。このパラメーターは中国サイト (中国本土) 向けです。中国サイトのユーザーはこのパラメーターを無視できます。ポリシー ID はフォールバックポリシーページで確認できます。	S0****
FallBackContent	string	任意	カスタムフォールバックコンテンツ。このパラメーターは中国サイト (中国本土) 向けです。中国サイトのユーザーはこのパラメーターを無視できます。	Fallback SMS
IsvCode `deprecated`	string	任意	RAM ユーザーが ISV によって承認されているかどうかを確認するために使用される ISV 検証コード。このパラメーターは非推奨であり、無視できます。	123123******
CustSpaceId	string	任意	ISV サブ顧客の SpaceId、または直接の顧客インスタンス ID。チャンネル管理ページで確認できます。	cams-8c8*********
ContextMessageId	string	任意	返信対象のメッセージの ID。これは以前に送信または受信したメッセージの ID です。	61851ccb2f1365b16aee****
TrackingData	string	任意	Viber メッセージタイプ用に渡されるカスタムトラッキングデータ。このパラメーターは国際サイト向けです。中国サイトのユーザーはこのパラメーターを無視できます。	Tracking Data
Label	string	任意	Viber メッセージタイプ。このパラメーターは国際サイト向けです。中国サイトのユーザーはこのパラメーターを無視できます。有効な値: pormotion: マーケティングまたはプロモーションメッセージ。 transaction: トランザクションメッセージ。	promotion
Ttl	integer	任意	Viber メッセージ配信のタイムアウト期間。このパラメーターは国際サイト向けです。中国サイトのユーザーはこのパラメーターを無視できます。単位: 秒。有効な値: 30 ~ 1209600。	50
Tag	string	任意	タグ情報。Viber メッセージ配信用のカスタムタグ情報。	tag
TaskId	string	任意	カスタムタスク ID。	10000****
FallBackDuration	integer	任意	フォールバックトリガー時間。このパラメーターは国際サイト向けです。中国サイトのユーザーはこのパラメーターを無視できます。指定された時間内にメッセージが配信済みレシートを返さない場合、フォールバックがトリガーされます。このパラメーターが指定されていない場合、フォールバックは時間に基づいてトリガーされず、メッセージの送信失敗時または失敗ステータスレポートの受信時のみ発生します。単位: 秒。最小値: 60。最大値: 43200。	120
ProductAction	object	任意	プロダクト情報。このパラメーターは WhatsApp チャンネルタイプにのみ適用され、Meta にアップロードしたプロダクト情報を指します。
ThumbnailProductRetailerId	string	任意	製品カタログの ID。この ID は ListProductCatalog 操作を呼び出すことで取得できます。	skkks99****
Sections	array<object>	任意	製品カテゴリのリスト (最大 10 カテゴリおよび 30 プロダクト)。
	array<object>	任意	製品カテゴリ。
Title	string	任意	カテゴリ名。チャンネル管理 > 管理 > カタログ管理 > プロダクト管理ページで確認するか、 ListProduct 操作を呼び出すことで取得できます。	abcd
ProductItems	array<object>	任意	プロダクト情報のリスト。
	object	任意	プロダクト情報。
ProductRetailerId	string	任意	製品 ID。この ID は、チャンネル管理 > 管理 > カタログ管理 > 製品管理ページで確認するか、 ListProduct 操作を呼び出して取得できます。	ksi3****
FallBackRule	string	任意	フォールバックルール。このパラメーターは国際サイト向けです。中国サイトのユーザーはこのパラメーターを無視できます。有効な値: undelivered: メッセージがデバイスに配信できない場合にフォールバックがトリガーされます (送信段階でテンプレートおよびパラメーターの検証に合格する必要があります。テンプレートの禁止や番号の禁止は検証されません)。パラメーター値が空の場合、このルールがデフォルトで使用されます。 sentFailed: テンプレートまたはテンプレート変数の検証に失敗した場合にもフォールバックがトリガーされます。channelType、type、messageType、to、および from (存在チェック) パラメーターのみが厳密に検証されます。	undelivered
FlowAction	object	任意	Flow メッセージオブジェクト。
FlowActionData	object	任意	Flow デフォルトパラメーターのコレクション。
	any	任意	Flow デフォルトパラメーター。パラメーターはキーと値のフォーマットであり、Key はパラメーター名、Value はパラメーター値です。	{ "name": "name" }
FlowToken	string	任意	カスタム Flow トークン情報。	kde****
TemplateName	string	任意	テンプレート名。テンプレート名は、チャンネル管理 > 管理 > テンプレートデザインページで確認できます。	test_name
RecipientType	string	任意	受信者タイプ。有効な値: individual: 個人。 group: グループ。	individual
MessageCampaignId	string	任意	キャンペーンメッセージ ID。説明このパラメーターはテスト用パラメーターであり、完全には利用できません。このパラメーターは無視してください。	123123********
AdAccountId	string	任意	Meta 広告アカウント ID。説明このパラメーターはテスト用パラメーターであり、完全には利用できません。このパラメーターは無視してください。	123123********
TokenType	string	任意	トークンタイプ。説明このパラメーターはテスト用パラメーターであり、完全には利用できません。このパラメーターは無視してください。	bearer
Category	string	任意	メッセージカテゴリ (WhatsApp 直接送信向け)。警告 Meta から招待された顧客でない限り、このパラメーターを指定しないでください。指定すると、メッセージの配信が失敗します。	UTILITY

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
AccessDeniedDetail	string	アクセス拒否の詳細。	None
RequestId	string	リクエスト ID。	90E63D28-E31D-1EB2-8939-A94866******
Message	string	エラーメッセージ。	User not authorized to operate on the specified resource.
Code	string	応答コード。 OK は、リクエストが成功したことを示します。その他のエラーコードについては、「エラーコード」をご参照ください。	OK
MessageId	string	メッセージ ID。	61851ccb2f1365b16aee****

例

成功レスポンス

JSONJSON

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

エラーコード

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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。