署名設定の作成

新しい署名設定（Sender ID）を作成し、SMSメッセージに送信者の身元を表示します。作成後、署名のステータスは「審査待ち」となり、審査を通過してはじめて使用できます。

リクエストURL

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

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

POST /v1/sign-configs HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              POST /v1/sign-configs  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

このコードブロックはフローティングウィンドウ内に表示されます

{ "sign_name": "Company Name" }

              
              {
  "sign_name": "Company Name"
}

このコードブロックはフローティングウィンドウ内に表示されます

パラメータ	型	区分	説明
sign_name	String	必須	署名名。長さ2〜60文字。次の文字は使用不可：`【`、`】`、`[`、`]`

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

フィールド	型	説明
sign_id	String	作成された署名ID

成功例

{ "sign_id": "987654321" }

              
              {
  "sign_id": "987654321"
}

このコードブロックはフローティングウィンドウ内に表示されます

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

フィールド	型	説明
code	Integer	エラーコード
message	String	エラーの詳細

エラー例

{ "code": 400, "message": "sign_name already exist" }

              
              {
  "code": 400,
  "message": "sign_name already exist"
}

このコードブロックはフローティングウィンドウ内に表示されます

エラーコード	HTTPコード	説明
400	400	パラメータエラーまたは業務ロジックエラー
500	500	サーバー内部エラー

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