Receive SMS signature review status reports through HTTP batch push-Short Message Service(SMS)-阿里云帮助中心

You can specify an HTTP URL to receive SMS signature review status reports. When the review status of a signature changes, the platform pushes the status details to your URL. Your endpoint must accept the message and respond in the required format.

Usage instructions

To receive SMS signature review status reports using HTTP push, go to the Short Message Service console. Enable the Receive Signature Review Status Messages option and configure a Receiving Address. For more information, see Receipt message configuration.

Parameters

The request parameters are sent in a JSON array format. Each request contains only one SMS signature review status report.

Protocol description

Parameter	Description
Request protocol	HTTP
Request format	application/json
Encoding	UTF-8

Parameter example

[
  {
    "sign_source": "Official Account",
    "reason": "test",
    "sign_name": "SMS Signature Template 1957",
    "orderId": "200****5184",
    "sign_status": "approved",
    "remark": "test",
    "sign_scene": "SMS_123123242",
    "create_date": "2019-05-30 19:58:25"
  }
]

Field descriptions

Name	Type	Required	Example value	Description
sign_source	String	Yes	Official Account	Signature source.
reason	String	Yes	test	Rejection reason.
sign_name	String	Yes	SMS Signature Template 1957	Signature name.
orderId	String	Yes	200****5184	The ticket number for the signature review.
sign_status	String	Yes	approved	The review status of the signature. Valid values: approving: Under review. approved: Approved. rejected: Rejected.
remark	String	No	test	Request description.
sign_scene	String	Yes	SMS_123123242	Applicable scenario.
create_date	String	Yes	2019-05-30 19:58:25	The date and time when the signature was created.

Response description

After your HTTP endpoint receives a request, you must return a response in the following format.

Response example

{
  "code" : 0,
  "msg" : "Accepted successfully"
}

Field descriptions

Name	Type	Required	Example	Description
code	Number	Yes	0	Acknowledgement code. The system only checks if the code is a number and does not validate its content.
msg	String	No	Accepted successfully	Description.

Note

If the HTTP status code is 200, the request is successful. If the HTTP status code is not 200 or a timeout occurs, the system retries the push.
If a system error or consumption failure occurs, return an HTTP 50X status code.

Push retries

If a push fails, the system retries after 1 minute, 5 minutes, and 10 minutes. If the push still fails after these three attempts, the system does not retry.

Report receiving example

@PostMapping("/resMsg")
public JSONObject resMsg(@RequestBody JSONArray array) {
   // TODO: You must process the delivery receipt message. This example only prints the receipt information.
   System.out.println(array.toJSONString());
   JSONObject json = new JSONObject();
   json.put("code", 0);
   json.put("msg", "Received successfully");
   return json;
}