Panduan integrasi

Otentikasi, isi parameter, dan kirim.

1. Otentikasi

Panggilan dari server Anda dengan api-key dan header Content-Type: application/json.

2. Memahami param dan placeholder

${code} mendapat tempat di template Anda. params.code memberikan nilai untuk pesan ini:

Templat · Pesan tempat
text
Kode Anda adalah ${code}, valid selama 5 menit.
Parameter · Berikan nilai
json
{ "params": { "code": "008848" } }
Pesan yang dilihat penerima Anda

Kode Anda adalah 008848, valid selama 5 menit.

Gunakan kode sebagai kunci, bukan ${code}, dan cocokkan kasus placeholder. Nilai harus berupa string yang hanya berisi angka, seperti "008848". Hilangkan params jika tidak ada placeholder.

3. Kirim SMS

POSThttps://api.starsg.ai/api/product/sms/send
BidangTipeDiperlukanApa yang harus dimasukkan
templateIdstringYaID template Anda yang disetujui, seperti SMS_0123456789. Pertahankan kasus.
countryCodestringYaKode panggilan negara atau wilayah, seperti "33" untuk Prancis, tanpa + dan terpisah dari telepon. Lihat daftar tujuan di bawah ini.
phonestringYaNomor telepon penerima tanpa kode panggilan negara.
paramsobject<string, string>Per templatNama placeholder dipetakan ke nilai sebenarnya, mis. {"code":"008848"}. Nilai defaultnya adalah string yang hanya berisi angka. Hilangkan jika template tidak memiliki placeholder.

Salin dan sesuaikan contoh ini

Contoh ini menggunakan kode panggilan Perancis, 33. Ganti kunci API, ID templat yang disetujui, dan penerima dengan nomor tes Anda sendiri, dan konfirmasikan tujuan tersedia.

bash
curl -X POST 'https://api.starsg.ai/api/product/sms/send' \
  -H 'api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "templateId": "SMS_0123456789",
    "countryCode": "33",
    "phone": "612345678",
    "params": { "code": "008848" }
  }'

Kirim objek JSON secara langsung: tanpa pembungkus badan atau tambahan /v1. Contoh ini menggunakan templat yang berisi ${code}.

4. Periksa hasilnya

Periksa kesuksesan terlebih dahulu. Simpan messageId (ID pesan saluran) dan resultId (kirim ID catatan) jika berhasil; periksa errorCode/errorMsg jika terjadi kegagalan. Pengiriman berhasil tidak mengkonfirmasi penerimaan di telepon.

Respon sukses
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Respon kesalahan
json
{
  "success": false,
  "data": null,
  "errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
  "errorMsg": "Template is awaiting review"
}

Kesalahan umum dan langkah selanjutnya

001Periksa bidang yang wajib diisi, JSON, kode negara, telepon, dan nilai string khusus digit di params.
END_USER_TEMPLATE_NOT_FOUNDPeriksa ID template lengkap dan kepemilikan oleh pengguna yang terkait dengan kunci API Anda.
END_USER_TEMPLATE_NOT_APPROVEDTunggu persetujuan template sebelum mengirim.
END_USER_TEMPLATE_REJECTEDBaca alasan penolakan dan terapkan dengan konten yang telah direvisi.
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCHBatas frekuensi tercapai. Kurangi tarif panggilan.
ENV_LIMITER / TEMPLATE_LIMITERPembatasan kebijakan lingkungan atau templat. Ikuti detail kesalahan dan hubungi dukungan.
SEND_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999Simpan kesalahan dan minta pengidentifikasi untuk dukungan. Jangan mengirim ulang secara membabi buta.
METERING_MISSINGSMS mungkin sudah terkirim, namun data pengukurannya hilang. Jangan mencoba lagi secara otomatis; simpan resultId dan hubungi dukungan.

Negara dan wilayah yang didukung

