SMS Single Send

Send a outbound text message.

URL

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

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/single \
     --header 'content-type: application/json' \
     --header 'X-API-Key: Hs42eBZ6vuTR7oBSs3zq7HscgiAr6Y252Y5BbzrbKoI=' \
     --data '
{
  "senderId": "Brand",
  "mobile": "62xxxxxxxxxx",
  "msg": "Your verification code is 1234."
}
'

Java

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"senderId\":\"Brand\",\"mobile\":\"62xxxxxxxxxx\",\"msg\":\"Your verification code is 1234.\"}");
Request request = new Request.Builder()
  .url("http://sgapi.yoni-tech.com/v1/sms/send/single")
  .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 numebr (country code + number，e.g.,62xxxxxxxxx)
msg	no	String	content, must urlencode(UTF-8) max length 3000
senderId	yes	String	sender

Response Example

JSON

{
  "code": "0",
  "message": "success",
  "data": {
    "messageId": "2023020417303301200000000204"
  }
}

Response Result

Name	Type	Description
code	String	YONI-TECH's respense code (error codes)
message	String	describe the result
data	Object	obj contain messageId
data.messageId	String	unique identifier for this text message