国际短信接口文档


1.接口说明

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

2.请求参数说明

响应 body 数据为 JSON 格式

列表 内容 备注
accessKey API调用账号(必填,String类型,从灿星云平台获取)
accessSecret API调用密钥(必填,String类型,从灿星云平台获取)
msgType 短信类型(必填):1-验证码,2-短信通知,3-会员营销
templateCode 短信模版code(选填,模版code与内容二选一)
phone 目标手机号(必填)
params 参数(选填,map类型),若有参数则必填且参数需与所选模版中参数名称以及数量一致
msgContent 短信内容(选填,模版code与内容二选一)

3.请求参数示例

{
 "accessKey": "NDYw*******",
 "accessSecret": "MDQyOTQ1OTM3*********************",
 "msgType":1,
 "templateCode":"62pu****",
 "phone":"9113735886671",
 "params":[
	       {
			"code":"1234"
			}
		]
}

4.响应参数列表

列表 内容 备注
code 状态码200则为成功
msg 状态说明
success 处理是否成功:取值范围 true,false
data 业务数据 如果失败则为空
taskId 本次任务id
allNum 手机号码总数量

5.响应参数示例

{
 "code": 200,
 "msg": "成功",
 "success": true,
 "data":{
	     "taskId": "1545114656135451",
		 "allNum": 1
    }
}