注意,短信接口v2的使用需要进行接口鉴权
获取短信模板接口
-
HTTP请求方式:POST
-
接收数据编码格式:ISO-8859-1
-
请求链接:{HOST}/v20160818/sms/getSmsTemplate/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权文档:接口鉴权
-
请求示例:
https://apis.7moor.com/v20160818/sms/getSmsTemplate/N00000000556
?sig=DBD2D28F3D895AAD1572925AAE50AEA8
返回示例:
{
"success": true,
"data": [
{
"_id": " N00000000556 _1",
"num": "1",
"name": "验证码模板",
"content": "您好您的验证码是{1},有效时间为{2}分钟",
"vars": 2,
"sign": "【七陌科技】"
},
{
"_id": " N00000000556 _2",
"num": "2",
"name": "会议邀请",
"content": "{1}先生/女士,七陌科技欢迎您来参会,会议时间为{2},地址为{3}",
"vars": 3,
"sign": "【七陌科技】"
}
],
"message": "200 ok!"
}
返回值参数说明:
参数名称 | 参数说明 | 值说明 |
success | 成功标示 | true/false |
message | 描述信息 | 200 ok |
发送短信接口
注意,本接口的使用需要进行接口鉴权
接口请求方式:POST 接收数据编码格式:ISO-8859-1
-
请求url:{HOST}/v20160818/sms/sendInterfaceTemplateSms/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
请求url示例:
http://apis.7moor.com/v20160818/sms/sendInterfaceTemplateSms/N00000000556?
sig=DBD2D28F3D895AAD1572925AAE50AEA8
其中N00000000556 为账户编号(即accountID),请替换为您的账户编号,sig为鉴权参数
请求体
字段 | 类型 | 是否必须 | 备注 |
num | String | 是 | 接收手机号码,多个手机号码以英文逗号分隔,一次调用最大为3000个号码 |
templateNum | String | 是 | 短信模板编号,必须传提前报备过的,从模板查询接口获得 |
var1至varn | String | 是 | 需要替换的变量,例如:要替换{1}传var1 |
注意,如需同时给多个手机号发送短信,可在num中传多个手机号以英文逗号分开。
请求体示例:
{
"num": "186xxxxxxxx",
"templateNum": "13",
"var1": "888666"
}
返回示例:
{
"success": true,
"message": "200 ok!"
}
返回值参数说明:
参数名称 | 参数说明 | 值说明 |
success | 成功标示 | true/false |
msgid | 短信id | |
flag | 响应码 | |
message | 备注 |
成功返回示例:
{
"success": true,
"flag": "00",
"msgid": "d0a30fe0-c331-11e6-96c7-b3a8b30da8b6",
"message": "短信提交成功"
}
失败返回示例
{
"success": false,
"flag": "12",
"message": "未找到对应的短信模板"
}
响应状态表
success | flag | 说明 |
true | 00 | 提交通道成功 |
false | 01 | 模板编号为空 |
false | 02 | 内容为空或内容过长 |
false | 03 | 手机号码为空 |
false | 04 | 账号为空 |
false | 06 | 单次群发手机号码不能超过3000个,请检查号码数量 |
false | 07 | 含有不正确的手机号码,请检查 |
false | 09 | 您的账号未开通发短信HTTP接口 |
false | 10 | 资费不足,无法该条发送短信 |
false | 11 | 此签名未备案 |
false | 12 | 未找到对应的短信模板 |
false | 13 | 此模板异常,无法发送短信 |
false | 99 | 服务端内部错误 |