SMS Batch Send

Send batch outbound text messages.

URL

• http://sgapi.yoni-tech.com/v1/sms/send/batch

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/send/batch \
     --header 'content-type: application/json' \
     --header 'X-API-Key: Hs42eBZ6vuTR7oBSs3zq7HscgiAr6Y252Y5BbzrbKoI=' \
     --data '
{
  "senderId": "Brand",
  "mobile": "62xxxxxxxxx0,63xxxxxxxxx1,63xxxxxxxxx2",
  "msg": "To know a lot about us please click this link https://www.yoni-tech.com."
}
'

Java

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"senderId\":\"Brand\",\"mobile\":\"62xxxxxxxxx0,63xxxxxxxxx1,63xxxxxxxxx2\",\"msg\":\"To know a lot about us please click this link https://www.yoni-tech.com.\"}");
Request request = new Request.Builder()
  .url("http://sgapi.yoni-tech.com/v1/sms/send/batch")
  .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
mobile	no	String	to phone numebrs (country code + number，e.g.,62xxxxxxxx0,62xxxxxxxx1)，separate numbers with commas (,)
msg	no	String	content, must urlencode(UTF-8) max length 3000
senderId	yes	String	sender

Response Example

JSON

{
    "code": "0",
    "message": "success",
    "data": {
        "errorPhone": [
            "63xxxxxxxxx1",
            "63xxxxxxxxx2"
        ],
        "batchId": "M100000001_2403181102_167"
    }
}

Response Result

Name	Type	Description
code	String	YONI-TECH's respense code (error codes)
message	String	describe the result
data	Object	obj contain errorPhone、batchId
data.batchId	String	unique identifier for this batch text messages
data.errorPhone	Array	phone numbers that failed to submit