Logo Site EngageLab Mark Colored Transparent文档
搜索

创建签名配置

创建新的签名配置(Sender ID),用于在短信中显示发送者标识。创建后签名状态为"待审核",需通过审核后方可使用。

调用地址

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": "公司名称" }
              
              {
  "sign_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 code 说明
400 400 参数错误或业务逻辑错误
500 500 服务器内部错误

常见错误信息:

  • sign_name already exist:签名名称已存在

注意事项

  1. 签名创建后状态为"待审核"(status=1),需通过审核后方可使用
  2. 同一业务下签名名称不能重复
  3. 签名名称不能包含禁用字符:[]
  4. 签名的 ID 是字符串类型的数字

附录

签名配置状态 (status)

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