SMS Retrieve Balance

Retrieves the current account balance.

URL

Request Method

  • POST

Request Header

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

Request Examples

curl --location --request POST 'http://sgapi.yoni-tech.com/v1/sms/balance' \
--header 'content-type: application/json' \
--header 'X-API-Key: Hs42eBZ6vuTR7oBSs3zq7HscgiAr6Y252Y5BbzrbKoI='
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
Request request = new Request.Builder()
  .url("http://sgapi.yoni-tech.com/v1/sms/balance")
  .post(null)
  .addHeader("content-type", "application/json")
  .addHeader("X-API-Key", "Hs42eBZ6vuTR7oBSs3zq7HscgiAr6Y252Y5BbzrbKoI=")
  .build();

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

Response Example

{
    "code": "0",
    "message": "success",
    "data": {
        "balance": "5.7201",
        "currency": "CNY"
    }
}

Response Result

NameTypeDescription
codeStringYONI-TECH's respense code (error codes)
messageStringdescribe the result
dataObjectobj contain balance、currency
data.balanceStringthe current account balance
data.currencyStringprice currency (ISO 4217 currency code)