1.1 SMS Send

URL

{domain}/open-api/sms/send

Method

POST

Request Header

Parameter name	Required	Type of data	Description
Content-Type	Y	string	application/json

Request Param

Parameter name	Required	Type of data	Description
appId	Y	string	Application APPID
param	Y	string	Parameter body
sign	Y	string	Signature

Request Param

Parameter name	Required	Type of data	Length	Example	Description
timestamp	Y	long	-	1677495496979	current timestamp
requestId	Y	string	-	-	Merchant Sms request ID
bizType	Y	string	-	-	Business Type： OTP、MARKETING
templateCode	Y	string	-	-	Sms Template ID
mobileNum	Y	string	-	-	User mobile number, format: 06, 08, 09 + 8 digits (10 digits in total)
templateParams	Y	array	-	["PKG123","0812345678"]	Sms Content Params (string array), corresponding to %s placeholders in the template in order. Example: template %s successfully picked up, contact %s, params ["PKG123","0812345678"], the result will be PKG123 successfully picked up, contact 0812345678. Note: array elements must be string type

How to construct request body

Request body

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

param example

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

Response example

paramter name	type	description
code	integer	response code
message	string	response message
data	Object	data

data参数

paramter name	type	description
requestId	string	Merchant Sms request ID
smsId	string	Bluepay Sms ID
bizType	string	Business Type： OTP、MARKETING
mobileNum	string	User mobile number, format: 06, 08, 09 + 8 digits (10 digits in total)
templateCode	string	Sms Template ID
smsContent	string	Sms Content
smsStatus	string	SMS Send status PENDING, SUCCESS, FAIL

Response example

code collection

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