You are on page 1of 8

API URL Documentation

TCASTSMS Gateway
Update: April 2016

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
Menggunakan Software TCASTSMS untuk mengirimkan Pesan SMS

TCASTSMS memperkenalkan API HTTP SMS di TCASTSMS Gateway untuk mengatasi kebutuhan dari komunitas
pengembang software SMS. TCASTSMS HTTP API menyediakan lebih banyak fitur, fleksibilitas dan kesederhanaan. Ini
dirancang dalam rangka membantu pengembang menjadi lebih produktif dan dapat menambahkan fungsionalitas SMS ke
setiap proyek secara efisien. Penjelasan dibawah ini memberikan Anda dokumentasi HTTP SMS API.

TCASTSMS Gateway telah dibangun di webserver. Untuk mengirim pesan SMS Anda bisa mengirimkannya menggunakan
permintaan HTTP (Gambar 1). Untuk mengirim pesan SMS Anda Anda hanya dapat memanggil URL (HTTP GET) atau
Anda dapat menggunakan metode HTTP POST.

Menggunakan Software TCASTSMS untuk mengirimkan Pesan SMS

HTTP Request
(GET/POST)

Pesan SMS
HTPP Response
TCASTSMS Gateway + Your
Modem GSM Application

(Gambar 1). Kirim pesan SMS melalui built in webserver

Menggunakan Software TCASTSMS untuk Mengambil Pesan SMS yang masuk

Ketika pesan SMS masuk ke TCASTSMS gateway, akan disimpan dalam folder pesan, disebut SMS Masuk. Jika Anda ingin
memeriksa pesan SMS yang masuk salah satu pilihan Anda adalah untuk men-download isi dari kotak masuk folder
menggunakan HTTP, kemudian mendapatkan laporan berupa JSON RESPON

Jika Anda ingin memproses pesan SMS yang masuk segera setelah mereka tiba untuk sistem Anda, Anda mungkin ingin
setup pengguna HTTP Client di TCASTSMS Gateway. Client HTTP ini dapat meneruskan pesan masuk ke aplikasi web
Anda (s) sebagai HTTP GET atau permintaan HTTP POST (Gambar 2).

Menggunakan Software TCASTSMS untuk Mengambil Pesan SMS yang masuk

HTTP Request
(POST)
SMS Request

SMS Response HTPP Response Your Web


Mobile User TCASTSMS Gateway + Application
Modem GSM

(Gambar 2). HTTP Post pada SMS yang masuk

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
KETENTUAN KONFIGURASI

 Create Database Name WAJIB: tcastapiv3.


 Name Folder Script BEBAS (boleh di rename)
 Jika name folder di rename, maka link url api juga berubah, mengikuti name foldernya.
