Logo Site EngageLab Mark Colored Transparent文档
搜索

获取签名配置列表

获取当前业务下的所有签名配置列表,返回包含签名名称、审核状态、关联模板数量等信息的列表。

调用地址

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": "公司名称", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 } ]
              
              [
  {
    "sign_id": "987654321",
    "sign_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": "服务器内部错误" }
              
              {
  "code": 500,
  "message": "服务器内部错误"
}

            
此代码块在浮窗中显示

错误码

错误码 http code 说明
400 400 参数错误或业务逻辑错误
500 500 服务器内部错误

附录

签名配置状态 (status)

说明
1 待审核
2 审核通过
3 审核拒绝
Icon Solid Transparent White Qiyu
联系销售