Periksa ketersediaan tujuan sebelum mengirim. Destinasi yang memerlukan registrasi SID akan segera hadir. Masukkan kode panggilan di bawah dalam Kode negara tanpa +, dan masukkan nomor telepon secara terpisah di telepon.

Negara / wilayahKode panggilanTersedianya
United States+1Segera hadir
Russia+7Segera hadir
Egypt+20Segera hadir
South Africa+27Tersedia
Greece+30Tersedia
Netherlands+31Tersedia
Belgium+32Tersedia
France+33Tersedia
Spain+34Tersedia
Hungary+36Tersedia
Italy+39Tersedia
Romania+40Tersedia
Switzerland+41Tersedia
Austria+43Tersedia
United Kingdom+44Segera hadir
Denmark+45Tersedia
Norway+47Tersedia
Sweden+46Tersedia
Poland+48Tersedia
Germany+49Tersedia
Peru+51Tersedia
Mexico+52Tersedia
Argentina+54Tersedia
Brazil+55Tersedia
Chile+56Tersedia
Colombia+57Tersedia
Venezuela+58Tersedia
Malaysia+60Tersedia
Australia+61Segera hadir
Indonesia+62Segera hadir
Philippines+63Segera hadir
New Zealand+64Tersedia
Singapore+65Segera hadir
Thailand+66Segera hadir
Japan+81Tersedia
South Korea+82Tersedia
Vietnam+84Segera hadir
China+86Segera hadir
Türkiye+90Segera hadir
India+91Tersedia
Pakistan+92Segera hadir
Afghanistan+93Segera hadir
Sri Lanka+94Segera hadir
Myanmar (Burma)+95Segera hadir
South Sudan+211Tersedia
Morocco+212Segera hadir
Algeria+213Tersedia
Tunisia+216Tersedia
Libya+218Segera hadir
Gambia+220Tersedia
Senegal+221Tersedia
Mauritania+222Segera hadir
Mali+223Segera hadir
Guinea+224Segera hadir
Côte d’Ivoire+225Tersedia
Burkina Faso+226Tersedia
Niger+227Tersedia
Togo+228Tersedia
Benin+229Segera hadir
Mauritius+230Segera hadir
Liberia+231Segera hadir
Sierra Leone+232Segera hadir
Ghana+233Segera hadir
Nigeria+234Segera hadir
Chad+235Segera hadir
Central African Republic+236Tersedia
Cameroon+237Segera hadir
Cape Verde+238Tersedia
São Tomé & Príncipe+239Tersedia
Equatorial Guinea+240Tersedia
Gabon+241Tersedia
Congo - Brazzaville+242Tersedia
Congo - Kinshasa+243Tersedia
Angola+244Tersedia
Guinea-Bissau+245Segera hadir
British Indian Ocean Territory+246Tersedia
Ascension Island+247Tersedia
Seychelles+248Tersedia
Sudan+249Segera hadir
Rwanda+250Segera hadir
Ethiopia+251Segera hadir
Somalia+252Tersedia
Djibouti+253Tersedia
Kenya+254Segera hadir
Tanzania+255Segera hadir
Uganda+256Segera hadir
Burundi+257Tersedia
Mozambique+258Tersedia
Zambia+260Segera hadir
Madagascar+261Tersedia
Réunion+262Tersedia
Zimbabwe+263Tersedia
Namibia+264Tersedia
Malawi+265Segera hadir
Lesotho+266Tersedia
Botswana+267Tersedia
Eswatini+268Tersedia
Comoros+269Tersedia
St. Helena+290Tersedia
Eritrea+291Tersedia
Aruba+297Tersedia
Faroe Islands+298Tersedia
Greenland+299Tersedia
Gibraltar+350Tersedia
Portugal+351Tersedia
Luxembourg+352Tersedia
Ireland+353Tersedia
Iceland+354Tersedia
Albania+355Tersedia
Malta+356Tersedia
Cyprus+357Tersedia
Finland+358Tersedia
Bulgaria+359Tersedia
Lithuania+370Tersedia
Latvia+371Tersedia
Estonia+372Tersedia
Moldova+373Tersedia
Armenia+374Segera hadir
Belarus+375Segera hadir
Andorra+376Tersedia
Monaco+377Tersedia
San Marino+378Tersedia
Ukraine+380Tersedia
Serbia+381Tersedia
Montenegro+382Tersedia
Kosovo+383Tersedia
Croatia+385Tersedia
Slovenia+386Tersedia
Bosnia & Herzegovina+387Tersedia
North Macedonia+389Tersedia
Czechia+420Segera hadir
Slovakia+421Tersedia
Liechtenstein+423Tersedia
Falkland Islands+500Tersedia
Belize+501Tersedia
Guatemala+502Tersedia
El Salvador+503Tersedia
Honduras+504Tersedia
Nicaragua+505Tersedia
Costa Rica+506Tersedia
Panama+507Tersedia
Saint Pierre and Miquelon+508Tersedia
Haiti+509Tersedia
Guadeloupe+590Tersedia
Bolivia+591Tersedia
Guyana+592Tersedia
Ecuador+593Tersedia
French Guiana+594Tersedia
Paraguay+595Tersedia
Martinique+596Tersedia
Suriname+597Tersedia
Uruguay+598Tersedia
Caribbean Netherlands (including Curaçao)+599Tersedia
Timor-Leste+670Tersedia
Norfolk Island+672Tersedia
Brunei+673Tersedia
Nauru+674Tersedia
Papua New Guinea+675Tersedia
Tonga+676Tersedia
Solomon Islands+677Tersedia
Vanuatu+678Tersedia
Fiji+679Tersedia
Palau+680Tersedia
Wallis & Futuna+681Tersedia
Cook Islands+682Tersedia
Niue+683Tersedia
Samoa+685Tersedia
Kiribati+686Tersedia
New Caledonia+687Tersedia
Tuvalu+688Tersedia
French Polynesia+689Tersedia
Tokelau+690Tersedia
Micronesia+691Tersedia
Marshall Islands+692Tersedia
Hong Kong, China+852Segera hadir
Macao, China+853Tersedia
Cambodia+855Segera hadir
Laos+856Tersedia
Bangladesh+880Tersedia
Taiwan, China+886Tersedia
Maldives+960Tersedia
Lebanon+961Tersedia
Jordan+962Segera hadir
Iraq+964Tersedia
Kuwait+965Segera hadir
Saudi Arabia+966Segera hadir
Yemen+967Segera hadir
Oman+968Segera hadir
Palestine+970Segera hadir
United Arab Emirates+971Segera hadir
Israel+972Tersedia
Bahrain+973Tersedia
Qatar+974Segera hadir
Bhutan+975Tersedia
Mongolia+976Tersedia
Nepal+977Segera hadir
Tajikistan+992Tersedia
Turkmenistan+993Tersedia
Azerbaijan+994Tersedia
Georgia+995Tersedia
Kyrgyzstan+996Tersedia
Uzbekistan+998Tersedia
Bahamas+1242Tersedia
Barbados+1246Tersedia
Anguilla+1264Tersedia
Antigua & Barbuda+1268Tersedia
British Virgin Islands+1284Tersedia
U.S. Virgin Islands+1340Tersedia
Cayman Islands+1345Tersedia
Bermuda+1441Tersedia
Grenada+1473Tersedia
Turks & Caicos Islands+1649Tersedia
Montserrat+1664Tersedia
Northern Mariana Islands+1670Tersedia
Guam+1671Tersedia
American Samoa+1684Tersedia
Sint Maarten+1721Tersedia
St. Lucia+1758Tersedia
Dominica+1767Tersedia
Puerto Rico+1787Tersedia
Dominican Republic+1809Tersedia
Trinidad & Tobago+1868Tersedia
St. Kitts & Nevis+1869Tersedia
Jamaica+1876Tersedia