SMS Pull DR

Pull the DR of text messages.

URL

• http://sgapi.yoni-tech.com/v1/sms/pull/dr

Request Method

• POST

Request Header

• content-type: application/json
• X-API-Key: apiKey

Request Examples

cURL

curl --request POST \
     --url http://sgapi.yoni-tech.com/v1/sms/pull/dr \
     --header 'content-type: application/json' \
     --header 'X-API-Key: Hs42eBZ6vuTR7oBSs3zq7HscgiAr6Y252Y5BbzrbKoI=' \
     --data '
{
  "count": "100"
}
'

Java

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"count\":\"100\"}");
Request request = new Request.Builder()
  .url("http://sgapi.yoni-tech.com/v1/sms/pull/dr")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("X-API-Key", "Hs42eBZ6vuTR7oBSs3zq7HscgiAr6Y252Y5BbzrbKoI=")
  .build();

Response response = client.newCall(request).execute();

Request Parameter

Name	Optional	Type	Description
count	no	String	DR number (the default is 20 and no more than 500)

Response Example

JSON

{
    "code": "0",
    "message": "success",
    "data": [
        {
            "batchId": "M100000001_2403181213_175",
            "requestTime": "20240318121358",
            "mobile": "62xxxxxxxxx",
            "msgid": "202403181213585018284393216",
            "reportTime": "20240318121300",
            "status": "DELIVRD"
        },
        {
            "batchId": "M100000001_2403181213_174",
            "requestTime": "20240318121357",
            "mobile": "62xxxxxxxxxx",
            "msgid": "202403181213575018235393216",
            "reportTime": "20240318121300",
            "status": "UNDELIV"
        }
    ]
}

Response Result

Name	Type	Description
code	String	YONI-TECH's respense code (error codes)
message	String	describe the result
data	Object	obj contain batchSeq、requestTime、notifyTime、mobile、msgid、reportTime、status
data.batchId	String	unique identifier for a batch text messages
data.requestTime	String	request time of message, format is yyyyMMddHHmmss
data.mobile	String	to phone numebr (country code + number，e.g.,62xxxxxxxxx)
data.msgid	String	unique identifier for this text message
data.reportTime	String	time of the message DR, format is yyyyMMddHHmmss
data.status	String	status of message (e.g: DELIVRD、UNDELIV、REJECTD、EXPIRED)