署名設定一覧の取得

現在のビジネス配下のすべての署名設定の一覧を取得します。署名名、審査ステータス、紐付くテンプレート数などを含む一覧が返されます。

リクエストURL

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

呼び出し認証

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

リクエスト例

リクエストヘッダー

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

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

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

リクエストボディ

なし

リクエストパラメータ

なし

レスポンスパラメータ

成功レスポンス

HTTPステータスコードは200で、レスポンスボディは署名設定の配列です。

フィールド	型	説明
sign_id	String	署名ID
sign_name	String	署名名
status	Integer	ステータス：1-審査待ち、2-承認済み、3-却下
related_template_count	Integer	紐付くテンプレート数
audit_remark	String	審査の備考
created_time	Integer	作成時刻（Unixタイムスタンプ）
updated_time	Integer	更新時刻（Unixタイムスタンプ）

成功例

[ { "sign_id": "987654321", "sign_name": "Company Name", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 } ]

              
              [
  {
    "sign_id": "987654321",
    "sign_name": "Company Name",
    "status": 2,
    "related_template_count": 5,
    "audit_remark": "",
    "created_time": 1699000000,
    "updated_time": 1699000000
  }
]

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

エラーレスポンス

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

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

エラー例

{ "code": 500, "message": "Internal server error" }

              
              {
  "code": 500,
  "message": "Internal server error"
}

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

エラーコード

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

付録

署名設定のステータス（status）

値	説明
1	審査待ち
2	承認済み
3	却下