当前位置:短信api接口文档
国内短信
1.接口描述
支持短信营销、通知、验证码,提供国内短信API 集成发送。
2.使用场景
在业务系统中,调用指定接口实现国内短信的发送。
3.接口说明
3.1.发送单条国内短信
实现单条国内短信的发送。
3.1.1.接口协议
HTTP POST
3.1.2.接口方法
https://api.juncyun.com/api/msgService/sendSms
3.1.3.报头定义
编码 | 列表 | 内容 | 备注 |
1 | Accept | application/json | |
2 | Content-Type | application/json;charset=utf-8 |
3.1.4.请求参数
3.1.4.1.请求参数列表
编码 | 列表 | 内容 | 备注 |
1 | accessKey | API调用账号(必填,从云极平台获取) | |
2 | accessSecret | API调用密钥(必填,从云极平台获取) | |
3 | signCode | 短信签名code(必填) | |
4 | templateCode | 短信模版code(必填) | |
5 | mobile | 目标手机号(必填,String类型) | |
6 | params | 参数(选填,List类型),若有参数则必填且参数需与所选模版中参数名称以及数量一致 | |
7 | msgType | 短信类型(必填, Integer类型) 1:验证码;2:短信通知;3:会员营销;4:推广短信 |
3.1.4.2.请求参数示例
3.1.5.响应参数
3.1.5.1.响应参数列表
编码 | 列表 | 内容 | 备注 |
1 | code | 状态码200则为成功 | |
2 | msg | 状态说明 | |
3 | success | 处理是否成功:取值范围 true,false | |
4 | data | 业务数据 如果失败则为空 | |
5 | mobile | 手机号码 | |
6 | msgId | 短信id |
3.1.5.2.响应参数示例
3.1.5.3.结果码说明
结果码 | 描述 |
200 | 成功 |
502 | 系统繁忙 |
60021 | 余额不足!请充值后重试! |
500,501,503 | 系统错误 |
5001 | 请求参数校验异常 |
3.2.发送多条国内短信
实现多条国内短信的发送。
3.2.1.接口协议
HTTP POST
3.2.2.接口方法
https://api.juncyun.com/api/msgService/sendSmsBatch
3.2.3.报头定义
编码 | 列表 | 内容 | 备注 |
1 | Accept | application/json | |
2 | Content-Type | application/json;charset=utf-8 |
3.2.4.请求参数
3.2.4.1.请求参数列表
编码 | 列表 | 内容 | 备注 |
1 | accessKey | API调用账号(必填,从云极平台获取) | |
2 | accessSecret | API调用密钥(必填,从云极平台获取) | |
3 | signCode | 短信签名code(必填) | |
4 | templateCode | 短信模版code(必填) | |
5 | mobile | 目标手机号,多个手机号逗号隔开(必填,String类型) | |
6 | params | 参数(选填,List类型),若有参数则必填且参数需与所选模版中参数名称以及数量一致 | |
7 | msgType | 短信类型(必填, Integer类型) 1:验证码;2:短信通知;3:会员营销;4:推广短信 |
3.2.4.2.请求参数示例
3.2.5.响应参数
3.2.5.1.响应参数列表
编码 | 列表 | 内容 | 备注 |
1 | code | 状态码200则为成功 | |
2 | msg | 状态说明 | |
3 | success | 处理是否成功:取值范围 true,false | |
4 | data | 业务数据 如果失败则为空 | |
5 | allNum | 手机号码总数量 | |
6 | successNum | 成功手机号数量 | |
7 | failNum | 失败手机号数量 | |
8 | list | 集合类型,元素为每条短信发送结果,字段具体涵义参考单条短信发送 | |
9 | code | 状态码200则为成功 | |
10 | msg | 状态说明 | |
11 | success | 处理是否成功:取值范围 true,false | |
12 | data | 业务数据 如果失败则为空 | |
13 | mobile | 手机号码 | |
14 | msgId | 短信id |
3.2.5.2.响应参数示例
3.2.5.3.结果码说明
结果码 | 描述 |
200 | 成功 |
502 | 系统繁忙 |
60021 | 余额不足!请充值后重试! |
500,501,503 | 系统错误 |
5001 | 请求参数校验异常 |
国际短信
1.接口描述
为用户提供简单、迅速、低成本的国际短信发送能力。只需接入国际短信网关就能给世界上任何手机发送信息,真正做到一点接入全球覆盖。
2.使用场景
在业务系统中,调用指定接口实现国际短信的发送。
3.接口说明
3.1.发送单条国内短信
实现国际短信的发送。
3.1.1.接口协议
HTTP POST
3.1.2.接口方法
https://api.juncyun.com/api/msgService/internationalMsg/sendInternationalSms
3.1.3.报头定义
编码 | 列表 | 内容 | 备注 |
1 | Accept | application/json | |
2 | Content-Type | application/json;charset=utf-8 |
3.1.4.请求参数
3.1.4.1.请求参数列表
编码 | 列表 | 内容 | 备注 |
1 | accessKey | API调用账号(必填,从云极平台获取) | |
2 | accessSecret | API调用密钥(必填,从云极平台获取) | |
3 | msgType | 短信类型(必填):1-验证码,2-短信通知,3-会员营销 | |
4 | templateCode | 短信模版code(选填,模版code与内容二选一) | |
5 | phone | 目标手机号(必填,String类型) | |
6 | params | 参数(选填,map类型),若有参数则必填且参数需与所选模版中参数名称以及数量一致 | |
7 | msgContent | 短信内容(选填,模版code与内容二选一) |
3.1.4.2.请求参数示例
3.1.5.响应参数
3.1.5.1.响应参数列表
编码 | 列表 | 内容 | 备注 |
1 | code | 状态码200则为成功 | |
2 | msg | 状态说明 | |
3 | success | 处理是否成功:取值范围 true,false | |
4 | data | 业务数据 如果失败则为空 | |
5 | taskId | 本次任务id | |
6 | allNum | 手机号码总数量 |
3.1.5.2.响应参数示例