文档系统

短信服务

1. 验证码申请

接口地址	authcode/v1/codeApply
请求类型	POST

业务请求参数

字段名称	字段描述	类型	必填	示例
appId	应用标识	String	是	APP_123456789
mobile	手机号	String	是	18512345678
deviceId	设备id	String	是
transId	交易流水号	String	是	0215648974
templateId	模板Id	String	是	17
param	短信内容	String	是	{}默认自带code变量。举例说明:示例模板{\“name\”:\”王先生\”,\“age\”:\”16\”}此模板可以不传code参数。
extension	扩展内容	String	否	{“key”:“value”}

1.1 请求报文示例

{

   “appId”:”APP_BAEA3A877DC446AFB6607927BCA8442D”,

   "deviceId" :"DEV_C2B9736BE7A94106A83E74EEA3EC9D68"

   “mobile”:”11111111111”,

   “transId“:"1920001",

   “templateId”: 17,

   “param”: {\“name\”:\”王先生\”,\“age\”:\”16\”}，

   “extension” ：“{isValidate":true}”

}

1.2 业务响应参数

字段名称	字段描述	类型	必填	示例
id	交易流水号	String	是	73
serialNo	序列号	String	是	1（如果该手机上次验证码未失效，此序列号将会依次自增）

1.3成功响应报文示例

{

   "status": 200, 

   "message": "SUCCESS",

   "data": { 

   "id": "74", 

   "serialNo": 1

​    }

}

1.4 失败响应报文示例

{ 

   "status": 10909999, 

   "message": "短信消息服务异常: 短信发送异常" 

}

1.5 错误码说明

错误码	错误码描述
60404001	请求参数错误
60404002	操作数据库异常
60499999	服务端异常
60404003	短信消息服务异常：%s
60404007	短信模版已下线或不存在
60404008	短信发送系统异常
60404009	请勿重复提交请求
60404010	短信发送数量限制
60404011	非法手机号
60404012	短信模版不合法
60404013	模版缺少变量
60404014	信息内容不合法
60404015	模板参数内容长度限制
60404016	账号余额不足
60404017	渠道接入失败
60404018	渠道服务关闭
60404019	请求后台服务失败

2. 验证码校验

接口地址	authcode/v1/validate
请求类型	post

2.1 业务请求参数

字段名称	字段描述	类型	必填	示例
appId	应用标识	String	是	APP_123456789
authCode	验证码	String	是	123456
mobile	手机号	String	是	18512345678
templateId	模板ID	String	是	17
transId	交易流水号	String	是	11(此次交易流水号)

2.2 请求报文示例

{
   "appId": "APP_BAEA3A877DC446AFB6607927BCA8442D",
   "authCode": "015885",
   "mobile": "18535325544",
   "templateId": "17",
   "transId": "83"
}

2.3 业务响应参数

字段名称	字段描述	类型	是否	示例
id	交易流水号	String	是	73

2.4 成功响应报文示例

{ 

   "status": 200, 

   "message": "SUCCESS",

   "data": {

   "id": "84"

   }

}

2.5 失败响应报文示例

{ 

   "status": 60400004,

   "message": "验证码不存在或已过期"

}

2.6 错误码说明

错误码	错误码描述
60404001	请求参数错误
60400004	验证码不存在或已过期
60400005	验证失败

3. 发送短信验证码不带模板

接口地址	authcode/v1/sendMsgNoTemplate
请求类型	post

3.1 业务请求参数

字段名称	字段描述	类型	是否必填	示例
appId	应用标识	String	是	APP_123456789
mobile	手机号	String	是	18512345678
deviceId	设备id	String	是
transId	交易流水号	String	是	0215648974
templateId	模板Id	String	否	17
param	短信内容	String	是	{“code”:”123456”}
extension	扩展内容	String	否	{“key”:“value”}
hasCode	是否自带验证码	String	是	Y或N注：1.接入方自己产生验证码（Y）时，上送参数param中必须带有{“code”:”123456”}，code的值即为需要发送给用户的验证码。2.传入N时，系统将随机生成验证码，上送param中参数不需要加code字段。3.传入Y时，将不能调用验证码验证接口

3.2 请求报文示例

{

   “appId”:”APP_BAEA3A877DC446AFB6607927BCA8442D”,

   "deviceId" :"DEV_C2B9736BE7A94106A83E74EEA3EC9D68"

   “mobile”:”11111111111”,

   “transId“:"1920001",

   “hasCode“:”Y”,

   “templateId”: 17,

   “param”: “{\“code\”:\”111111\”}”

}

3.3 业务响应参数

字段名称	字段描述	类型	是否必填	示例
id	交易流水号	String	是	73

3.4 成功响应报文示例

{

   "status": 200,

   "message": "SUCCESS",

   "data": {

   "id": "84"

   }

}

3.5 失败响应报文示例

{

   "status": 60404001, 

   "message": "请求参数错误"

}

3.6 错误码说明

错误码	错误码描述
60404001	请求参数错误
60404002	操作数据库异常
60499999	服务端异常
60404003	短信消息服务异常：%s
60404007	短信模版已下线或不存在
60404008	短信发送系统异常
60404009	请勿重复提交请求
60404010	短信发送数量限制
60404011	非法手机号
60404012	短信模版不合法
60404013	模版缺少变量
60404014	信息内容不合法
60404015	模板参数内容长度限制
60404016	账号余额不足
60404017	渠道接入失败
60404018	渠道服务关闭
60404019	请求后台服务失败

4. 发送短信验证码带模板 [ 已停用 ]

接口地址	authcode/sendMsgWithTemplate
请求类型	post

4.1 业务请求参数

字段名称	字段描述	类型	是否必填	示例
appId	应用标识	String	是	APP_123456789
mobile	手机号	String	是	18512345678
deviceId	设备id	String	是
transId	交易流水号	String	是	0215648974
templateId	模板Id	String	是	17
param	短信内容	String	是	{“code”:”123456”}
extension	扩展内容	String	否	{“key”:“value”}
hasCode	是否自带验证码	String	是	Y或N注：1.接入方自己产生验证码（Y）时，上送参数param中必须带有{“code”:”123456”}，code的值即为需要发送给用户的验证码。2.传入N时，系统将随机生成验证码，上送param中参数不需要加code字段。3.传入Y时，将不能调用验证码验证接口

请求报文示例

{

   “appId”:”APP_BAEA3A877DC446AFB6607927BCA8442D”,

   "deviceId" :"DEV_C2B9736BE7A94106A83E74EEA3EC9D68"

   “mobile”:”11111111111”,

   “transId“:"1920001",

   “hasCode“:”Y”,

   “templateId”: 17,

   “param”: “{\“code\”:\”111111\”}”

}

4.2 业务响应参数

字段名称	字段描述	类型	是否必填	示例
id	交易流水号	String	是	73

4.3成功响应报文示例

{

   "status": 200,

   "message": "SUCCESS",

   "data": {

   "id": "84"

   }

}

4.4 失败响应报文示例

{

   "status": 60404001,

   "message": "请求参数错误"

}

4.5 错误码说明

错误码	错误码描述
60404001	请求参数错误
60404002	操作数据库异常
60499999	服务端异常
60404003	短信消息服务异常：%s
60404007	短信模版已下线或不存在
60404008	短信发送系统异常
60404009	请勿重复提交请求
60404010	短信发送数量限制
60404011	非法手机号
60404012	短信模版不合法
60404013	模版缺少变量
60404014	信息内容不合法
60404015	模板参数内容长度限制
60404016	账号余额不足
60404017	渠道接入失败
60404018	渠道服务关闭
60404019	请求后台服务失败

5. 发送短信

（此接口不能调用验证码验证接口）

接口地址	authcode/sendmsg
请求类型	post

5.1业务请求参数

字段名称	字段描述	类型	是否必填	示例
appId	应用标识	String	是	APP_123456789
mobile	手机号	String	是	18512345678
deviceId	设备id	String	否
transId	交易流水号	String	是	0215648974
templateId	模板Id	String	是	17
param	短信内容	String	是	{“code”:”123456”}
extension	扩展内容	String	否	{“key”:“value”}

5.2 请求报文示例

{

   “appId”:”APP_BAEA3A877DC446AFB6607927BCA8442D”,

   "deviceId" :"DEV_C2B9736BE7A94106A83E74EEA3EC9D68"

   “mobile”:”11111111111”,

   “transId“:"1920001",

   “templateId”: 17,

   “param”: “{\“code\”:\”111111\”}”

}

5.3 业务响应参数

字段名称	字段描述	类型	是否必填	示例
id	交易流水号	String	是	73

5.4 成功响应报文示例

{

   "status": 200,

   "message": "SUCCESS",

   "data": {

   "id": "84"

   }

}

5.5 失败响应报文示例

{

   "status": 60404001,

   "message": "请求参数错误"

}

5.6 错误码说明

错误码	错误码描述
60404001	请求参数错误
60404002	操作数据库异常
60499999	服务端异常
60404003	短信消息服务异常：%s
60404007	短信模版已下线或不存在
60404008	短信发送系统异常
60404009	请勿重复提交请求
60404010	短信发送数量限制
60404011	非法手机号
60404012	短信模版不合法
60404013	模版缺少变量
60404014	信息内容不合法
60404015	模板参数内容长度限制
60404016	账号余额不足
60404017	渠道接入失败
60404018	渠道服务关闭
60404019	请求后台服务失败

6. 发送短信（定制）

（此接口不能调用验证码验证接口）

接口地址	msgcenter/v1/notify/sendMsg
请求类型	post

6.1 业务请求参数

字段名称	字段描述	类型	是否必填	示例
appId	应用标识	String	是	APP_123456789
mobile	手机号	String	是	18512345678
transId	交易流水号	String	是	0215648974
templateId	模板Id	String	是	17
param	短信内容	String	是	{“code”:”123456”}
thirdTraceId	第三方系统流水号	String	是	00123464646

6.2 请求报文示例

{

   “appId”:”APP_BAEA3A877DC446AFB6607927BCA8442D”,

   "deviceId" :"DEV_C2B9736BE7A94106A83E74EEA3EC9D68"

   “mobile”:”11111111111”,

   “transId“:"1920001",

   “templateId”: 17,

   “param”: “{\“code\”:\”111111\”}”，

   “thirdTraceId” : "00123464646"

}

6.3 业务响应参数

字段名称	字段描述	类型	是否必填	示例
id	交易流水号	String	是	73

6.4 成功响应报文示例

{

   "status": 200,

   "message": "SUCCESS",

   "data": {

   "id": "84"

   }

}

6.5 失败响应报文示例

{

   "status": 60404001,

   "message": "请求参数错误"

}

7. 运管对账接口

接口地址	authcode/sync
请求类型	post

7.1 业务请求参数

字段名称	字段描述	类型	是否必填	示例
operationCode	服务编号	String	是	a
startDate	开始日期	String	否	20200202
endDate	结束日期	String	否	20200202

7.2 业务响应参数

字段名称	字段描述	类型	是否必填	示例
platformId	平台Id	String	是	PF_123456
applicationId	应用编号	String	是	APP_123456
operationResult	操作结果	String	是	SUCCESS;FALI
toalNum	总记录数	int	是	2

注：此响应体为列表

7.3 错误码说明

错误码	错误码描述
60404001	请求参数错误
60404002	操作数据库异常
60499999	服务端异常
60404003	短信消息服务异常：%s
60404007	短信模版已下线或不存在
60404008	短信发送系统异常
60404009	请勿重复提交请求
60404010	短信发送数量限制
60404011	非法手机号
60404012	短信模版不合法
60404013	模版缺少变量
60404014	信息内容不合法
60404015	模板参数内容长度限制
60404016	账号余额不足
60404017	渠道接入失败
60404018	渠道服务关闭
60404019	请求后台服务失败