テンプレート設定の作成

新しいテンプレート設定を作成します。テンプレート名、種別、内容、主な配信先国、署名情報の設定に対応します。作成後、テンプレートのステータスは「審査待ち」となり、審査を通過してはじめて使用できます。

リクエストURL

POST https://smsapi.engagelab.com/v1/template-configs

呼び出し認証

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

リクエスト例

リクエストヘッダー

              
              POST /v1/template-configs  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で、レスポンスボディには次のフィールドが含まれます。

成功例

              
              {
  "template_id": "123456789"
}

            

エラーレスポンス

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

エラー例

              
              {
  "code": 400,
  "message": "sign status is not approved, can not use"
}

            

エラーコード

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

• sign config not exist：署名設定が存在しません
• sign status is not approved, can not use：署名のステータスが承認済みでないため、使用できません
• template config not exist：テンプレート設定が存在しません
• ip forbidden：IP が許可リストに含まれていません
• not correct parameter format：リクエストの JSON 形式が不正です

注意事項

1. 作成後、テンプレートのステータスは「審査待ち」（status=1）となり、審査を通過してはじめてSMSの送信に使用できます。
2. 署名を追加する場合、その署名は承認済みのステータスである必要があります。
3. テンプレート内容には禁止文字を含めることはできません：【、】、、、测试、test、[、]
4. テンプレートIDと署名IDはいずれも文字列型の数値です。

付録

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

テンプレート種別（template_type）

レガシー値 otp は互換性のため authentication にマッピングされます。認証種別のテンプレート内容は {{code}} を必ず含み、サポートする変数は {{code}}、{{ttl}} の 2 つのみです。

署名の位置（sign_position）