国内短信接口文档

---

1.接口说明（单条短信）

名称	说明
协议	HTTPS POST
地址	https://api.cxlnk.com/api/msgService/sendSms
Accept	application/json
Content-Type	application/json;charset=utf-8

2.请求参数说明

响应 body 数据为 JSON 格式

列表	内容	备注
accessKey	API调用账号（必填，String类型，从灿星云平台获取）
accessSecret	API调用密钥（必填，String类型，从灿星云平台获取）
signCode	短信签名code（必填）
templateCode	短信模版code（必填）
mobile	目标手机号（必填，String类型）
params	参数（选填，List类型），若有参数则必填且参数需与所选模版中参数名称以及数量一致
msgType	短信类型（必填, Integer类型） 1：验证码；2：短信通知；3：会员营销；4：推广短信
taskId	自定义任务 id （非必填）

3.请求参数示例

{
 "accessKey": "NDYw*******",
 "accessSecret": "MDQyOTQ1OTM3*********************",
 "signCode": "b1d***",
 "templateCode": "65c***",
 "mobile": "13800138000",
 "params": [
	        "1234"
	 ],
 "msgType": 1,
 "taskId": "squis*****dsai"
}

4.响应参数列表

列表	内容	备注
code	状态码200则为成功
msg	状态说明
success	处理是否成功:取值范围 true，false
data	业务数据 如果失败则为空
mobile	手机号码
msgId	短信id

5.响应参数示例

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

6.结果码说明

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

7.接口说明（多条短信-变量一致）

名称	说明
协议	HTTPS POST
地址	https://api.cxlnk.com/api/msgService/sendSmsBatch
Accept	application/json
Content-Type	application/json;charset=utf-8

8.请求参数说明

响应 body 数据为 JSON 格式

列表	内容	备注
accessKey	API调用账号（必填，String类型，从灿星云平台获取）
accessSecret	API调用密钥（必填，String类型，从灿星云平台获取）
signCode	短信签名code（必填）
templateCode	短信模版code（必填）
mobile	目标手机号，多个手机号逗号隔开（必填，String类型）
params	参数（选填，List类型），若有参数则必填且参数需与所选模版中参数名称以及数量一致
msgType	短信类型（必填, Integer类型） 1：验证码；2：短信通知；3：会员营销；4：推广短信
taskId	自定义任务 id （非必填）

9.请求参数示例

{
 "accessKey": "NDYw*******",
 "accessSecret": "MDQyOTQ1OTM3*********************",
 "signCode": "b1***",
 "templateCode": "65c***",
 "mobile": "13800138000,13800138001,13800138002",
 "params": [
	        "1234"
			],
 "msgType": 1,
 "taskId": "squis*****dsai"
}

10.响应参数列表

列表	内容	备注
code	状态码200则为成功
msg	状态说明
success	处理是否成功:取值范围 true，false
data	业务数据 如果失败则为空
allNum	手机号码总数量
successNum	成功手机号数量
failNum	失败手机号数量
list	集合类型，元素为每条短信发送结果，字段具体涵义参考单条短信发送
code	状态码200则为成功
msg	状态说明
success	处理是否成功：取值范围 true，false
data	业务数据 如果失败则为空
mobile	手机号码
msgId	短信id

11.响应参数示例

{
 "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"
							}
				   }
	     ]
	}
}
											

12.结果码说明

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

13.接口说明（多条短信-变量不一致）

名称	说明
协议	HTTPS POST
地址	https://api.cxlnk.com/api/msgService/sendMsgBatch
Accept	application/json
Content-Type	application/json;charset=utf-8

14.请求参数说明

响应 body 数据为 JSON 格式

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

15.请求参数示例

{
 "accessKey": "NDYw*******",
 "accessSecret": "MDQyOTQ1OTM3*********************",
 "signCode": "b1***",
 "templateCode": "65c***",
 "phoneParam": {
	            "159****0517":"张三,1234",
				"181****6194":"李四,5678"
				},
 "msgType": 2,
 "taskId": "squis*****dsai"
}
					

16.响应参数列表

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

17.响应参数示例

{
 "code": 200,
 "msg": "操作成功",
 "success": true,
 "data":null
}
																

18.结果码说明

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