- 添加签名
- 请求
- 请求参数
- 响应
- Json响应示例:(分为指定id和未指定id)
添加签名
HTTP头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/sign/add.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
---|---|---|---|---|
apikey | string | 是 | 用户唯一标识 | 9b11127a9701975c734b8aee81ee3526 |
sign | string | 是 | 签名内容 | 云片网 |
notify | boolean | 否 | 是否短信通知结果,默认true | true |
apply_vip | boolean | 否 | 是否申请专用通道,默认false | false |
is_only_global | boolean | 否 | 是否仅发国际短信,默认false | false |
industry_type | String | 否 | 所属行业,默认“其它” | 生产/加工/制造 |
license_url | string | No | 签名对应的营业执照或其他企业资质的图片文件URL,URL由请求方提供 | https://example.com/demo.png |
参数说明:
sign
不能包含【】
不能是“云片网”
3-8个字(开通“不限签名格式”和“仅发国际短信”的用户不受此限)
不能是纯英文和数字(开通“不限签名格式”和“仅发国际短信”的用户不受此限)
apply_vip
- 仅发国际短信(is_only_global)的签名不能申请专用通道,此项(apply_vip)会被置为 false
industry_type
可选项(必须完全一致,匹配失败自动转为“其它”):
1.游戏 2. 移动应用 3. 视频 4. IT/通信/电子服务 5. 电子商务 6. 金融 7. 网站 8. 商业服务 9. 房地产/建筑 10. 零售/租赁/贸易 11. 生产/加工/制造 12. 交通/物流 13. 文化传媒 14. 能源/电气 15. 政府企业 16. 农业 17. 物联网 18. 其它
响应
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误号码,正确为0 |
msg | string | 示例“ok” |
sign | json数组 | 返回的签名json数组 |
sign中具体示例:
名称 | 类型 | 描述 |
---|---|---|
apply_state | string | 当前审核状态 |
sign | string | 签名 |
is_apply_vip | boolean | 是否为专用通道 |
is_only_global | boolean | 是否申请仅国际短信 |
industry_type | string | 类型 |
Json响应示例:(分为指定id和未指定id)
调用成功的返回值示例:
{
"code": 0,
"msg": "OK",
"sign": {
"apply_state": "CHECKING",
"sign": "【云片网】",
"is_apply_vip": false,
"is_only_global": true,
"industry_type": "IT/通信/电子服务"
}
}
调用失败的返回值示例:
{
"http_status_code": 400,
"code": 2,
"msg": "请求参数格式错误",
"detail": "参数sign格式不正确,sign不能是'云片网'"
}