变量发送接口(一对一批量发送)
更新时间:2022-11-16
特别提醒
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
1.功能说明
1.1.该接口适用于:通过已申请的【签名ID】和【模板ID】请求发送变量短信;
1.2.使用该接口,可以给单个号码发送短信,也可以同时给多手机号码发送不同变量内容的短信。
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/sms/smsmtm.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式)。
1.5.汉字字符集:UTF-8,请注意参数的大小写。
1.2.使用该接口,可以给单个号码发送短信,也可以同时给多手机号码发送不同变量内容的短信。
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/sms/smsmtm.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式)。
1.5.汉字字符集:UTF-8,请注意参数的大小写。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
smsSignId | 短信前缀ID(签名ID) | String | 是 |
1.可在控制台“签名管理”中申请; 2.测试前缀ID:2e65b1bb3d054466b82f0c9d125465e2; 3.测试签名限流规则,同一个号码,1分钟1次,1小时5次,24小时10次,不支持大量商用 |
templateId | 短信正文ID(模板ID) | String | 是 |
1.可在控制台“模板管理”中申请; 2.测试模板ID可用:908e94ccf08b4476ba6c876d13f084ad,对应短信正文为 {验证码:**code**,**minute**分钟内有效,请勿泄漏于他人!} |
content | 批量提交参数 | String | 是 |
1.JSON格式对象数组字符串。格式[{"smsid":"消息ID","mobile":"手机号","变量名":"变量值"}],例如: [{"smsid":"smsid1","mobile":"mobile1",
"**code**":"123456","**minute**":"5"},{"smsid":"smsid2","mobile":"mobile2",
"**code**":"56789","**minute**":"10"}]; 2.smsid为消息ID(非必选),可通过该ID查询发送状态或者回复短信等。可以自己生成(须唯一),也可以删除此项,由系统自动生成; 3.单批最大1000个号码。建议单批数量在200以内; 4.建议对参数进行URLEncode编码,以免出现乱码等异常情况 |
instanceid | 产品账户ID | String | 否 | 用于指定扣费的产品账户,如果传入该参数,资费将从指定的产品账户扣减。(需客服开通权限后方能生效) |
subport | 扩展端口 | String | 否 | 1.空表示不需要扩展。 2.扩展必须是2位数字(若扩展输入00则手机收到端口号为:10657*****00)。 3.扩展必须此帐户配置通道支持。 |
sendtime | 定时发送时间 | String | 否 | 1.为空表示立即发送。 2.定时格式:yyyy-mm-dd hh:mm:ss 3.定时时间应设置在当前时间的15分钟后。 |
3.调用示例
3.1 浏览器测试样例
特别提醒
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
http(s)://api.guoyangyun.com/api/sms/smsmtm.htm?appkey=123456&appsecret=448484484&&content=[{"mobile":"17300000000","**code**":"123456"},{"mobile":"15000000000","**code**":"744844"}]&smsSignId=3ff743552d&templateId=7563abd9c95
3.2 请求示例下载
Curl | Java | C# | PHP | Python | ObjectC |
下载 |
4.Json返回
4.1.返回参数
参数 | 名称 | 类型 | 描述 |
code | 返回码 | String | 提交返回结果。0:表示成功,其他:失败。(状态码详见:《公共错误代码定义》) |
msg | 信息描述 | String | 返回码对应的中文描述。 |
data | 提交成功记录 | List | 批量发送提交成功的记录列表 |
smsid | 消息ID | String | 发送短信时,系统返回(或者自己指定)的消息ID |
mobile | 手机号码 | String | 发送的手机号码 |
code | 提交状态码 | String | 状态0表示提交成功,其他表示提交失败 |
msg | 状态码描述 | String | 对提交状态码的详细描述 |
failList | 提交失败记录 | List | 批量发送提交失败的记录列表 |
mobile | 手机号码 | String | 发送的手机号码 |
code | 提交状态码 | String | 状态0表示提交成功,其他表示提交失败 |
msg | 状态码描述 | String | 对提交状态码的详细描述 |
4.2.调用成功样例
{
"msg":"成功",
"code":"0",
"data":[
{
"smsid":"1688030989939163908659658690",
"mobile":"17300000000",
"code":"0",
"msg":"成功"
}
],
"failList":[
{
"msg":"手机号码不正确",
"code":"1403",
"mobile":"0571-84880000"
}
]
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}