- 获取签名
- 请求
- 请求参数
- 响应
- Json响应示例:
获取签名
HTTP头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/sign/get.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
---|---|---|---|---|
apikey | string | 是 | 用户唯一标识 | 9b11127a9701975c734b8aee81ee3526 |
id | long | 否 | 签名id,暂未开放(API文档里先不写),如果传入此参数将会指定获取某个签名 | 1 |
sign | string | 否 | 返回所有包含该内容的签名(模糊匹配),若要获取指定签名可加上符号,如【云片网】 | 云片 |
page_num | integer | 否 | 页码,1开始,不带或者格式错误返回全部 | 1 |
page_size | integer | 否 | 返回条数,必须大于0,不带或者格式错误返回全部 | 20 |
响应
名称 | 类型 | 描述 |
---|---|---|
code | integer | 正确为0表示成功,其他值表示错误,错误时不会有下面的数据 |
total | integer | 该查询条件下共有多少记录 |
sign | json数组 | 签名集合,为空表示没有符合条件的签名 |
sign中具体示例:
名称 | 类型 | 描述 |
---|---|---|
chan | string | 通道类型,'NONE'暂未分配,'GLOBAL'国际短信通道,'MARKET'营销通道,'VIP'专用通道,'NORMAL'普通通道 |
check_status | string | 当前状态,'CHECKING'审核中,'FAIL'审核失败,'SUCCESS'审核成功,'APLLYING_VIP'普通通道审核成功申请升级专用通道中 |
enabled | boolean | 当前签名是否启用 |
extend | string | 扩展号,为空表示暂未分配 |
industry_type | string | 行业 |
only_global | boolean | 是否用于国际短信 |
remark | string | 客服给的审核结果解释,一般见于审核失败 |
sign | string | 签名 |
vip | boolean | 是否专用通道 |
Json响应示例:
{
"code": 0,
"total": 3,
"sign": [
{
"chan": "NORMAL",
"check_status": "APLLYING_VIP",
"enabled": true,
"extend": "9527",
"industry_type": "商业服务",
"only_global": false,
"remark": "",
"sign": "【云片网络】",
"vip": false
},
{
"chan": "GLOBAL",
"check_status": "SUCCESS",
"enabled": true,
"extend": "7788",
"industry_type": "其它",
"only_global": true,
"remark": "",
"sign": "【云片国际】",
"vip": false
},
{
"chan": "NONE",
"check_status": "FAIL",
"enabled": false,
"extend": "",
"industry_type": "其它",
"only_global": false,
"remark": "此签名具有特殊性,请联系在线客服提供签名与本公司相关的证明。",
"sign": "【云片摸摸哒】",
"vip": false
}
]
}