SendChatappMessage - - Alibaba Cloud ドキュメントセンター

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

操作説明

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

QPS 制限

この API の単一ユーザーに対する 1 秒あたりのクエリ数 (QPS) 制限は 250 です。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。適切なレートで 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

*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 に設定されている場合のメッセージの具体的なタイプ。有効な値: text: プレーンテキストメッセージ。このパラメーターを text に設定した場合、Content フィールドの Text パラメーターが必須です。 image: イメージメッセージ。このパラメーターを image に設定した場合、Content フィールドの Link パラメーターが必須で、Caption パラメーターはオプションです。 video: ビデオメッセージ。このパラメーターを video に設定した場合、Content フィールドの Link パラメーターが必須で、Caption パラメーターはオプションです。 audio: オーディオメッセージ。このパラメーターを audio に設定した場合、Content フィールドの Link パラメーターが必須で、Caption パラメーターは無効です。 document: ドキュメントメッセージ。このパラメーターを document に設定した場合、Content フィールドの Link および FileName パラメーターが必須で、Caption パラメーターは無効です。	text
TemplateCode	string	任意	テンプレートコード。[チャンネル管理] > [管理] > [テンプレートデザイン] ページでテンプレートコードを表示できます。	1119***************
Language	string	任意	言語。言語コードのリストについては、「言語コード」をご参照ください。	en
From	string	必須	送信者番号。 ChannelType が whatsapp の場合、これは WhatsApp に登録され、アタッチされた電話番号です。番号は [チャンネル管理] > [管理] > [WABA 管理] > [電話番号管理] ページで表示できます。 ChannelType が messenger の場合、これはページ ID です。ID は [チャンネル管理] > [管理] > [Facebook ページ] ページで表示できます。 ChannelType が instagram の場合、これは Instagram プロフェッショナルアカウント ID です。ID は [チャンネル管理] > [管理] > [プロフェッショナルアカウント] ページで表示できます。 ChannelType が viber の場合、これは Viber サービス ID です。ID は [チャンネル管理] > [管理] > [サービス ID 管理] ページで表示できます。	861387777****
To	string	必須	受信者番号。 ChannelType が whatsapp の場合、これは受信者の電話番号です。 ChannelType が messenger の場合、これはユーザーが Facebook ページとやり取りしたときに生成されるページスコープユーザー ID (PSID) です。 ChannelType が instagram の場合、これはユーザーが Instagram ビジネスアカウントまたはクリエイターアカウントとやり取りしたときに生成される Instagram ユーザー ID です。 ChannelType が viber の場合、これは受信者の電話番号です。	861388988****
TemplateParams	object	任意	テンプレートパラメーターのコレクション。
	string	任意	テンプレートパラメーター。これはキーと値のペアで、キーはパラメーター名、値はパラメーター値です。	{ "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。このパラメーターは非推奨です。直接の顧客のインスタンス ID である CustSpaceId を使用してください。ID は [チャンネル管理] ページで表示できます。	cams-8c8*********
FallBackId	string	任意	フォールバック戦略 ID。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。[フォールバック戦略] ページで戦略 ID を表示できます。	S0****
FallBackContent	string	任意	カスタムフォールバックコンテンツ。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。	Fallback SMS
IsvCode `deprecated`	string	任意	ISV 検証コード。RAM ユーザーが ISV によって承認されているかどうかを検証するために使用されます。このパラメーターは非推奨であり、無視できます。	123123******
CustSpaceId	string	任意	ISV サブ顧客の SpaceId。これは直接の顧客のインスタンス ID です。ID は [チャンネル管理] ページで表示できます。	cams-8c8*********
ContextMessageId	string	任意	返信するメッセージの ID。これは、送信または受信されたメッセージの ID を指します。	61851ccb2f1365b16aee****
TrackingData	string	任意	Viber メッセージのカスタム追跡データ。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。	Tracking Data
Label	string	任意	Viber メッセージタイプ。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。有効な値: promotion: マーケティングまたはプロモーションメッセージ。 transaction: 通知メッセージ。	promotion
Ttl	integer	任意	Viber メッセージを送信するためのタイムアウト期間。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。単位: 秒。有効な値: 30～1209600。	50
Tag	string	任意	タグ情報。これは Viber メッセージを送信するためのカスタムタグです。	tag
TaskId	string	任意	カスタムタスク ID。	10000****
FallBackDuration	integer	任意	フォールバックトリガー時間。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。指定された時間内にメッセージの配信レシートが返されない場合、フォールバックがトリガーされます。このパラメーターを空のままにすると、メッセージの送信に失敗した場合、または失敗した配信レポートが受信された場合にのみフォールバックがトリガーされます。単位: 秒。最小値: 60。最大値: 43200。	120
ProductAction	object	任意	製品情報。このパラメーターは WhatsApp チャンネル専用です。Meta にアップロードした製品情報を指します。
ThumbnailProductRetailerId	string	任意	製品カタログ ID。ListProductCatalog API を呼び出すことで取得できます。	skkks99****
Sections	array<object>	任意	製品カテゴリのリスト。最大 10 個のカテゴリと 30 個の製品を持つことができます。
	array<object>	任意	製品カテゴリ。
Title	string	任意	カテゴリ名。名前は [チャンネル管理] > [管理] > [カタログ管理] > [製品管理] ページで表示するか、ListProduct API を呼び出すことで取得できます。	abcd
ProductItems	array<object>	任意	製品情報のリスト。
	object	任意	製品情報。
ProductRetailerId	string	任意	製品 ID。ID は [チャンネル管理] > [管理] > [カタログ管理] > [製品管理] ページで表示するか、ListProduct API を呼び出すことで取得できます。	ksi3****
FallBackRule	string	任意	フォールバックルール。このパラメーターは Alibaba Cloud 国際サイト向けです。Alibaba Cloud 中国サイトのユーザーはこのパラメーターを無視できます。有効な値: undelivered: メッセージが受信者に配信できない場合にフォールバックがトリガーされます。メッセージを送信するには、テンプレートとパラメーターが有効である必要があります。禁止されたテンプレートやブロックされた電話番号などのシナリオはチェックされません。パラメーターが空の場合、これがデフォルトのルールです。 sentFailed: メッセージがテンプレートまたはテンプレート変数のパラメーター検証に失敗した場合にフォールバックがトリガーされます。channelType、type、messageType、to、および from (存在) パラメーターのみが厳密に検証されます。	undelivered
FlowAction	object	任意	Flow メッセージオブジェクト。
FlowToken	string	任意	カスタムフロートークン情報。	kde****
FlowActionData	object	任意	デフォルトのフローパラメーターのコレクション。
	string	任意	デフォルトのフローパラメーター。これはキーと値のペアで、キーはパラメーター名、値はパラメーター値です。	{ "name": "name" }
TemplateName	string	任意	テンプレート名。[チャンネル管理] > [管理] > [テンプレートデザイン] ページでテンプレート名を表示できます。	test_name

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "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.

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

変更履歴

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