メッセージテンプレートを変更します。変更済みできるのは、審査未完了または審査に失敗したテンプレートのみです。
操作説明
QPS 制限
この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。この制限を超えると、API の呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。必要に応じてこの操作を呼び出してください。
ステータスの変更
MNS または HTTP を通じて、テンプレートのステータスと品質のフォーマットをモニターできます。詳細については、「受信確認メッセージ」を参照してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:ModifyChatappTemplate |
update |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Components |
array<object> |
必須 |
メッセージテンプレートコンポーネントのリスト。 説明
Category が AUTHENTICATION の場合、Components に Type が HEADER に設定されたノードを含めることはできません。Type が BODY/FOOTER の場合、Text コンテンツは空となり、自動的に生成されます。 |
|
|
array<object> |
任意 |
メッセージテンプレートコンポーネント。 |
||
| HasExpiration |
boolean |
任意 |
クーポンコードに有効期間があるかどうかを指定します。このパラメーターは、type が LIMITED_TIME_OFFER の場合に使用します。 |
true |
| ThumbUrl |
string |
任意 |
有効なフィールドではありません。 |
https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100 |
| FileName |
string |
任意 |
ファイル名。 説明
Type が HEADER で Format が DOCUMENT の場合にファイル名を指定します。 |
video |
| Text |
string |
任意 |
送信するメッセージのテキスト。 説明
Category が AUTHENTICATION の場合、このプロパティ値は空です。 |
hello chatapp |
| Duration |
integer |
任意 |
有効なフィールドではありません。 |
120 |
| Url |
string |
任意 |
メディアリソースのパス。 |
https://img.****.com/png_preview/00/10/24/1GygxVK3F4.jpg |
| Caption |
string |
任意 |
説明。 説明
Type が HEADER で Format が IMAGE/DOCUMENT/VIDEO の場合に説明を追加できます。 |
This is a video |
| AddSecretRecommendation |
boolean |
任意 |
Category が AUTHENTICATION で Component Type が Body の WhatsApp テンプレートで有効です。本文の上部に、確認コードを他人と共有しないよう促すプロンプトを表示します。 |
false |
| Type |
string |
必須 |
コンポーネントのタイプ。
説明
|
BODY |
| Format |
string |
任意 |
メディアのリソースタイプ。
|
TEXT |
| CodeExpirationMinutes |
integer |
任意 |
WhatsApp AUTHENTICATION テンプレートの確認コードの有効期間 (分単位)。Category が AUTHENTICATION で Component Type が Footer の WhatsApp メッセージでのみ有効です。この情報はフッター位置に表示されます。 |
5 |
| FileType |
string |
任意 |
有効なフィールドではありません。 |
docx |
| Buttons |
array<object> |
任意 |
ボタンのリスト。BUTTONS コンポーネントにのみ適用されます。 説明
WhatsApp ボタン数量ルール:
|
|
|
array<object> |
任意 |
ボタンの定義。 |
||
| AutofillText |
string |
任意 |
Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須です。WhatsApp オートフィル操作のボタンテキスト。 |
Autofill |
PackageName
deprecated
|
string |
任意 |
代わりに SupportedApps の下のプロパティを使用してください。 |
com.demo |
| Text |
string |
任意 |
ボタンのテキスト。 |
phone-button-text |
| Url |
string |
任意 |
ボタンがクリックされたときにアクセスする URL。 |
https://www.website.com/*** |
| FlowId |
string |
任意 |
フロー ID。 |
664597077870605 |
| Type |
string |
必須 |
ボタンのタイプ。
説明
|
PHONE_NUMBER |
| CouponCode |
string |
任意 |
クーポンコードの値。英数字のみサポートされています。$(couponCode) のような変数を渡すことができ、メッセージ送信時に実際のクーポンコードを提供します。 |
120293 |
| IsOptOut |
boolean |
任意 |
Category が Marketing で Button type が QUICK_REPLY の WhatsApp テンプレートで有効です。ボタンがマーケティングオプトアウトボタンであることを示します。顧客がこのボタンをクリックし、ChatApp で送信コントロールが設定されている場合、その後の Marketing メッセージは顧客に送信されません。 |
false |
| FlowAction |
string |
任意 |
フローデータイベントのタイプ。有効な値:
|
NAVIGATE |
SignatureHash
deprecated
|
string |
任意 |
代わりに SupportedApps の下のプロパティを使用してください。 |
29dkeke |
| NavigateScreen |
string |
任意 |
ナビゲーション画面。FlowAction が NAVIGATE の場合に必須です。 |
DETAILS |
| PhoneNumber |
string |
任意 |
電話番号。 |
+861388888**** |
| SupportedApps |
array<object> |
任意 |
サポートされるアプリケーションのリスト。 |
|
|
object |
任意 |
サポートされるアプリケーションのリスト。 |
||
| SignatureHash |
string |
任意 |
Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須です。WhatsApp が呼び出すアプリケーションの署名ハッシュ値。 |
fk39kd93ks9 |
| PackageName |
string |
任意 |
Category が AUTHENTICATION で Button Type が ONE_TAP/ZERO_TAP の WhatsApp テンプレートで必須です。WhatsApp が呼び出すアプリケーションのパッケージ名。 |
com.example.myapplication |
| UrlType |
string |
任意 |
URL のタイプ。
|
dynamic |
| Cards |
array<object> |
任意 |
カルーセルテンプレートカードのリスト。 |
|
|
array<object> |
任意 |
カルーセルテンプレートカードのリスト。 |
||
| CardComponents |
array<object> |
必須 |
カルーセルカード内のコントロールのリスト。 |
|
|
array<object> |
任意 |
カルーセルカード内のコントロールのリスト。 |
||
| Type |
string |
必須 |
コンポーネントのタイプ。有効な値:
|
BODY |
| Format |
string |
任意 |
メディアのリソースタイプ。Type が HEADER の場合に有効です。
|
IMAGE |
| Text |
string |
任意 |
カルーセルカード内の BODY コンテンツ。 |
Who is the very powerful team |
| Buttons |
array<object> |
任意 |
ボタンのリスト。BUTTONS コンポーネントにのみ適用されます。各カルーセルカードには最大値として 2 つのボタンを設定できます。 |
|
|
object |
任意 |
ボタンオブジェクト。 |
||
| Type |
string |
必須 |
ボタンのタイプ。
|
PHONE_NUMBER |
| PhoneNumber |
string |
任意 |
電話番号。 |
+861368893**** |
| Text |
string |
任意 |
ボタンのテキスト。 |
Call me |
| UrlType |
string |
任意 |
URL のタイプ。
|
静的 |
| Url |
string |
任意 |
ボタンがクリックされたときにアクセスする URL。 |
https://alibaba.com/xx |
| Url |
string |
任意 |
メディアリソースのパス。 |
https://alibaba.com/****/img.png |
| Language |
string |
必須 |
テンプレートの言語。言語コードについては、「言語コード」を参照してください。 |
en |
| Example |
object |
任意 |
テンプレート作成の例。 |
|
|
string |
任意 |
テンプレート作成の例。 |
StringConcat('a', 'b', 'c') |
|
CustWabaId
deprecated
|
string |
任意 |
ISV 顧客の WabaId。 説明
このパラメーターは非推奨です。代わりに CustSpaceId を使用してください。 |
65921621816**** |
IsvCode
deprecated
|
string |
任意 |
サブアカウントが ISV によって承認されているかどうかを確認するために使用される ISV 確認コード。 |
ksiekdki39ksks93939 |
| TemplateCode |
string |
任意 |
メッセージテンプレートコード。 |
8472929283883 |
| CustSpaceId |
string |
任意 |
ISV サブ顧客の SpaceId または直接顧客のインスタンス ID。 |
28251486512358**** |
| Category |
string |
任意 |
テンプレートタイプは変更済みです。 |
text |
| TemplateType |
string |
任意 |
テンプレートタイプ。
|
|
| MessageSendTtlSeconds |
integer |
任意 |
WhatsApp でテンプレートメッセージを送信するための有効期間。
|
120 |
| TemplateName |
string |
任意 |
テンプレート名。 |
test_name |
| CategoryChangePaused |
boolean |
任意 |
Utility テンプレートが Marketing タイプに変更されると、テンプレートの送信が一時停止されます。 |
120 |
|
任意 |
プロダクトセット ID。 |
939*** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
90E63D28-E31D-1EB2-8939-A9486641**** |
| Code |
string |
応答コード。
|
OK |
| Message |
string |
エラーメッセージ。 |
None |
| Data |
object |
返されたデータ。 |
|
| TemplateCode |
string |
テンプレートコード。 |
8472929283883 |
| TemplateName |
string |
テンプレート名。 |
hello_whatsapp |
| AccessDeniedDetail |
string |
アクセス拒否の詳細。 |
None |
| Success |
boolean |
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Code": "OK",
"Message": "None",
"Data": {
"TemplateCode": "8472929283883",
"TemplateName": "hello_whatsapp"
},
"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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。