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：推广短信
8）	taskId	自定义任务 id （非必填）

  

3.1.4.2. 请求参数示例

{

"accessKey": "NDYw*******",

"accessSecret": "MDQyOTQ1OTM3*********************",

"signCode": "b1d8acef",

"templateCode": "65c1b941",

"mobile": "13800138000",

"params": [

"1234"

],

"msgType": 1,

"taskId": "squis*****dsai"

}

 

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. 响应参数示例

{

"code": 200,

"msg": "成功",

"success": true,

"data": {
      "mobile": "13800138000",
      "msgId": "1604770228094443521"
     }

}

 

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：推广短信
8）	taskId	自定义任务 id （非必填）

 

3.2.4.2. 请求参数示例

{

"accessKey": "NDYw*******",

"accessSecret": "MDQyOTQ1OTM3*********************",

"signCode": "b1d8acef",

"templateCode": "65c1b941",

"mobile": "13800138000,13800138001,13800138002",

"params": [

"1234"

],

"msgType": 1,

"taskId": "squis*****dsai"

}

 

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. 响应参数示例

{

  "code": 200,

  "msg": "操作成功",

  "success": true,

  "data": {

    "successNum": 3,

    "failNum": 0,

    "allNum": 3,

    "list": [

      {

        "code": 200,

        "msg": "操作成功",

        "success": true,

        "data": {

          "mobile": "13800138000",

          "msgId": "1604771323839586305"

        }

      },

      {

        "code": 200,

        "msg": "操作成功",

        "success": true,

        "data": {

          "mobile": "13800138001",

          "msgId": "1604771324938493953"

        }

      },

      {

        "code": 200,

        "msg": "操作成功",

        "success": true,

        "data": {

          "mobile": "13800138002",

          "msgId": "1604771327220195330"

        }

      }

    ]

  }

}

 

3.2.5.3. 结果码说明

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

 

3.3. 发送多条国内短信（变量不一致）

实现多条国内短信不同号码不同变量信息的发送。

3.3.1. 接口协议

HTTP  POST

3.3.2. 接口方法

https://api.juncyun.com/api/msgService/sendMsgBatch

3.3.3. 报头定义

 

编码	列表	内容	备注
1）	Accept	application/json
2）	Content-Type	application/json;charset=utf-8

 

3.3.4. 请求参数

3.3.4.1. 请求参数列表

 

编码	列表	内容	备注
1）	accessKey	API调用账号（必填，从云极平台获取）
2）	accessSecret	API调用密钥（必填，从云极平台获取）
3）	signCode	短信签名code（必填）
4）	templateCode	短信模版code（必填）
5）	phoneParam	目标手机号，模板变量（必填，多个变量以英文逗号分隔）
6）	msgType	短信类型（必填, Integer类型） 1：验证码；2：短信通知；3：会员营销；4：推广短信
7）	taskId	自定义任务 id （非必填）

 

3.3.4.2. 请求参数示例

{

"accessKey": "NDYw*******",

"accessSecret": "MDQyOTQ1OTM3*********************",

"signCode": "b1d8acef",

"templateCode": "65c1b941",

"phoneParam": {

"159****0517":"张三,1234",

"181****6194":"李四,5678"

},

"msgType": 2,

"taskId": "squis*****dsai"

}

 

3.3.5. 响应参数

3.3.5.1. 响应参数列表

编码	列表	内容	备注
1）	code	状态码200则为成功
2）	msg	状态说明
3）	success	处理是否成功:取值范围 true，false
4）	data	业务数据在平台发送明细-任务详情查看

 

3.3.5.2. 响应参数示例

{

  "code": 200,

  "msg": "操作成功",

  "success": true,

  "data": null

}

 

3.3.5.3. 结果码说明

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

 

 

3.4. 企业路由器或FROM表单请求API

企业路由器实现国内短信的发送。

3.4.1. 接口协议

HTTP  POST

3.4.2. 接口方法

https://api.juncyun.com/api/msgService/sendMessageByFormData

3.4.3. 报头定义

 

编码	列表	内容	备注
1）	Content-Type	application/x-www-from-urlencoded

 

3.4.4. 请求参数

3.4.4.1. 请求参数列表

 

编码	列表	内容	备注
1）	accessKey	API调用账号（必填，从云极平台获取）
2）	accessSecret	API调用密钥（必填，从云极平台获取）
3）	signCode	短信签名code（必填）
4）	templateCode	短信模版code（必填）
5）	code	验证码（有些品牌的路由器只支持code传输，所以如果是验证码类型的模版，可以直接使用code传输，可选）
6）	phone	手机号码（必填）
7）	msgType	短信类型：(1验证码2通知3营销)（必填）
8）	params	msgType字段为2通知3营销时，可选（模板中含变量params参数必填，若多个变量中间以英文逗号分隔）

 

3.4.4.2. 请求参数示例

accessKey=576e4*****&accessSecret=f968***&signCode=***&templateCode=***&code={CODE}&phone={PHONE}&msgType=1

或者

accessKey=576e4*****&accessSecret=f968***&signCode=***&templateCode=***&params=["参数1","参数2"]&phone={PHONE}&msgType=2

 

3.4.5. 响应参数

3.4.5.1. 响应参数列表

编码	列表	内容	备注
1）	code	状态码200则为成功
2）	msg	状态说明
3）	success	处理是否成功:取值范围 true，false
4）	data	业务数据 如果失败则为空
5）	phone	发送目标手机号码
6）	msgId	消息id

 

3.4.5.2. 响应参数示例

{

  "code": 200,

  "msg": "操作成功",

  "success": true,

  "data": {

    "phone": "137xxxxxxxx",

    "msgId": "178999xxxxxxxxxx"

  }

}

 

3.4.5.3. 结果码说明

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