产品服务

Service Project

短信api接口

短信api接口

产品简介


短信api接口指的是一组定义、程序及协议的组合,通过 api接口实现软件之间的互相通讯,其最重要的一个功能就是提供通用功能集......

产品详情

短信api接口指的是一组定义、程序及协议的组合,通过 api接口实现软件之间的互相通讯,其最重要的一个功能就是提供通用功能集。技术人员再通过使用 api函数开发应用程序,从而可以避免编写无用程序,以减轻编程任务。 同时api也是一种中间件,能够为各种不同平台提供数据共享。

总而言之,短信api接口其实就是一对一发短信或是一对多群发的一种应用程序接口、网站、APP或是软件接入短信应用接口,并且短信api接口能够实现短信群发或是系统触发自动发短信验证码的功能。

短信api接口优势:

全球短信均可发送——支持全世界各种语言,覆盖200+国家及地区和1423个运营商;

10分钟即可上线——支持上行回复/可在线发送、api接入/支持自定义模板;


API文档

短信发送接口:

  • 请求方式:post
  • 接口地址:https://api.juncyun.com/api/msgService/sendSms
  • 编码方式:utf-8
  • 参数格式:json

请求参数说明:

编码 列表 内容 备注
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:推广短信

请求参数示例:

  • {
  • "accessKey": "NDYw*******",
  • "accessSecret": "MDQyOTQ1OTM3*********************",
  • "signCode": "b1d8acef",
  • "templateCode": "65c1b941",
  • "phone": "13800138000",
  • "params": [
  • "1234"
  • ],
  • "msgType": 1
  • }

响应参数列表:

编码 列表 内容
1) code 状态码200则为成功
2) msg 状态说明
3) success 处理是否成功:取值范围 true,false
4) data 业务数据 如果失败则为空
5) phone 手机号码
6) msgId 短信id

响应参数示例:

  • {
  • "code": 200,
  • "msg": "成功",
  • "success": true,
  • "data": {
  • "phone": "13800138000",
  • "msgId": "1604770228094443521"
  • }
  • }

结果码说明:

结果码 描述
200 成功
502 系统繁忙
60021 余额不足!请充值后重试!
500,501,503 系统错误
5001 请求参数校验异常

发送多条国内短信:

  • 请求方式:post
  • 接口地址:https://api.juncyun.com/api/msgService/sendSmsBatch
  • 编码方式:utf-8
  • 参数格式:json

请求参数说明:

编码 列表 内容 备注
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:推广短信

请求参数示例:

  • {
  • "accessKey": "NDYw*******",
  • "accessSecret": "MDQyOTQ1OTM3*********************",
  • "signCode": "b1d8acef",
  • "templateCode": "65c1b941",
  • "phone": "13800138000,13800138001,13800138002",
  • "params": [
  • "1234"
  • ],
  • "msgType": 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) phone 手机号码
14) msgId 短信id

响应参数示例:

  • {
  • "code": 200,
  • "msg": "操作成功",
  • "success": true,
  • "data": {
  • "successNum": 3,
  • "list": [
  • {
  • "code": 200,
  • "msg": "操作成功",
  • "success": true,
  • "data": {
  • "phone": "13800138000",
  • "msgId": "1604771323839586305"
  • }
  • },
  • {
  • "code": 200,
  • "msg": "操作成功",
  • "success": true,
  • "data": {
  • "phone": "13800138001",
  • "msgId": "1604771324938493953"
  • }
  • },
  • {
  • "code": 200,
  • "msg": "操作成功",
  • "success": true,
  • "data": {
  • "phone": "13800138002",
  • "msgId": "1604771327220195330"
  • }
  • }
  • ]
  • }
  • }

结果码说明:

结果码 描述
200 成功
502 系统繁忙
60021 余额不足!请充值后重试!
500,501,503 系统错误
5001 请求参数校验异常
产品背景图
 
电话: 15979290517
 
邮箱: gongsy@juncdt.com
 
地址: 中国杭州 云栖小镇 鲤鱼山街18号3幢4层
 
  • 专业

    短信群发专业服务商

  • 保障

    电信级运维保障,实时监控自动切换

  • 用心

    提供优质的售后服务

  • 便捷

    快速触达,连接用户只需要3秒