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

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

操作説明

QPS 制限

この操作の QPS 制限は、1 ユーザーあたり 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 顧客 WABA ID。説明このパラメーターは非推奨です。代わりに CustSpaceId を使用してください。	65921621816****
IsvCode `deprecated`	string	任意	サブアカウントが ISV により承認されているかどうかを確認するために使用される ISV 確認コード。	skdi3kksloslikdkkdk
CustSpaceId	string	任意	ISV サブ顧客のスペース ID、または直接顧客のインスタンス ID。	28251486512358****
TemplateType	string	任意	テンプレートタイプ。有効な値: WHATSAPP VIBER	WHATSAPP
TemplateName	string	任意	テンプレート名。	test_name

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
RequestId	string	リクエスト ID。	744c4b5c79c9432497a075bdfca3****
Code	string	リクエスト状態コード。 OK はリクエストが成功したことを示します。その他のエラーコードについては、「エラーコード」を参照してください。	OK
Message	string	エラーメッセージ。	指定されたリソースを操作する権限がありません (レート)
Data	object	応答データ。	{ "カテゴリ": "ACCOUNT_UPDATE", "name": "アカウント通知", "language": "en_US", "テンプレートコード": "744c4b5c79c9432497a075bdfca3**", "auditStatus": "APPROVED", "コンポーネント": "[{\"type\":\"本文\",\"text\":\"本文テキスト$(textVariable)\"},{\"type\":\"HEADER\",\"フォーマット\":\"IMAGE\",\"url\":\"$(linkVariable)\"},{\"type\":\"フッター\",\"text\":\"フッターテキスト\"},{\"type\":\"ボタン\",\"ボタン\":[{\"type\":\"PHONE_NUMBER\",\"text\":\"電話ボタンテキスト\",\"phone_number\":\"+861388888**\"},{\"type\":\"URL\",\"text\":\"URLボタンテキスト\",\"url\":\"https://www.website.com/\"}]}]", "example": "{\"textVariable\": \"text\", \"linkVariable\": \"link\"}" }
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":"text","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 コンポーネントは最大 1,024 文字に対応しています。HEADER および FOOTER コンポーネントは、それぞれ最大 60 文字に対応しています。 Viber テンプレートの場合、FOOTER、CAROUSEL、および LIMITED_TIME_OFFER はサポートされていません。 Viber テンプレートの場合、イメージ、動画、およびファイルは HEADER コンポーネントに配置されます (端末ではテキストの下にイメージが表示されます)。	BODY
Url	string	メディアリソースパス。	https://イメージ.developer.aliyundoc.com
Text	string	送信するメッセージのテキスト。	hello
Caption	string	ファイルの説明。	example
FileName	string	ファイル名。	example
Format	string	フォーマット。	TEXT
Buttons	array<object>	ボタンのリスト。BUTTONS コンポーネントにのみ適用されます。説明 WhatsApp ボタン数のルール: MARKETING または UTILITY テンプレートの場合、最大 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	WhatsApp がアプリを起動するために使用する署名ハッシュ。カテゴリが Authentication に設定され、ボタンタイプが ONE_TAP に設定されている WhatsApp テンプレートに必須です。	2993839
PackageName	string	WhatsApp が起動するアプリのパッケージ名。カテゴリが Authentication に設定され、ボタンタイプが ONE_TAP に設定されている WhatsApp テンプレートに必須です。	com.aliyun
AutofillText	string	WhatsApp の自動入力操作のボタンテキスト。カテゴリが Authentication にセットされ、ボタンタイプが ONE_TAP にセットされている 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 メッセージにのみ有効です (フッターに表示されます)。	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 アドレス。	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: 静的 URL。 dynamic: 動的 URL。	静的
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": "指定されたリソースを操作する権限がありません。",
  "Data": {
    "Category": "UTILITY",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"テキスト\\\",\\\"linkVariable\\\":\\\"https://イメージ.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://イメージ.developer.aliyundoc.com",
        "Text": "hello",
        "Caption": "example",
        "FileName": "example",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "example",
            "PhoneNumber": "+861398745****",
            "Url": "https://example.com",
            "UrlType": "静的",
            "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.

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

変更履歴

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