Send SMS Template

Request address

• API address(requestURI): /openapi/v1/sms/sendTemplate

Request parameters

Parameter name	Type	Requirement	Description
areaCode	String	R	Area code, required, number, length cannot exceed 10
receiver	String	R	Recipient's mobile phone number, required, number, length cannot exceed 20
templateId	String	R	Template ID, required, and cannot exceed 20
params	Map< String, String >	O	Template parameters, format: key is the name of the variable in the template, value is the value of the variable

Sample request

{
  "areaCode": "86",
  "receiver": "12345678901",
  "templateId": "1233",
  "params": {
    "name": "Tom",
    "code": "123456"
  }
}

Response parameters

Parameter name	Type	Requirement	Description
recordId	String	O	Send Record ID
sendStatus	int	O	Sending status, [0: To be sent, 1: Sending, 2: Sending successful, 3: Sending failed]
message	String	O	Send result

Sample response

{
  "code": 200,
  "msg": "success",
  "data": {
    "recordId": "20220408123456789",
    "sendStatus": "2",
    "message": "Sent successfully"
  }
}