1.1 短信发送

URL

{domain}/open-api/sms/send

请求方式

POST

请求头

参数名	必选	类型	说明
Content-Type	是	string	application/json

请求体参数

参数名	必选	类型	说明
appId	是	string	Application APPID
param	是	string	Parameter body
sign	是	string	Signature

param 参数

参数名	必选	类型	长度	示例	说明
timestamp	是	long	-	1677495496979	毫秒时间戳
requestId	是	string	-	-	商户短信请求ID
bizType	是	string	-	-	业务类型： OTP、MARKETING
templateCode	是	string	-	-	短信模版ID
mobileNum	是	string	-	-	用户手机号，手机格式：06、08、09+8位数字（共10位）
templateParams	是	array	-	["包裹123","0812345678"]	短信内容参数（字符串数组），按顺序对应模板中的 %s 占位符。例如模板 %s已成功揽收，联系方式%s，参数为 ["包裹123","0812345678"]，则短信内容为 包裹123已成功揽收，联系方式0812345678。注意：数组元素必须是字符串类型

如何构造请求体

请求示例

{
  "appId": "xxxxx",
  "param": "{\"requestId\":\"REQ202601210001\",\"bizType\":\"OTP\",\"templateCode\":\"SMS_001\",\"mobileNum\":\"0812345678\",\"templateParams\":[\"Li Ning\",\"110120\"],\"timestamp\":1676017834369}",
  "sign": "xxxxx"
}

param 内容

{
  "requestId": "REQ202601210001",
  "bizType": "OTP",
  "templateCode": "SMS_001",
  "mobileNum": "0812345678",
  "templateParams": [
    "Li Ning",
    "110120"
  ],
  "timestamp": 1676017834369
}

响应参数

参数名	类型	说明
code	integer	response code
message	string	response message
data	Object	data

data参数

参数名	类型	说明
requestId	string	商户短信请求ID
smsId	string	Bluepay短信发送流水ID
bizType	string	业务类型： OTP、MARKETING
mobileNum	string	用户手机号，手机格式：06、08、09+8位数字（共10位）
templateCode	string	短信模版ID
smsContent	string	短信发送文案
smsStatus	string	短信发送状态 PENDING, SUCCESS, FAIL

响应示例

响应码集合

{
    "code": 10000,
    "message": "Success",
    "data": {
      "requestId": "REQ202601210001",
      "smsId": "SMS000000001",
      "bizType": "MARKETING",
      "mobileNum": "0812345678",
      "templateCode": "SMS_001",
      "smsContent": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "smsStatus": "PENDING"
    }
}