(http://<ipserver>/<name_folder>/)

Penjelasan TCASTSMS API URL Standalone

1. MENGIRIM SMS dari MODEM:

Fungsi : Untuk mengirimkan SMS dari Simcard ke Server SMS Operator


URL : http://<ipserver>/<name_folder>/TCastAPIV3Send.php
Method : GET / POST

Paramerter:
msisdn(required): nomor tujuan pengiriman, format: 62xxx
untuk multi msisdn dipisah dengan ttik koma (;)
sms : isi sms yang akan di kirimkan (dalam urlencode)
flash (optional) : tipe smsnya flash (1) atau bukan (0), default : 0
port (optional) : nomor port yang akan mengirim sms, default : 0 (random)

Respon Server (json):


status:
id_trx : ID Unik dalam database, berguna untuk parameter pengecekan status sms
sts : (1: sukses, 2: gagal)
keterangan : (informasi sukses dan error dari server)

Note:
Sts=1 (SUKSES) disini adalah berhasil input data ke table message_out

Contoh1:
Fungsi: Kirim sms dari port manapun yang ready dan active Send

http://localhost:9870/tcastapiv3sa/TCastAPIV3Send.php?msisdn=6281210100055&sms=Test1-API-Send-SMS-Single

Balasan:
{"6281210100055":{"id_trx":"2","sts":"1","keterangan":"SUKSES"}}

Contoh2:
Fungsi: Kirim SMS Single dari port 11

http://localhost:9870/tcastapiv3sa/TCastAPIV3Send.php?msisdn=6281210100055&sms=Test1-API-Send-SMS-Single-via-
Port-11&port=11

Balasan:
{"6281210100055":{"id_trx":"3","sts":"1","keterangan":"SUKSES"}}

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
Contoh3:
Fungsi: Kirim SMS multi msisdn dipisah dengan titik koma (;)

http://localhost:9870/tcastapiv3sa/TCastAPIV3Send.php?msisdn=6281210100055;6281908080709;6281586605432&sms=T
est1-API-Send-SMS-Multi-MSISDN

Balasan:
{"6281210100055":{"id_trx":"4","sts":"1","keterangan":"SUKSES"},"6281908080709":{"id_trx":"5","sts":"1","keterangan":"SUK
SES"},"6281586605432":{"id_trx":"6","sts":"1","keterangan":"SUKSES"}}

Contoh4:
Fungsi: Kirim sms flash (popup saja, tidak langsung masuk ke inbox gadget)

http://localhost:9870/tcastapiv3sa/TCastAPIV3Send.php?msisdn=6281210100055&sms=Test1-API-Send-SMS-
Flash&flash=1

Balasan:
{"6281210100055":{"id_trx":"7","sts":"1","keterangan":"SUKSES"}}

Contoh5:
Fungsi: Pesan Error jika Kirim sms multi msisdn pemisahnya adalah , (koma) atau msisdn dianggap aneh

http://localhost:9870/tcastapiv3sa/TCastAPIV3Send.php?msisdn=6281210100055,6281908080709,6281586605432&sms=T
est1-API-Send-SMS-Multi-MSISDN

Balasan:
{"6281210100055,6281908080709,6281586605432":{"id_trx":"0","sts":"3","keterangan":"MSISDN tidak valid."}}

Contoh6:
Fungsi: Kirim SMS dengan menggunakan simcard yang
1. tidak pulsa
2. terblokir
3. modem rusak (led tidak kedip, tidak dapat sinyal)
4. simcard dalam masa tenggang,
5. simcard pasca bayar belum dibayar

Sample pengiriman ini nantinya untuk mengecek status Pengiriman SMS

http://localhost:9870/tcastapiv3sa/TCastAPIV3Send.php?msisdn=6281210100055&sms=Test1-API-Send-SMS-Pakai-
Simcard-Habis-Pulsa

Balasan:
{"6281210100055":{"id_trx":"11","sts":"1","keterangan":"SUKSES"}}

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
2. MENGECEK STATUS PENGIRIMAN

Fungsi : Untuk mengecek status pengiriman Simcard ke Server Operator


URL : http://<ipserver>/<name_folder>/TCastAPIV3Sts.php
Method : GET / POST

Paramerter:
id (required) : ID Unik yang didapat setelah pengiriman TCastAPISend
untuk multi id dipisah dengan ttik koma (;)

Respon server (json)


id : nomor hp yang di request
waktu : time stamp kirim sms
msisdn : nomor hp tujuan, format :+62xxx
sms : isi sms.
flash : tipe sms (0=flash tidak aktif; 1= flash aktif)
sts : (0: dalam antrian, 1: suskes, 2: gagal, 5: dalam proses pengiriman)

Contoh1:
Fungsi: Mengecek status pengiriman id tertentu

http://localhost:9870/tcastapiv3sa/TCastAPIV3Sts.php?id=11

Balasan:
{"11":{"waktu":"2016-02-26 14:09:52","msisdn":"+6281210100055","sms":"Test1-API-Send-SMS-
Single","flash":"0","sts":"1","ket":"SUKSES"}}

Contoh balasan ketika sedang tahap pengiriman:

{"23":{"waktu":"2016-02-26 14:10:50","msisdn":"+6281210100055","sms":"Test1-API-Send-SMS-Pakai-Simcard-Habis-
Pulsa","flash":"0","sts":"5","ket":"PROCESS"}}

Contoh2:
Contoh respon hasil pengecekan pengiriman SMS yang gagal, karena simcard yang ada pada modem bermasalah.
Merujuk pada Contoh6 pada Point 1 (MENGIRIM SMS dengan MODEM)

http://localhost:9870/tcastapiv3sa/TCastAPIV3Sts.php?id=11

Balasan
{"11":{"waktu":"2016-02-26 15:02:47","msisdn":"+6281210100055","sms":"Test1-API-Send-SMS-Pakai-Simcard-Habis-
Pulsa","flash":"0","sts":"2","ket":"GAGAL"}}

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
3. MENGECEK DELIVERY MESSAGE

Fungsi : Mengecek status pengiriman SMS dari Server Operator ke GADGET / nomor tujuan
URL : http://<ipserver>/<name_folder>/TCastAPIV3DeliveryReport.php
Method : GET / POST

Paramerter :
msisdn(required) : nomor tujuan penerima sms, format msisdn: 08xx, 62xx (recomended),
+62xx, untuk multi MSISDN dipisah dengan Petik Koma (;), Contoh
msisdn=08xx;62xx;+62xx
jml (optional) : jumlah (n) data terakhir, default 50
dta (optional) : tanggal awal, format: yyyy-mm-dd
dtz (optional) : tanggal akhir, format: yyyy-mm-dd

Respon server (json):


msisdn : Nomor HP Tujuan
dwaktu : Waktu diterima / delivery
modem : Modem Yang menerima delivery report
sts : status (1: "Terkirim ke Tujuan", 2: "Pengiriman GAGAL")
ket : keterangan delivery report

Contoh1:
Lihat status delivered terhadap nomor tertentu
http://localhost:9870/tcastapiv3sa/TCastAPIV3DeliveryReport.php?msisdn=6281210100055

Balasan:
{"+6281210100055":[{"waktu":"2016-02-26 14:16:19","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"},{"waktu":"2016-02-26
14:15:34","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"},{"waktu":"2016-02-26
14:11:35","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"},{"waktu":"2016-02-26
14:09:58","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"}]}

Contoh2:
Fungsi: Status delivered contoh nomor hp yang sudah tidak aktif
http://localhost:9870/tcastapiv3sa/TCastAPIV3DeliveryReport.php?msisdn=6281363069776

Balasan:
{"+6281363069776":[{"waktu":"2016-02-26 14:54:55","modem":"11","sts":2,"ket":"Pengiriman GAGAL"}]}

Contoh3:
Fungsi: Melihat status delivered terhadap msisdn pada tanggal tertentu
http://localhost:9870/tcastapiv3sa/TCastAPIV3DeliveryReport.php?msisdn=6281210100055&dta=2016-02-26

Balasan:
{"+6281210100055":[{"waktu":"2016-02-26 14:16:19","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"},{"waktu":"2016-02-26
14:15:34","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"},{"waktu":"2016-02-26
14:11:35","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"}]}

Contoh4:
Lihat status delivered tampilkan sebanyak jumlah 2 dari tanggal sekian sampai sekian
http://localhost:9870/tcastapiv3sa/TCastAPIV3DeliveryReport.php?jml=2&dta=2016-02-25&dtz=2016-02-26

Balasan:
{"+6281210100055":[{"waktu":"2016-02-26 14:16:19","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"},{"waktu":"2016-02-26
14:15:34","modem":"11","sts":1,"ket":"Terkirim ke Tujuan"}]}

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
4. MENGECEK SMS YANG MASUK:

Fungsi : Mengecek SMS yang masuk ke Simcard Modem


URL : http://<ipserver>/<name_folder>/TCastAPIV3SMSIN.php
Method : GET / POST

Paramerter (optional):
dta : (tanggal awal sms masuk, termasuk tanggal yang disebutkan, format: yyyy-mm-dd)
dtz : (tanggal akhir sms masuk, termasuk tanggal yang disebutkan, format : yyyy-mm-dd)
sts : status sms baru (0=belum dibaca) atau yang sudah pernah di ambil lewat api url,
(1=sudah dibaca)
jml : jumlah sms yag akan di tampilkan (default 50)
port : nomor port yang menerima sms, default : 0 (random)

Respon server (JSON):


id : id unik sms masuk
waktu : yyyy-mm-dd hh:mm:ss
msisdn : nomor pengirim, format: +62xxx
sms : isi sms
modem : nomor port modem yang menerima sms.

Contoh 1:
Fungsi: Tampilkan 50 (default) SMS Masuk yang belum dibaca

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=0

Balasan:
{"15":{"waktu":"2016-02-15
18:14:50","msisdn":"+6281908080709","sms":"Test13+sms+masuk","modem":"13"},"14":{"waktu":"2016-02-15
18:14:42","msisdn":"+6281908080709","sms":"Test12+sms+masuk","modem":"13"},"13":{"waktu":"2016-02-15
18:14:38","msisdn":"+6281908080709","sms":"Test11+sms+masuk","modem":"13"},"12":{"waktu":"2016-02-15
18:14:35","msisdn":"+6281908080709","sms":"Test10+sms+masuk","modem":"13"},"11":{"waktu":"2016-02-15
18:14:29","msisdn":"+6281908080709","sms":"Test9+sms+masuk","modem":"13"},"10":{"waktu":"2016-02-15
18:14:21","msisdn":"+6281908080709","sms":"Test8+sms+masuk","modem":"13"},"9":{"waktu":"2016-02-15
18:14:15","msisdn":"+6281908080709","sms":"Test7+sms+masuk","modem":"13"},"8":{"waktu":"2016-02-15
18:14:12","msisdn":"+6281908080709","sms":"Test6+sms+masuk","modem":"13"},"7":{"waktu":"2016-02-15
18:14:03","msisdn":"+6281908080709","sms":"Test5+sms+masuk","modem":"13"},"6":{"waktu":"2016-02-15
18:13:55","msisdn":"+6281908080709","sms":"Test5+sms+masuk","modem":"13"},"5":{"waktu":"2016-02-15
18:13:49","msisdn":"+6281908080709","sms":"Test4+sms+masuk","modem":"13"},"4":{"waktu":"2016-02-15
18:13:43","msisdn":"+6281908080709","sms":"Test3+sms+masuk","modem":"13"}}

Contoh2:
Fungsi: Cek SMS Masuk yang belum dibaca, dengan tampikan jumlah 2 sms

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=0&jml=2

Balasan:
{"17":{"waktu":"2016-02-15
18:17:11","msisdn":"+6281908080709","sms":"Test16+sms+masuk","modem":"13"},"16":{"waktu":"2016-02-15
18:17:00","msisdn":"+6281908080709","sms":"Test14+sms+masuk","modem":"13"}}

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com
Contoh3:
Fungsi: Cek SMS Masuk yang sudah dibaca (default 50SMS)

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=1

Balasan:
{"17":{"waktu":"2016-02-15
18:17:11","msisdn":"+6281908080709","sms":"Test16+sms+masuk","modem":"13"},"16":{"waktu":"2016-02-15
18:17:00","msisdn":"+6281908080709","sms":"Test14+sms+masuk","modem":"13"},"15":{"waktu":"2016-02-15
18:14:50","msisdn":"+6281908080709","sms":"Test13+sms+masuk","modem":"13"},"14":{"waktu":"2016-02-15
18:14:42","msisdn":"+6281908080709","sms":"Test12+sms+masuk","modem":"13"},"13":{"waktu":"2016-02-15
18:14:38","msisdn":"+6281908080709","sms":"Test11+sms+masuk","modem":"13"},"12":{"waktu":"2016-02-15
18:14:35","msisdn":"+6281908080709","sms":"Test10+sms+masuk","modem":"13"},"11":{"waktu":"2016-02-15
18:14:29","msisdn":"+6281908080709","sms":"Test9+sms+masuk","modem":"13"},"10":{"waktu":"2016-02-15
18:13:49","msisdn":"+6281908080709","sms":"Test4+sms+masuk","modem":"13"},"4":{"waktu":"2016-02-15
18:13:43","msisdn":"+6281908080709","sms":"Test3+sms+masuk","modem":"13"},"3":{"waktu":"2016-02-15
17:38:16","msisdn":"+6281908080709","sms":"Test2+sms+masuk+lagi","modem":"13"},"2":{"waktu":"2016-02-15
17:38:08","msisdn":"+6281908080709","sms":"Test1+sms+masuk","modem":"13"},"1":{"waktu":"2016-02-15
17:28:13","msisdn":"KARTUHALO","sms":"Plg+Yth%2C+hadiahkan+beragam+paket+internet+mulai+harga+Rp+7rb+utk+ker
abat+%26+teman+Anda+%28pengguna+simPATI%2C+KartuAS+%26+LOOP%29.+Segera+hubungi+%2A363%2A10%23.+
SKB%2C+info+133","modem":"13"}}

Contoh4:
Fungsi: Cek SMS yang sudah dibaca, dengan tampikan jumlah 2

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=1&jml=2

Balasan:
{"17":{"waktu":"2016-02-15
18:17:11","msisdn":"+6281908080709","sms":"Test16+sms+masuk","modem":"13"},"16":{"waktu":"2016-02-15
18:17:00","msisdn":"+6281908080709","sms":"Test14+sms+masuk","modem":"13"},"15":{"waktu":"2016-02-15 1

Contoh5:
Cek SMS masuk yang belum dibaca, tampilkan jumlah sekian, pada tanggal sekian

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=0&jml=2&dta=2016-02-15

Contoh6:
Cek sms masuk yang sudah dibaca, tampilkan 5, tanggal sekian

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=1&jml=5&dta=2016-02-15

Contoh7:
Cek sms masuk yang sudah dibaca, tampilkan 5, dari tanggal sekian sampai sekian

http://localhost:9870/tcastapiv3sa/TCastAPIV3SMSIN.php?sts=1&jml=5&dta=2016-02-13&dtz=2016-02-15

Balasan:
All semua sms yg sdh di baca dari tangggal sekian smp sekian

TCASTSMS® GATEWAY
ADDRESS: JEPE 9 Building - Jalan Raya Ragunan No. 9 Jati Padang, Pasar Minggu Jakarta Selatan 12540 – Indonesia
PHONE: +62. 21- 7815328; +62. 21- 7823311 SMS/WA: +62 819 0808 0709 EMAIL: marketing@tcastsms.co.id BBM: TCASTSMS
WEB: www.SMSGatewayMurah.com | www.SMSMaskingMurah.com

You might also like