admin管理员组文章数量:1122850
短信
所有接口详细平台:
1,国内短信
1、验证码短信接口
请求URL:
请求方式:
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数:
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
sign | 是 | string | 平台上申请的接口短信签名或者签名ID(须审核通过),采用utf8编码 |
templateId | 是 | String | 平台上申请的接口短信模板Id(须审核通过) |
mobile | 是 | String | 接收短信的手机号码(只支持单个手机号) |
content | 是 | String | 发送的短信内容是模板变量内容,多个变量中间用##或者$$隔开,采用utf8编码 |
返回示例
{ code: "0", msg: "SUCCESS", smUuid:"xxxx" } |
返回参数说明
参数名 | 类型 | 说明 |
code | Int | 请求状态 0表示请求成功,非0表示请求失败;状态详细参考“错误码列表” |
msg | String | 状态说明 |
smUuid | String | 短信的唯一码 |
2、群发短信接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
sign | 是 | string | 平台上申请的接口短信签名,采用utf8编码 |
mobile | 否 | string | 接收短信的手机号码,多个号码以英文半角逗号,隔开 注:最大支持5万 |
content | 否 | string | 发送的短信内容,采用utf8编码 |
data | 否 | JSON | 该字段用于发送个性短信,mobile和content字段不需要填写,该字段是json字符串,json的key是手机号,value是短信内容,等同于上面的content采用utf8编码 注:最大支持1万手机号 |
scheduleSendTime | 否 | string | 短信定时发送时间,格式为:4045-01-01 18:00:00;参数如果为空表示立即发送 |
返回示例
{ code: "0", msg: "SUCCESS", batchId:"xxxx" } |
返回参数说明
参数名 | 类型 | 说明 |
code | Int | 请求状态 0表示请求成功,非0表示请求失败;状态详细参考“错误码列表” |
msg | String | 状态说明 |
batchId | String | 批次id |
3、群发短信添加签名接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
sign | 是 | string | 短信签名,采用utf8编码 |
description | 否 | string | 简单描述使用场景 |
返回示例
{ "ret":0, "msg":null, "data":{ "signId":123 } } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
codeInfo | String | 状态说明 |
data | String | Json字符串,签名id |
4、群发短信修改签名接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
id | 是 | Int | 签名id |
sign | 是 | string | 短信签名,采用utf8编码 |
description | 否 | string | 简单描述使用场景 |
返回示例
{ "ret":0, "msg":null, "data":{ "signId":123 } } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
codeInfo | String | 状态说明 |
data | String | Json字符串,签名id |
5、群发短信删除签名接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
signId | 是 | Int | 签名id |
返回示例
{ "ret":0, "msg":null, "data":null } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
codeInfo | String | 状态说明 |
data | String | Json字符串 |
6、群发短信签名查询接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
返回示例
{ code: "0", msg: "SUCCESS", "data": [ { "extNo": "xxxx", "exemptFlag": x, "customerId": xxxx, "signId":x, "sign": "【xxxx】", "applyStatus":x, "applyReply":x } ] } |
返回参数说明
参数名 | 类型 | 说明 |
extNo | String | 扩展号 |
customerId | Int | 特服号 |
id | Int | 签名Id |
sign | String | 签名 |
applyStatus | String | 审核状态 1:未审核 2:审核通过 3:审核不通过 |
applyReply | String | 审核批注 |
7、群发短信添加模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateName | 是 | string | 模板名称 |
categoryId | 是 | string | 1 验证码 2 通知订单 3 营销 |
template | 是 | string | 短信模板,采用utf8编码 |
description | 是 | string | 简单描述使用场景 |
返回示例
{ "ret":0, "msg":null, "data":{ "templateId":123 } } |
返回参数说明
参数名 | 类型 | 说明 |
ret | Int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | Json字符串,模板id |
8、群发短信修改模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | String | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | String | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
id | 否 | Int | 模板id |
templateName | 否 | String | 模板名称 |
template | 否 | String | 短信模板,采用utf8编码 |
description | 否 | String | 简单描述使用场景 |
返回示例
{ "ret":0, "msg":null, "data":{ "templateId":123 } } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | Json字符串,模板id |
9、群发短信删除模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | String | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | String | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateId | 是 | Int | 模板id |
返回示例
{ "ret":0, "msg":null, "data":null } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | Json字符串 |
10、群发短信模板查询接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
返回示例
{ code: "0", msg: "SUCCESS", "data": [ { "templateId": x, "template": "xxxxxxx", "customerId": xxx, "applyStatus":x, "categoryId": x, "applyReply":x }, { "templateId": x, "template": "xxxxx", "customerId": xxx, "applyStatus": x, "categoryId": x, "applyReply":x } ] } |
返回参数说明
参数名 | 类型 | 说明 |
customerId | String | 特服号 |
id | int | 模板ID |
template | String | 模板内容 |
categoryId | String | 短信类别 1 验证码 2 通知&订单 3 营销 |
applyStatus | String | 审核状态 1:未审核 2:审核通过 3:审核不通过 |
applyReply | String | 审核批注 |
11、群发短信单模板查询接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateId | 是 | Int | 模板ID |
返回示例
{ code: "0", msg: "SUCCESS", data: { "templateId":xx, "template": "xxxx", "customerId": xx, "applyStatus": x, "categoryId": x } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | 模板数据 |
2,国际短信
1、国际短信发送接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey, 国际短信发送接口与国内接口不共用密钥,国际密钥在国际短信-"应用账号"获取 |
secret | 是 | string | 平台分配给用户的secret, 国际短信发送接口与国内接口不共用密钥,国际密钥在国际短信-"应用账号"获取 |
mobile | 是 | string | 接收短信的手机号码,多个号码以英文半角逗号,隔开 示例 8613000000000,8613000000001 |
content | 是 | string | 发送的短信内容,采用utf8编码 |
data | 否 | json | 该字段用于发送个性短信,mobile和content字段不需要填写,该字段json字符串,json的key是手机号,value是短信内容变量,等同于上面的content 包含多个变量中间用##或者$$隔开,采用utf8编码 示例 {"8613900000000":"女士##10:10##物流公司##000000","8613900000000":"先生##9:40##快递公司##1234567"} |
scheduleSendTime | 否 | string | 短信定时发送时间,格式为:2018-01-01 18:00:00;参数如果为空表示立即发送 |
senderId | 是 | String | 该字段用于短信下发标识发件人信息 |
reqNo | 否 | String | 用户回传数据,最大长度64。 用户若传递此参数将在回执推送时回传给用户。 |
返回示例
{ code: "0", msg: "SUCCESS", batchId:"" } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;状态详细参考“错误码列表” |
msg | String | 状态说明 |
batchId | String | 批次id |
- 回填率接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey, 国际短信发送接口与国内接口不共用密钥,国际密钥在国际短信-"应用账号"获取 |
secret | 是 | string | 平台分配给用户的secret, 国际短信发送接口与国内接口不共用密钥,国际密钥在国际短信-"应用账号"获取 |
messageId | 是 | int | 短信提交平台返回的消息ID |
status | 否 | int | 回填状态:1代表回填,0代表未回填 |
返回示例
{ code: "0", msg: "SUCCESS",
} |
返回参数说明
参数名 | 类型 | 说明 |
code | String | 请求状态 0表示请求成功,非0表示请求失败;状态详细参考“错误码列表” |
msg | String | 状态说明 |
3,语音验证码
1、语音验证码发送接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
mobile | 是 | string | 接收语音短信的手机号码 |
voiceCode | 是 | string | 语音数字,4~8位数字 |
返回示例
{ code: "0", msg: "SUCCESS" } |
4,语音通知
1、语音通知发送接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateId | 是 | string | 平台上申请的接口短信模板Id(须审核通过) |
mobile | 是 | string | 接收短信的手机号码 |
content | 否 | string | 如果模板ID填写 发送的短信内容是模板变量内容,多个变量中间用##隔开,采用utf8编码,如果报备的模板是无变量模板,则这个参数不填写 |
返回示例
{ code: "0", msg: "SUCCESS", batchId:"xxx" } |
2、语音通知添加模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateName | 是 | string | 模板名称 |
categoryId | 是 | string | 模板类型 1 验证码 2 通知订单 3 营销 |
template | 是 | string | 短信模板,采用utf8编码 |
description | 是 | string | 简单描述使用场景 |
返回示例
{ "ret":0, "msg":null, "data":{ "templateId":123 } } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | Json字符串,模板id |
3、语音通知修改模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
id | 是 | Int | 模板id |
templateName | 是 | string | 模板名称 |
template | 是 | string | 短信模板,采用utf8编码 |
description | 是 | string | 简单描述使用场景 |
返回示例
{ "ret":0, "msg":null, "data":{ "templateId":123 } } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | Json字符串,模板id |
4、语音通知查询模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateId | 是 | [Int | 模板Id |
返回示例
{ "code": "0", "msg": "SUCCESS", "data": { "customerId": 10000, "template": "你好你好123", "templateId": 136, "applyStatus": 1, "categoryId": 1 } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | Json字符串,模板id |
5,图片短信
1、图片彩信发送接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交彩信发送请求,content-type:application/x-www-form-urlencoded。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
title | 是 | string | 标题 |
content | 是 | List | showTime:当前帧显示时间,默认3秒,可以不填写 img:可以访问的图片地址 http或https。content:文字内容 示例 [{"showTime":"2","img":".png","content":"这里填写第1帧的内容"},{"img":".png","content":"这里填写第2帧的内容"}] |
mobile | 是 | string | 发送的手机号,多个以英文逗号分隔 |
scheduleSendTime | 是 | string | 定时时间,如果不填则表示立即发送,填写则在指定时间发生,日期格式yyyy-MM-dd HH:mm:ss |
返回示例
{ "code":"0", "msg":"SUCCESS", "batchId":"123456" } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
batchId | String | 批次id |
6,视频彩信
1、视频彩信发送接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交彩信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
mobile | 是 | string | 手机号,多个用英文逗号分隔 |
templateId | 是 | Int | 模板ID |
返回示例
{ "code": "0", "msg": "SUCCESS", "batchId": "85" } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
batchId | String | 批次id |
2、视频彩信创建模板接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交彩信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
templateName | 是 | string | 模板名称 |
template | 是 | string | Template是发送视频彩信的模板文件,是一个json数组,每个json放置的是一种资源, 如果是文本,type=text,content是具体内容如果是图片,type=image,content是可下载的图片,支持gif和jpg如果是视频,type=video,content 是可下载的视频文件,支持mp4如果是音频,type=audio,content是可以下载的音频文件,支持mp3总文件大小务必限制在2M内,否则发送不出去至少有一个文本帧,添加签名,具体需要和客服沟通示例[{"type":"text","content":"【视频短信测试】生活亦如此,我们都应该向钱看。"},{"type":"image","content":".gif"},{"type":"text","content":"友情提醒:本条信息免流量, 回 TD 退订"}] |
title | 是 | string | 标题 |
返回示例
{ "code": "0", "msg": "SUCCESS", "data": { "templateId": 101 } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
data | String | 返回结果 |
templateId | int | 模板id |
3、视频彩信查询模板状态接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交彩信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
templateId | 是 | Int | 模板ID |
返回示例
{ "code": "0", "msg": "SUCCESS", "data": { "comment": "模板审核中", "templateId": 101, "status": 1 } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
data | String | 返回结果 |
templateId | int | 模板ID |
status | int | 审核状态 1:未审核 2:审核通过 3:审核失败 |
comment | String | 审核状态备注 |
7,空号检测
1、空号检测接口
请求URL
请求方式
- Http请求方式:POST,以表单的形式传递参数,content-type:application/x-www-form-urlencoded。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
mobiles | 是 | string | 检测的号码,如多个号码以英文逗号隔开 |
返回示例
{ "code": 200, "codeInfo": null, "data": { "risk": [ "18156080368" //风险号 ], "real": [ "18156080554", "18156080795" //实号 ], "empty": [ "18156081936" //空号 ], "unknown": [ "18156080792" //沉默号 ] } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 结果码 200成功,非200失败 |
codeInfo | String | code不等于200时候,错误描述 |
data | String | 返回一个map,map中risk表示风险号集合,real表示实号集合,empty表示空号集合,unknown表示沉默号集合 |
2、空号检测获取余额接口
请求URL
请求方式
- Http请求方式:POST,以表单的形式传递参数,content-type:application/x-www-form-urlencoded。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
返回示例
{ "code": 200, "codeInfo": null, "data": 175 } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 结果码 200成功,非200失败 |
codeInfo | String | code不等于200时候,错误描述 |
data | String | code=200时,该值是一个json字符串 |
8,智能短链
1、创建智能短链接接口
请求URL
请求方式
- Http请求方式:POST,以表单的形式传递参数,content-type:multipart/form-data。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
marks | 是 | string | 英文逗号分隔的标识 |
originUrl | 是 | string | 客户原网址 |
checkMobile | 否 | Boolean | 是否校验标识为手机号 |
返回示例
{ "code": 200, "codeInfo": null, "data": 1 } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 结果码 200成功,非200失败 |
codeInfo | String | code不等于200时候,错误描述 |
data | int | 返回创建的短链接批次号 |
2、查询智能短链接访问情况
请求URL
请求方式
- Http请求方式:Get,以表单的形式传递参数。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
batchNumber | 是 | Int | 创建短链接时返回的批次号 |
返回示例
{ "code": 200, "codeInfo": null, "data": { pvCount: 200, uvCount: 100, visitIpCount: 100, visitedMarks: ["18300000000"] } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 结果码 200成功,非200失败 |
codeInfo | String | code不等于200时候,错误描述 |
data | JSON | pvCount:pv值;uvCount:uv值;visitIpCount:ip数量;visitedMarks:有访问的标识列表 |
3、获取智能短链接批次详情
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
batchNumber | 是 | Int | 创建时返回的批次号 |
返回示例
{ "code": "0", "msg": "SUCCESS", "data": [ { "mark": "xxxxxx", "shortUrl": "" } ] } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | JSON | 数组里的每个元素是个json;json有两个属性,mark代表标识,shortUrl代表短链接 |
9,黑名单检测
1、黑名单检测接口
请求URL
请求方式
- Http请求方式:POST,以表单的形式传递参数,content-type:application/x-www-form-urlencoded。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
mobiles | 是 | string | 检测的手机号码多个用英文逗号分开;最大支持1000个 |
返回示例
{ code: "200", codeInfo: "", data: { "18300000000": 1, "18300000001": 2, "18300000002": 3, } } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 200表示请求成功,非200表示请求失败 |
codeInfo | String | 状态说明 |
data | JSON | 返回结果 1:正常;2:风险;3:超频 |
10,其他接口
1、主动获取短信状态接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
返回示例
{ code: "0", msg: "SUCCESS", data:[ { "smUuid":"10000_1_0_13700000000_1_rzwKjGA_1", "deliverTime":"2018-09-25 16:07:31", "mobile":"13700000000", "deliverResult":"DELIVRD", "batchId":"rzwKjGA" }, { "smUuid":"10000_1_0_13700000001_1_apLdwfp_1", "deliverTime":"2018-10-09 10:48:55", "deliverResult":"DELIVRD", "mobile":"13700000001", "batchId":"apLdwfP" } ] } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
data | JSON | JSON数据 示例:[{"smUuid":"10000_1_0_13700000000_1_rzwKjGA_1","deliverTime":"2018-09-25 16:07:31","mobile":"13700000000","deliverResult":"DELIVRD","batchId":"rzwKjGA"}] |
备注
smUuid:短信唯一标识 deliverTime:状态码回执时间 mobile:接收短信的手机号 deliverResult:短信状态码 batchId:批次id 1.本功能需在 “开发者工具 -> 状态获取 -> 主动获取” 开启后方可正常调用
- 接口单次最大支持拉取数量为1000,已拉取的数据无法重复拉取
2、短信状态回执推送接口
调用地址
地址:客户需向我司提交接收回执状态地址,由平台主动推送回执状态数据;
请求方式
- 用户通过POST的方式请求。
推送请求包头定义:
- Content-Type: application/form-data;charset=utf-8。
请求参数:推送数据为JSON。推送字段如下:
参数名 | 必选 | 类型 | 说明 |
smUuid | 是 | string | 短信唯一标识。例10000_1_0_13700000000_1_NKWkEcS_1 |
mobile | 是 | string | 手机号码。例13700000000 |
batchId | 否 | string | 批次id。例abc123456 |
deliverResult | 是 | string | 回执状态,DELIVRD成功,其他失败 |
deliverTime | 是 | string | 状态码回执时间。格式yyyy-MM-dd HH:mm:ss。例如2018-01-01 18:00:00 |
reqNo | 否 | string | 用户回传数据,如果提交时有传递此参数将原样推送带回 |
响应结果:
正常响应HTTP状态码200即可。非200状态码将转换为客户获取形式
推送请求示例:
{ "smUuid": "100029:0:85251234567:1:RzEJzq9bv0:1:1", "mobile": "13700000000", "batchId": "abc123456", "deliverResult": "DELIVRD", "deliverTime": "2018-01-01 18:00:00", "reqNo": "XXX" } |
3、主动获取短信回复接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
返回示例
{ code: "0", msg: "SUCCESS", data: [ { "receiveTime":"2018-09-25 16:07:31", "mobile":"13700000000", "content":"你好", "extNo":"01234" }, { "receiveTime":"2018-09-25 15:07:31", "mobile":"13700000001", "content":"是的", "extNo":"12345" } ] } |
返回参数说明
参数名 | 类型 | 说明 |
code | int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
data | JSON | JSON数据 示例:[{"receiveTime":"2018-09-25 16:07:31","mobile":"13700000000","content":"你好","extNo":"01234"}] |
备注
receiveTime:短信回复的时间 mobile:短信回复的用户手机号 content:短信回复的内容 extNo:签名扩展号 1.本功能需在 “开发者工具 -> 状态获取 -> 主动获取” 开启后方可正常调用
2.接口单次最大支持拉取数量为1000,已拉取的数据无法重复拉取
4、余额查询接口
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
返回示例
{ "code":"0", "msg":"SUCCESS", "data": { "语音验证码":0, "国际短信":0, "彩信":0, "语音通知":0, "接口短信":0, "平台短信":0, "视频彩信":0 } } |
返回参数说明
参数名 | 类型 | 说明 |
code | Int | 请求状态 0表示请求成功,非0表示请求失败;详细参考“错误码列表” |
msg | String | 状态说明 |
data | Object | 返回结果 可以查询 语音验证码、国际短信、彩信、语音通知、接口短信、平台短信、视频彩信 的条数或余额 |
5、查询手机号所属地区
请求URL
请求方式
- 用户通过HTTP(或HTTPS)的POST或GET方式提交短信发送请求。编码采用UTF-8编码。
参数
参数名 | 必选 | 类型 | 说明 |
accesskey | 是 | string | 平台分配给用户的accesskey,登录系统首页可点击"我的秘钥"查看 |
secret | 是 | string | 平台分配给用户的secret,登录系统首页可点击"我的秘钥"查看 |
mobiles | 是 | string | 多个手机号用英文逗号分开 |
返回示例
{ "ret":0, "msg":null, "data":[ { "province":"某省", "city":"某市", "operator":"运营商", "mobile":"手机号" } ] } |
返回参数说明
参数名 | 类型 | 说明 |
ret | int | 请求状态 0表示请求成功,非0表示请求失败 |
msg | String | 状态说明 |
data | String | 返回结果 Json字符串 |
11,提交错误码列表
错误码 | 错误描述 |
9001 | 签名格式不正确 |
9002 | 参数未赋值 |
9003 | 手机号码格式不正确 |
9006 | 用户accesskey不正确 |
9007 | IP白名单限制 |
9009 | 短信内容参数不正确 |
9010 | 用户短信余额不足 |
9011 | 用户帐户异常 |
9012 | 日期时间格式不正确 |
9013 | 不合法的语音验证码,4~8位的数字 |
9014 | 超出了最大手机号数量 |
9015 | 不支持的国家短信 |
9016 | 无效的签名或者签名ID |
9017 | 无效的模板ID |
9018 | 单个变量限制为1-20个字 |
9019 | 内容不可以为空 |
9021 | 主叫和被叫号码不能相同 |
9022 | 手机号码不能为空 |
9023 | 手机号码黑名单 |
9024 | 手机号码超频 |
10001 | 内容包含敏感词 |
10002 | 内容包含屏蔽词 |
10003 | 错误的定时时间 |
10004 | 自定义扩展只能是数字且长度不能超过4位 |
10005 | 模版类型不存在 |
10006 | 模版和内容不匹配 |
本文标签: 短信
版权声明:本文标题:短信 内容由网友自发贡献,该文观点仅代表作者本人, 转载请联系作者并注明出处:http://www.betaflare.com/biancheng/1730904813a1538252.html, 本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。
发表评论