变量发送接口(一对一批量发送)
更新时间:2022-11-16
特别提醒
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
1.功能说明
1.1.该接口适用于:直接将【短信前缀】和【短信内容】放在接口中请求发送短信,无需事先申请 【签名ID】和【模板ID】,但是会进入人工审核(除非客服配置免审);
1.2.使用该接口,可以给单个号码发送短信,也可以同时给多手机号码发送不同变量内容的短信。
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/sms/variableSmsApi.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式);
1.5.汉字字符集:UTF-8,请注意参数的大小写。
1.2.使用该接口,可以给单个号码发送短信,也可以同时给多手机号码发送不同变量内容的短信。
1.3.接口发送调用地址:http(s)://api.guoyangyun.com/api/sms/variableSmsApi.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式);
1.5.汉字字符集:UTF-8,请注意参数的大小写。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
smsid | 消息ID串 | String | 否 |
1.消息ID串,每一个号码(即一条短信)对应一个ID值,该值唯一区分每一个短信。 2.同一批次提交多个消息ID值之间采用半角逗号分隔。 3.若为空则系统随机分配一批消息ID值,与号码串一一对应。 4.若不为空,由用户自己设置一批消息ID值,之间用半角逗号分隔,注意每一个消息ID唯一。 5.该值做为应答及状态报告中的消息ID一一对应。 |
mobile | 发送手机号码 | String | 是 | 1.多个号码用英文半角逗号分开。 2.每个包最大可支持3000个号码。 |
content | 发送短信内容 | String | 是 |
1.使用UTF-8编码。 2.签名可以包含在内容中。 3.多个内容用※分开。格式:【签名】内容1※【签名】内容2 4.每个内容长度不超过500字。 |
instanceid | 产品账户ID | String | 否 | 用于指定扣费的产品账户,如果传入该参数,资费将从指定的产品账户扣减。(需客服开通权限后方能生效) |
subport | 扩展端口 | String | 否 | 1.空表示不需要扩展。 2.扩展必须是2位数字(若扩展输入00则手机收到端口号为:10657*****00)。 3.扩展必须此帐户配置通道支持。 |
sendtime | 定时发送时间 | String | 否 | 1.为空表示立即发送。 2.定时格式:yyyy-mm-dd hh:mm:ss 3.定时时间应设置在当前时间的15分钟后。 |
2.1.批量发送一对一时,当smsid不为空时,smsid,mobile,content三个参数分解出来短信对应个数必须一致,否则返回错误代码(批量一对一参数格式错误)。
2.2.当smsid为空时,mobile,content分解的条数必须相同,否则返回错误代码(批量一对一发送,手机号和内容个数不匹配)。
2.2.当smsid为空时,mobile,content分解的条数必须相同,否则返回错误代码(批量一对一发送,手机号和内容个数不匹配)。
3.调用示例
3.1 浏览器测试样例
特别提醒
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
根据运营商相关要求,短信/彩信只能向其客户、会员或内部员工的手机号码发送与本企业业务相关的通知类短信、验证码、注册码类短信,以及符合国家法律法规的营销类信息等,如您在接入调试等阶段需要测试,请务必使用自己的手机号码进行发送测试,切勿使用他人,或者随意编纂号码进行发送,以免因用户投诉等引起不必要的法律和安全风险。请务必重视并遵守执行。
http(s)://api.guoyangyun.com/api/sms/variableSmsApi.htm?appkey=123456&appsecret=448484484&mobile=15000000000,17300000000&content=【签名】测试内容1※【签名】测试内容2
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 | 对提交状态码的详细描述 |
4.2.调用成功样例
{
"code":"0",
"msg":"成功",
"data":[
{"smsid":"333","mobile":"13606000000","code":"0","msg":"成功"},
{"smsid":"111","mobile":"123","code":"1403","msg":"手机号码格式不正确"},
{"smsid":"222","mobile":"17300000000","code":"1302","msg":"短信内容包含敏感词等"}
]
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}