GetChatappTemplateDetail でメッセージテンプレートの詳細をクエリ - Chat App Message Service - Alibaba Cloud -

Chat App Message サービスのメッセージテンプレートの詳細を取得します。

操作説明

QPS 制限

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

今すぐお試しください

この 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:GetChatappTemplateDetail

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TemplateCode	string	任意	テンプレートのコード。	****4b5c79c9432497a075bdfca36bf5
Language	string	必須	テンプレートの言語。言語コードの詳細については、「言語コード」を参照してください。	en_US
CustWabaId `deprecated`	string	任意	ISV 顧客の WabaId。説明非推奨のパラメーターです。代わりに CustSpaceId を使用してください。	65921621816****
IsvCode `deprecated`	string	任意	ISV 検証コード。サブアカウントが ISV によって承認されているかどうかを検証するために使用されます。	skdi3kksloslikdkkdk
CustSpaceId	string	任意	ISV サブ顧客の SpaceId、または直接顧客のインスタンス ID。	28251486512358****
TemplateType	string	任意	テンプレートタイプ。有効な値: WHATSAPP VIBER	WHATSAPP
TemplateName	string	任意	テンプレートの名前。	test_name

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
RequestId	string	リクエスト ID。	744c4b5c79c9432497a075bdfca3****
Code	string	リクエスト状態コード。 OK は、リクエストが成功したことを示します。その他のエラーコードについては、「エラーコード」を参照してください。	OK
Message	string	エラーメッセージ。	指定されたリソースを操作する権限がありません。
Data	object	返されたデータ。	{ "category": "ACCOUNT_UPDATE", "name": "アカウント通知", "language": "en_US", "templateCode": "744c4b5c79c9432497a075bdfca3**", "auditStatus": "APPROVED", "components": "[{\"type\":\"BODY\",\"text\":\"本文テキスト$(textVariable)\"},{\"type\":\"HEADER\",\"formate\":\"IMAGE\",\"url\":\"$(linkVariable)\"},{\"type\":\"FOOTER\",\"text\":\"フッターテキスト\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"電話番号ボタンテキスト\",\"phone_number\":\"+861388888**\"},{\"type\":\"URL\",\"text\":\"URLボタンテキスト\",\"url\":\"https://www.website.com/\"}]}]", "example": "{\"textVariable\": \"テキスト\", \"linkVariable\": \"リンク\"}" }
Category	string	WhatsApp テンプレートのカテゴリ。有効な値: UTILITY: トランザクション関連。 MARKETING: マーケティングテンプレート。 AUTHENTICATION: 本人確認。 Viber テンプレートのカテゴリ。有効な値: UTILITY: トランザクション関連。 MARKETING: マーケティングテンプレート。 AUTHENTICATION: 本人確認。	UTILITY
TemplateCode	string	テンプレートのコード。	744c4b5c79c9432497a075bdfca3****
Name	string	テンプレートの名前。	hello_whatsapp
Language	string	テンプレートの言語。言語コードの詳細については、「言語コード」を参照してください。	en_US
Example	object	変数の例。
	string	テンプレート変数に対応する実際の値。パラメーターは JSON フォーマットです。	{\"textVariable\":\"テキスト\",\"linkVariable\":\"https://イメージ.developer.aliy\"}
AuditStatus	string	審査ステータス。有効な値: pass: 承認済み。 fail: 却下。 auditing: 審査中。 unaudit: 審査保留。	pass
Components	array<object>	メッセージテンプレートコンポーネントのリスト。
	array<object>	メッセージテンプレートコンポーネント。
Type	string	コンポーネントタイプ。 BODY HEADER FOOTER BUTTONS CAROUSEL LIMITED_TIME_OFFER 説明 WhatsApp テンプレートの場合、BODY コンポーネントは 1024 文字を超えることはできません。HEADER および FOOTER コンポーネントは 60 文字を超えることはできません。 Viber テンプレートの場合、FOOTER、CAROUSEL、および LIMITED_TIME_OFFER タイプは無効です。 Viber テンプレートの場合、イメージ、動画、およびファイルは HEADER に配置されます (デバイスではテキストの下にイメージが表示されます)。	BODY
Url	string	素材の URL。	https://イメージ.developer.aliyundoc.com
Text	string	送信するメッセージのテキスト。	hello
Caption	string	ファイルの説明。	example
FileName	string	ファイル名。	example
Format	string	フォーマット。	TEXT
Buttons	array<object>	ボタンのリスト。BUTTONS コンポーネントにのみ適用されます。説明 WhatsApp ボタン数量ルール: カテゴリが MARKETING または UTILITY にセットされている WhatsApp テンプレートの場合、最大値 10 個のボタンが許可されます。 PHONE_NUMBER ボタンは 1 つのみ許可されます。 URL ボタンは最大値 2 つまで許可されます。 QUICK_REPLY ボタンを PHONE_NUMBER または URL ボタンとランダムな順序で混在させることはできません。
	array<object>	コンポーネントのリスト。
Type	string	ボタンタイプ。 PHONE_NUMBER: 電話呼び出しボタン。 URL: Web ページボタン。 QUICK_REPLY: クイックリプライボタン。 COPY_CODE: 認証コードまたはクーポンコードのコピー。 ONE_TAP: AUTHENTICATION テンプレート用の自動入力ボタン。 ZERO_TAP: AUTHENTICATION テンプレート用の自動入力ボタン。 MPM: 複数製品カタログ。 CATALOG: カタログ。 FLOW: WhatsApp フローを開く。説明カテゴリが AUTHENTICATION にセットされている WhatsApp テンプレートの場合、ボタンは 1 つのみ許可され、タイプは COPY_CODE または ONE_TAP のみとなります。タイプが COPY_CODE の場合、Text は必須です。タイプが ONE_TAP の場合、Text (対象アプリケーションがデバイスにインストールされていない場合に表示される、認証コードコピーボタンの名前)、SignatureHash、PackageName、および AutofillText が必須です。 Viber テンプレートではボタンは 1 つのみ許可され、URL タイプである必要があります。	PHONE_NUMBER
Text	string	ボタンの表示名。	example
PhoneNumber	string	電話番号。ボタンタイプが PHONE_NUMBER の場合にのみ有効です。	+861398745****
Url	string	リンクボタンがクリックされたときにアクセスされる URL。	https://example.com
UrlType	string	URL タイプ。 static: 静的。 dynamic: 動的。	静的
SignatureHash	string	カテゴリが Authentication でボタンタイプが ONE_TAP に設定されている WhatsApp テンプレートに必須です。WhatsApp がアプリケーションを起動するための署名ハッシュ値を指定します。	2993839
PackageName	string	カテゴリが Authentication でボタンタイプが ONE_TAP に設定されている WhatsApp テンプレートに必須です。WhatsApp がアプリケーションを起動するためのパッケージ名を指定します。	com.aliyun
AutofillText	string	カテゴリが Authentication でボタンタイプが ONE_TAP に設定されている WhatsApp テンプレートに必須です。WhatsApp 自動入力操作のボタンテキストを指定します。	Autofill
IsOptOut	boolean	カテゴリが Marketing でボタンタイプが QUICK_REPLY にセットされている WhatsApp テンプレートで有効です。ボタンがマーケティングオプトアウトボタンであることを示します。顧客がこのボタンをクリックし、Chat App Message サービスプラットフォームで送信コントロール操作が設定されている場合、その後のマーケティングメッセージは顧客に送信されません。	false
ExtendAttrs	object	拡張フィールド。
NextTemplateCode	string	次のテンプレートコード。	20939920093993
NextTemplateName	string	次のテンプレート名。	abc
NextLanguageCode	string	次のテンプレート言語。	en
Action	string	イベントタイプ。	nextCard
IntentCode	string	意図コード。	test
CouponCode	string	クーポンコード。	202039ksjs
FlowId	string	フロー ID。	3838292983
FlowAction	string	フローデータイベントタイプ。有効な値: NAVIGATE: ナビゲーション。 DATA_EXCHANGE: データ交換。	NAVIGATE
NavigateScreen	string	ナビゲーション画面。FlowAction が NAVIGATE に設定されている場合に必須です。	DETAILS
SupportedApps	array<object>	ONE_TAP/ZERO_TAP 認証コードでサポートされるアプリケーション。
	object	ONE_TAP/ZERO_TAP 認証コードでサポートされるアプリケーション。
SignatureHash	string	パッケージ署名ハッシュ。	29kdkeik939
PackageName	string	パッケージ名。	com.test
ThumbUrl	string	Viber 動画メッセージのサムネイル。	https://img.png
Duration	integer	Viber 動画メッセージの動画の持続時間。有効な値: 0～600。	50
FileType	string	Viber ファイルメッセージのファイルタイプ。	docx
Latitude	string	位置情報の緯度。	28.001
Longitude	string	位置情報の経度。	120.002
LocationName	string	場所の名前。	hangzhou
LocationAddress	string	場所の住所。	hangzhou
AddSecretRecommendation	boolean	カテゴリが認証でコンポーネントタイプが本文の場合に有効な WhatsApp テンプレート。確認コードを共有しないようユーザーに助言するセキュリティ推奨メッセージが本文の上に表示されるかどうかを示します。	false
CodeExpirationMinutes	integer	WhatsApp 認証テンプレートの検証コードの有効期間（分単位）。メッセージタイプが WhatsApp、カテゴリが Authentication、コンポーネントタイプが Footer の場合にのみ有効です。この情報はフッター位置に表示されます。	5
hasExpiration	boolean	期間限定オファー (LTO) テンプレートにおいてオファーコードに有効期限があるかどうかを指定します。時間。	true
OfferExpirationTimeMs	string	期間限定オファー (LTO) テンプレートにおけるオファーコードの有効期限変数。	$(offerExpirationTimeMs)
Cards	array<object>	カルーセルカードのリスト。
	array<object>	カルーセルテンプレートカードのリスト。
CardComponents	array<object>	カードコンポーネントのリスト。
	array<object>	カルーセルカード内のコンポーネントのリスト。
Type	string	コンポーネントタイプ。	HEADER
Text	string	カードのテキストコンテンツ。	Body
Url	string	Web URL。	https://aliyun.com
Format	string	カルーセルテンプレートにおけるヘッダータイプ。IMAGE と VIDEO のみがサポートされています。すべてのカードで同じヘッダータイプを使用する必要があります。	HEADER
Buttons	array<object>	カードボタンのリスト。
	object	ボタンオブジェクト。
Type	string	カルーセルテンプレートのボタンタイプ。有効な値: URL、PHONE_NUMBER、または QUICK_REPLY。	URL
Text	string	ボタンの内容。	example
Url	string	ボタンクリック時にアクセスする URL。	https://aliyun.com
UrlType	string	URL タイプ。有効な値: static: 静的。 dynamic: 動的。	static
PhoneNumber	string	電話番号。	+861380005****
TemplateType	string	テンプレートタイプ。 WHATSAPP VIBER	WHATSAPP
QualityScore	string	テンプレートの品質。 RED: 低品質。 YELLOW: 中品質。 UNKNOWN: 品質不明。 GREEN: 高品質。	GREEN
MessageSendTtlSeconds	integer	WhatsApp 認証テンプレートメッセージ送信時のメッセージの有効期間。時間。	120
Reason	string	テンプレート審査拒否の理由。	None
CategoryChangePaused	boolean	ユーティリティテンプレートがマーケティングテンプレートに変更された際にテンプレートの送信が一時停止されているかどうかを示します。	true
AllowSend	boolean	現在のテンプレートを送信に使用できるかどうかを示します。このパラメーターはマーケティングテンプレートにのみ有効です。	true
ProductSetId	string	プロダクトセット ID。	939***
AccessDeniedDetail	string	アクセス拒否の詳細情報。フォーマット。	None
Success	boolean		true

例

成功レスポンス

JSONJSON

{
  "RequestId": "744c4b5c79c9432497a075bdfca3****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "Category": "UTILITY",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://image.developer.aliyundoc.com",
        "Text": "hello",
        "Caption": "example",
        "FileName": "example",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "example",
            "PhoneNumber": "+861398745****",
            "Url": "https://example.com\n",
            "UrlType": "static",
            "SignatureHash": "2993839",
            "PackageName": "com.aliyun",
            "AutofillText": "Autofill",
            "IsOptOut": false,
            "ExtendAttrs": {
              "NextTemplateCode": "20939920093993",
              "NextTemplateName": "abc",
              "NextLanguageCode": "en",
              "Action": "nextCard",
              "IntentCode": "test"
            },
            "CouponCode": "202039ksjs",
            "FlowId": "3838292983",
            "FlowAction": "NAVIGATE",
            "NavigateScreen": "DETAILS",
            "SupportedApps": [
              {
                "SignatureHash": "29kdkeik939",
                "PackageName": "com.test"
              }
            ]
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx",
        "Latitude": "28.001",
        "Longitude": "120.002",
        "LocationName": "hangzhou",
        "LocationAddress": "hangzhou",
        "AddSecretRecommendation": false,
        "CodeExpirationMinutes": 5,
        "hasExpiration": true,
        "OfferExpirationTimeMs": "$(offerExpirationTimeMs)",
        "Cards": [
          {
            "CardComponents": [
              {
                "Type": "HEADER",
                "Text": "Body",
                "Url": "https://aliyun.com",
                "Format": "HEADER",
                "Buttons": [
                  {
                    "Type": "URL",
                    "Text": "example",
                    "Url": "https://aliyun.com",
                    "UrlType": "static",
                    "PhoneNumber": "+861380005****"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "TemplateType": "WHATSAPP",
    "QualityScore": "GREEN",
    "MessageSendTtlSeconds": 120,
    "Reason": "None",
    "CategoryChangePaused": true,
    "AllowSend": true,
    "ProductSetId": "939***"
  },
  "AccessDeniedDetail": "None",
  "Success": true
}

エラーコード

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.

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

変更履歴

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