テンプレート設定の更新

既存のテンプレート設定を更新し、テンプレート名、種別、内容、配信先国、署名情報の変更に対応します。更新後、テンプレートのステータスは「審査待ち」に戻ります。

リクエストURL

PUT https://smsapi.engagelab.com/v1/template-configs/:templateId

呼び出し認証

APIリクエストの認証方法については、呼び出し認証を参照してください。

リクエスト例

リクエストヘッダー

              
              PUT /v1/template-configs/123456789  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

リクエストボディ

              
              {
  "template_name": "Order Notification Template",
  "template_type": "utility",
  "template_content": "Your order {order_no} has been shipped and is expected to be delivered by {delivery_time}",
  "country_codes": "CN,US",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

            

リクエストパラメータ

パスパラメータ

リクエストボディパラメータ

レスポンスパラメータ

成功レスポンス

HTTPステータスコードは200で、レスポンスボディには次のフィールドが含まれます。

成功例

              
              {
  "code": 0,
  "message": "success"
}

            

エラーレスポンス

HTTPステータスコードは4xx/5xxで、レスポンスボディには次のフィールドが含まれます。

エラー例

              
              {
  "code": 400,
  "message": "can not update pending status template"
}

            

エラーコード

よくあるエラーメッセージ：

• invalid templateId：テンプレートIDの形式エラー
• template config not exist：テンプレート設定が存在しません
• can not update pending status template：審査待ちステータスのテンプレートは更新できません
• there are pending or running plans using current template, can not update：このテンプレートを使用している審査待ちまたは実行中のプランがあるため、更新できません
• sign config not exist：署名設定が存在しません
• sign status is not approved, can not use：署名のステータスが承認済みでないため、使用できません

注意事項

1. 「審査待ち」ステータスのテンプレートは更新できません。
2. このテンプレートを使用している審査待ちまたは実行中のメッセージプランがある場合は、更新できません。
3. 更新後、テンプレートのステータスは「審査待ち」（status=1）に戻ります。
4. 署名を追加する場合、その署名は承認済みのステータスである必要があります。
5. テンプレート内容には禁止文字を含めることはできません：【、】、、、测试、test、[、]
6. テンプレートIDと署名IDはいずれも文字列型の数値です。

付録

テンプレート設定のステータス（status）

テンプレート種別（template_type）

署名の位置（sign_position）