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

ChatApp メッセージを送信します。

操作説明

この API を使用してメッセージを送信します。また、コンソールから手動でメッセージを送信することもできます。手順は、チャネル管理 > 管理 > メッセージ送信 に移動します。
この API を呼び出す前に、チャネルおよび承認済みのテンプレートが存在していることを確認してください。
WhatsApp チャネルの場合、WABA の登録および紐付けと電話番号の追加を完了している必要があります。
Messenger チャネルの場合、公開ページアカウントの接続を実行済みである必要があります。
Instagram チャネルの場合、プロフェッショナルアカウントの接続を実行済みである必要があります。
Viber チャネルの場合、サービス ID の申請を実行済みである必要があります。

QPS 制限

この API の QPS 制限は、ユーザーあたり 1 秒間に 250 回の呼び出しです。この制限を超えると API 呼び出しがスロットルされ、ビジネスに影響を及ぼす可能性があります。呼び出し回数がこの制限内に収まるよう、適切に制御してください。

ステータス変更

メッセージの配信ステータスは、Message Service (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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ChannelType	string	必須	チャネルタイプ。有効な値は以下のとおりです。 whatsapp messenger instagram 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`: グループメッセージ専用のピンメッセージ。 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`: ボタンテンプレートメッセージ。	text
TemplateCode	string	任意	メッセージテンプレートのコードです。テンプレートコードは、チャネル管理 > 管理 > テンプレート設計ページで確認できます。	1119***************
Language	string	任意	メッセージテンプレートの言語です。サポートされる言語とそのコードの一覧については、「言語コード」をご参照ください。	en
From	string	必須	送信者の電話番号または ID です。 `ChannelType` が whatsapp の場合、これは WhatsApp に登録された電話番号です。この番号は、チャネル管理 > 管理 > WABA 管理 > 電話番号管理ページで確認できます。 `ChannelType` が messenger の場合、これは Facebook ページ ID です。この ID は、チャネル管理 > 管理 > ページページで確認できます。 `ChannelType` が instagram の場合、これは Instagram プロフェッショナルアカウント ID です。この ID は、チャネル管理 > 管理 > プロフェッショナルアカウントページで確認できます。 `ChannelType` が viber の場合、これは Viber サービス ID です。この ID は、チャネル管理 > 管理 > サービス番号管理ページで確認できます。	861387777****
To	string	必須	受信者の電話番号または ID です。 `ChannelType` が whatsapp の場合、これは受信者の電話番号です。 `ChannelType` が messenger の場合、これはユーザーが Facebook ページと対話した際に生成されるページスコープユーザ ID（PSID）です。 `ChannelType` が instagram の場合、これはユーザーが Instagram のビジネスまたはクリエイターアカウントと対話した際に生成される Instagram スコープユーザ ID（IGSID）です。 `ChannelType` が viber の場合、これは受信者の電話番号です。	861388988****
TemplateParams	object	任意	メッセージテンプレートの変数です。
	string	任意	キーと値の形式で指定するテンプレート変数です。キーは変数名、値は変数の値です。	{ "param1": "value1", "param2": "value2" }
Content	string	任意	JSON 形式の文字列で表されるメッセージ本文です。 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	任意	非推奨。代わりに `CustSpaceId` を使用してください。このパラメーターは WABA ID を指定します。ISV の場合、これは顧客の WABA ID です。直接契約のお客様の場合、これはインスタンス ID です。この ID は、チャネル管理ページで確認できます。	cams-8c8*********
FallBackId	string	任意	フォールバック戦略 ID です。このパラメーターは Alibaba Cloud International Site（alibabacloud.com）でのみ利用可能です。この戦略 ID は、フォールバックポリシーページで確認できます。	S0****
FallBackContent	string	任意	カスタムフォールバックコンテンツです。このパラメーターは Alibaba Cloud International Site（alibabacloud.com）でのみ利用可能です。	Fallback SMS
IsvCode `deprecated`	string	任意	非推奨。 ISV（Independent Software Vendor）検証コードで、サブアカウントが ISV によって承認されているかどうかを検証するために使用されます。このパラメーターは無視できます。	123123******
CustSpaceId	string	任意	スペース ID です。ISV の場合、これはサブ顧客のスペース ID です。直接契約のお客様の場合、これはインスタンス ID です。この ID は、チャネル管理ページで確認できます。	cams-8c8*********
ContextMessageId	string	任意	返信対象のメッセージ ID です。これは、以前に送信または受信したメッセージの ID です。	61851ccb2f1365b16aee****
TrackingData	string	任意	返信対象のメッセージ ID です。	Tracking Data
Label	string	任意	Viber メッセージ用のカスタムトラッキングデータです。このパラメーターは Alibaba Cloud International Site（alibabacloud.com）でのみ利用可能です。 promotion: マーケティングまたはプロモーションメッセージ。 transaction: 通知メッセージ。	promotion
Ttl	integer	任意	Viber メッセージタイプです。このパラメーターは Alibaba Cloud International Site（alibabacloud.com）でのみ利用可能です。有効な値は以下のとおりです。	50
Tag	string	任意	Viber メッセージの生存時間（TTL）期間（秒単位）です。このパラメーターは Alibaba Cloud International Site（alibabacloud.com）でのみ利用可能です。値は 30 ～ 1209600 の整数である必要があります。	tag
TaskId	string	任意	Viber メッセージ用のカスタムタグです。	10000****
FallBackDuration	integer	任意	カスタムタスク ID です。	120
ProductAction	object	任意	製品情報です。このパラメーターは WhatsApp チャネルのみで使用可能です。Meta にアップロードした製品情報を指定します。
ThumbnailProductRetailerId	string	任意	製品カタログの ID です。ListProductCatalog API から取得できます。	skkks99****
Sections	array<object>	任意	製品カテゴリのリストです。リストには最大 10 個のカテゴリと 30 個の製品を含めることができます。
	array<object>	任意	製品カテゴリです。
Title	string	任意	カテゴリ名です。チャネル管理 > 管理 > カタログ管理 > 製品管理ページで確認するか、~~2557786~~ API から取得できます。	abcd
ProductItems	array<object>	任意	製品のリストです。
	object	任意	製品情報です。
ProductRetailerId	string	任意	製品 ID です。チャネル管理>管理>カタログ管理>製品管理ページで確認するか、~~ListProduct~~ API を呼び出して取得できます。	ksi3****
FallBackRule	string	任意	フォールバックルールです。このパラメーターは国際サイト向けです。中国サイトをご利用の場合は、このパラメーターは無視してください。有効な値は以下のとおりです。 undelivered: メッセージがエンドポイントに配信できない場合にフォールバックします。この場合、メッセージ送信時にテンプレートおよびパラメーターが承認済みである必要があります。システムでは、ブロックされたテンプレートや電話番号のチェックは行いません。このパラメーターの値が空の場合、デフォルトでこのルールが適用されます。 sentFailed: テンプレートやテンプレート変数などのパラメーターの検証に失敗した場合にフォールバックします。`channelType`、`type`、`messageType`、`to`、`from`（存在の有無）パラメーターのみが厳密に検証されます。	undelivered
FlowAction	object	任意	フローメッセージオブジェクトです。
FlowActionData	object	任意	デフォルトのフローパラメーターのコレクションです。
	any	任意	デフォルトのフローパラメーターです。キーと値の形式で指定します。キーはパラメーター名、値はパラメーターの値です。	{ "name": "name" }
FlowToken	string	任意	カスタムフロートークンです。	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 直接送信のメッセージタイプです。	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.

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

変更履歴

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