普通发送接口(一对多发送)
更新时间:2023-07-06
特别提醒
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
1.功能说明
1.1.该接口适用于:通过已申请的【签名ID】和【模板ID】请求发送短信;
1.2.使用该接口,可以给单个号码发送短信,或者给多个号码群发相同内容短信;
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/sms/smsoto.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式);
1.5.汉字字符集:UTF-8,请注意参数的大小写。
1.2.使用该接口,可以给单个号码发送短信,或者给多个号码群发相同内容短信;
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/sms/smsoto.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式);
1.5.汉字字符集:UTF-8,请注意参数的大小写。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
mobile | 发送手机号码 | String | 是 | 需要发送的手机号。 1.单批最大1000个号码。建议单批数量在200以内; 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**分钟内有效,请勿泄漏于他人!} |
param | 模板变量 | String | 否 |
1.字符串格式:**key**:value,**key**:value(例如:**code**:12345,**minute**:5); 2.如模板中有多个变量请使用英文逗号隔开; 3.建议对参数进行URLEncode编码,以免出现乱码等异常情况 |
smsid | 消息ID | String | 否 |
1.消息ID是这个包唯一标识,若为空则系统随机分配一个唯一标识值。 2.若不为空,由用户自己设置一个唯一标识值。 3.该值做为应答及状态报告中的消息ID一一对应。 |
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/smsoto.htm?appkey=123456&appsecret=448484484&mobile=15000000000,17300000000&smsSignId=3ff743552d&templateId=7563abd9c95
3.2 请求示例下载
Curl | Java | C# | PHP | Python | ObjectC |
下载 |
4.Json返回
4.1.返回参数
参数 | 名称 | 类型 | 描述 |
code | 返回码 | String | 提交返回结果。0:表示成功,其他:失败。(状态码详见:《公共错误代码定义》) |
msg | 信息描述 | String | 返回码对应的中文描述。 |
smsid | 消息ID | String |
1.消息ID是这个包唯一标识,若为空则系统随机分配一个唯一标识值; 2.若不为空,由用户自己设置一个唯一标识值; 3.可通过该ID查询发送状态或者回复短信。 |
failList | 提交失败记录 | List | 错误的号码数据,多个之间英文逗号分开 |
4.2.调用成功样例
{
"code":"0",
"msg":"成功",
"smsid":"1234554444dd5", //批次号。可通过该ID查询发送状态或者回复短信。
"failed":["123","abc"] //错误的号码记录
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}