API Cek Pulsa SMS

Pada bagian ini akan dijelaskan mengenai penggunaan AYOSMS! SMS API, untuk meminta informasi sisa pulsa SMS.

Endpoint URL

Seluruh permintaan untuk mengirimkan SMS ke AYOSMS! SMS API harus ditujukan ke alamat URL sebagai berikut:
https://api.ayosms.com/mconnect/gw/balance.php

Input Parameters

Tabel berikut ini adalah daftar parameter bisa dikirimkan ke alamat URL diatas. Perhatikan bahwa parameter ini adalah WAJIB dikirimkan. Parameter ini bersifat case sensitive.
Parameter Deskripsi Contoh Nilai
api_key Wajib API Key di akun AYOSMS!. 11877c8e0ac231ca93ec2cfcbe1820eb

Balasan Pengiriman

SMS API AYOSMS! akan memberikan balasan dalam 2 bentuk:
  • HTTP Header Status (biasanya dalam bentuk kode 200 OK yang menunjukkan bahwa permintaan API sudah sukses diterima)
  • HTTP Content (dalam format JSON)

Balasan SMS Sukses

Standar balasan API SMS adalah kode status=1:
HTTP Header 200 OK
Content
{
balance : "100000",
currency : "IDR",
balance_expired : "2017-07-04 00:00:00",
status : "1",
}

Balasan Error: Account Suspended

HTTP Header 200 OK
Content
{
balance : "",
currency : "",
balance_expired : "2017-07-04 00:00:00",
status : 0,
error-text : "ERR001:account suspended"
}

Response Attributes

Parameter Deskripsi
status Kode status '1' menunjukkan permintaan sukses diterima, sedangkan '0' menunjukkan permintaan gagal diterima (untuk kode Error, silakan lihat penjelasannya dibawah)
balance Pulsa SMS dari akun yang sesuai dengan API Key yang dikirim ke API.
currency Kode mata uang dari pulsa SMS akun. (nilai yang mungkin muncul: IDR/USD/MYR/SGD/EUR/CNY/JPY)
balance_expired Waktu (GMT+7) yang menunjukkan kadaluarsa dari pulsa SMS akun.
error-text Kode error diikuti dengan penjelasannya

Balasan Kode Error

Kode Balasan Deskripsi
ERR001 akun user dibatalkan
ERR999 parameter "api_key" kosong

Contoh

Untuk mengetahui sisa pulsa SMS dari akun

https://api.ayosms.com/mconnect/gw/balance.php?api_key=your_unique_api_key
Parameter Value in Request Description
api_key your_unique_api_key Your AYOSMS! Account API Key
SMSMOO
AYOMOBILE!