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:
Kode Anda adalah ${code}, valid selama 5 menit.{ "params": { "code": "008848" } }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
https://api.starsg.ai/api/product/sms/send| Bidang | Tipe | Diperlukan | Apa yang harus dimasukkan |
|---|---|---|---|
| templateId | string | Ya | ID template Anda yang disetujui, seperti SMS_0123456789. Pertahankan kasus. |
| countryCode | string | Ya | Kode panggilan negara atau wilayah, seperti "33" untuk Prancis, tanpa + dan terpisah dari telepon. Lihat daftar tujuan di bawah ini. |
| phone | string | Ya | Nomor telepon penerima tanpa kode panggilan negara. |
| params | object<string, string> | Per templat | Nama 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.
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.
{
"success": true,
"data": {
"messageId": "channel-message-id",
"resultId": 9
},
"errorCode": null,
"errorMsg": null
}{
"success": false,
"data": null,
"errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
"errorMsg": "Template is awaiting review"
}Kesalahan umum dan langkah selanjutnya
001 | Periksa bidang yang wajib diisi, JSON, kode negara, telepon, dan nilai string khusus digit di params. |
END_USER_TEMPLATE_NOT_FOUND | Periksa ID template lengkap dan kepemilikan oleh pengguna yang terkait dengan kunci API Anda. |
END_USER_TEMPLATE_NOT_APPROVED | Tunggu persetujuan template sebelum mengirim. |
END_USER_TEMPLATE_REJECTED | Baca alasan penolakan dan terapkan dengan konten yang telah direvisi. |
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCH | Batas frekuensi tercapai. Kurangi tarif panggilan. |
ENV_LIMITER / TEMPLATE_LIMITER | Pembatasan kebijakan lingkungan atau templat. Ikuti detail kesalahan dan hubungi dukungan. |
SEND_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999 | Simpan kesalahan dan minta pengidentifikasi untuk dukungan. Jangan mengirim ulang secara membabi buta. |
METERING_MISSING | SMS 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 / wilayah | Kode panggilan | Tersedianya |
|---|---|---|
| United States | +1 | Segera hadir |
| Russia | +7 | Segera hadir |
| Egypt | +20 | Segera hadir |
| South Africa | +27 | Tersedia |
| Greece | +30 | Tersedia |
| Netherlands | +31 | Tersedia |
| Belgium | +32 | Tersedia |
| France | +33 | Tersedia |
| Spain | +34 | Tersedia |
| Hungary | +36 | Tersedia |
| Italy | +39 | Tersedia |
| Romania | +40 | Tersedia |
| Switzerland | +41 | Tersedia |
| Austria | +43 | Tersedia |
| United Kingdom | +44 | Segera hadir |
| Denmark | +45 | Tersedia |
| Norway | +47 | Tersedia |
| Sweden | +46 | Tersedia |
| Poland | +48 | Tersedia |
| Germany | +49 | Tersedia |
| Peru | +51 | Tersedia |
| Mexico | +52 | Tersedia |
| Argentina | +54 | Tersedia |
| Brazil | +55 | Tersedia |
| Chile | +56 | Tersedia |
| Colombia | +57 | Tersedia |
| Venezuela | +58 | Tersedia |
| Malaysia | +60 | Tersedia |
| Australia | +61 | Segera hadir |
| Indonesia | +62 | Segera hadir |
| Philippines | +63 | Segera hadir |
| New Zealand | +64 | Tersedia |
| Singapore | +65 | Segera hadir |
| Thailand | +66 | Segera hadir |
| Japan | +81 | Tersedia |
| South Korea | +82 | Tersedia |
| Vietnam | +84 | Segera hadir |
| China | +86 | Segera hadir |
| Türkiye | +90 | Segera hadir |
| India | +91 | Tersedia |
| Pakistan | +92 | Segera hadir |
| Afghanistan | +93 | Segera hadir |
| Sri Lanka | +94 | Segera hadir |
| Myanmar (Burma) | +95 | Segera hadir |
| South Sudan | +211 | Tersedia |
| Morocco | +212 | Segera hadir |
| Algeria | +213 | Tersedia |
| Tunisia | +216 | Tersedia |
| Libya | +218 | Segera hadir |
| Gambia | +220 | Tersedia |
| Senegal | +221 | Tersedia |
| Mauritania | +222 | Segera hadir |
| Mali | +223 | Segera hadir |
| Guinea | +224 | Segera hadir |
| Côte d’Ivoire | +225 | Tersedia |
| Burkina Faso | +226 | Tersedia |
| Niger | +227 | Tersedia |
| Togo | +228 | Tersedia |
| Benin | +229 | Segera hadir |
| Mauritius | +230 | Segera hadir |
| Liberia | +231 | Segera hadir |
| Sierra Leone | +232 | Segera hadir |
| Ghana | +233 | Segera hadir |
| Nigeria | +234 | Segera hadir |
| Chad | +235 | Segera hadir |
| Central African Republic | +236 | Tersedia |
| Cameroon | +237 | Segera hadir |
| Cape Verde | +238 | Tersedia |
| São Tomé & Príncipe | +239 | Tersedia |
| Equatorial Guinea | +240 | Tersedia |
| Gabon | +241 | Tersedia |
| Congo - Brazzaville | +242 | Tersedia |
| Congo - Kinshasa | +243 | Tersedia |
| Angola | +244 | Tersedia |
| Guinea-Bissau | +245 | Segera hadir |
| British Indian Ocean Territory | +246 | Tersedia |
| Ascension Island | +247 | Tersedia |
| Seychelles | +248 | Tersedia |
| Sudan | +249 | Segera hadir |
| Rwanda | +250 | Segera hadir |
| Ethiopia | +251 | Segera hadir |
| Somalia | +252 | Tersedia |
| Djibouti | +253 | Tersedia |
| Kenya | +254 | Segera hadir |
| Tanzania | +255 | Segera hadir |
| Uganda | +256 | Segera hadir |
| Burundi | +257 | Tersedia |
| Mozambique | +258 | Tersedia |
| Zambia | +260 | Segera hadir |
| Madagascar | +261 | Tersedia |
| Réunion | +262 | Tersedia |
| Zimbabwe | +263 | Tersedia |
| Namibia | +264 | Tersedia |
| Malawi | +265 | Segera hadir |
| Lesotho | +266 | Tersedia |
| Botswana | +267 | Tersedia |
| Eswatini | +268 | Tersedia |
| Comoros | +269 | Tersedia |
| St. Helena | +290 | Tersedia |
| Eritrea | +291 | Tersedia |
| Aruba | +297 | Tersedia |
| Faroe Islands | +298 | Tersedia |
| Greenland | +299 | Tersedia |
| Gibraltar | +350 | Tersedia |
| Portugal | +351 | Tersedia |
| Luxembourg | +352 | Tersedia |
| Ireland | +353 | Tersedia |
| Iceland | +354 | Tersedia |
| Albania | +355 | Tersedia |
| Malta | +356 | Tersedia |
| Cyprus | +357 | Tersedia |
| Finland | +358 | Tersedia |
| Bulgaria | +359 | Tersedia |
| Lithuania | +370 | Tersedia |
| Latvia | +371 | Tersedia |
| Estonia | +372 | Tersedia |
| Moldova | +373 | Tersedia |
| Armenia | +374 | Segera hadir |
| Belarus | +375 | Segera hadir |
| Andorra | +376 | Tersedia |
| Monaco | +377 | Tersedia |
| San Marino | +378 | Tersedia |
| Ukraine | +380 | Tersedia |
| Serbia | +381 | Tersedia |
| Montenegro | +382 | Tersedia |
| Kosovo | +383 | Tersedia |
| Croatia | +385 | Tersedia |
| Slovenia | +386 | Tersedia |
| Bosnia & Herzegovina | +387 | Tersedia |
| North Macedonia | +389 | Tersedia |
| Czechia | +420 | Segera hadir |
| Slovakia | +421 | Tersedia |
| Liechtenstein | +423 | Tersedia |
| Falkland Islands | +500 | Tersedia |
| Belize | +501 | Tersedia |
| Guatemala | +502 | Tersedia |
| El Salvador | +503 | Tersedia |
| Honduras | +504 | Tersedia |
| Nicaragua | +505 | Tersedia |
| Costa Rica | +506 | Tersedia |
| Panama | +507 | Tersedia |
| Saint Pierre and Miquelon | +508 | Tersedia |
| Haiti | +509 | Tersedia |
| Guadeloupe | +590 | Tersedia |
| Bolivia | +591 | Tersedia |
| Guyana | +592 | Tersedia |
| Ecuador | +593 | Tersedia |
| French Guiana | +594 | Tersedia |
| Paraguay | +595 | Tersedia |
| Martinique | +596 | Tersedia |
| Suriname | +597 | Tersedia |
| Uruguay | +598 | Tersedia |
| Caribbean Netherlands (including Curaçao) | +599 | Tersedia |
| Timor-Leste | +670 | Tersedia |
| Norfolk Island | +672 | Tersedia |
| Brunei | +673 | Tersedia |
| Nauru | +674 | Tersedia |
| Papua New Guinea | +675 | Tersedia |
| Tonga | +676 | Tersedia |
| Solomon Islands | +677 | Tersedia |
| Vanuatu | +678 | Tersedia |
| Fiji | +679 | Tersedia |
| Palau | +680 | Tersedia |
| Wallis & Futuna | +681 | Tersedia |
| Cook Islands | +682 | Tersedia |
| Niue | +683 | Tersedia |
| Samoa | +685 | Tersedia |
| Kiribati | +686 | Tersedia |
| New Caledonia | +687 | Tersedia |
| Tuvalu | +688 | Tersedia |
| French Polynesia | +689 | Tersedia |
| Tokelau | +690 | Tersedia |
| Micronesia | +691 | Tersedia |
| Marshall Islands | +692 | Tersedia |
| Hong Kong, China | +852 | Segera hadir |
| Macao, China | +853 | Tersedia |
| Cambodia | +855 | Segera hadir |
| Laos | +856 | Tersedia |
| Bangladesh | +880 | Tersedia |
| Taiwan, China | +886 | Tersedia |
| Maldives | +960 | Tersedia |
| Lebanon | +961 | Tersedia |
| Jordan | +962 | Segera hadir |
| Iraq | +964 | Tersedia |
| Kuwait | +965 | Segera hadir |
| Saudi Arabia | +966 | Segera hadir |
| Yemen | +967 | Segera hadir |
| Oman | +968 | Segera hadir |
| Palestine | +970 | Segera hadir |
| United Arab Emirates | +971 | Segera hadir |
| Israel | +972 | Tersedia |
| Bahrain | +973 | Tersedia |
| Qatar | +974 | Segera hadir |
| Bhutan | +975 | Tersedia |
| Mongolia | +976 | Tersedia |
| Nepal | +977 | Segera hadir |
| Tajikistan | +992 | Tersedia |
| Turkmenistan | +993 | Tersedia |
| Azerbaijan | +994 | Tersedia |
| Georgia | +995 | Tersedia |
| Kyrgyzstan | +996 | Tersedia |
| Uzbekistan | +998 | Tersedia |
| Bahamas | +1242 | Tersedia |
| Barbados | +1246 | Tersedia |
| Anguilla | +1264 | Tersedia |
| Antigua & Barbuda | +1268 | Tersedia |
| British Virgin Islands | +1284 | Tersedia |
| U.S. Virgin Islands | +1340 | Tersedia |
| Cayman Islands | +1345 | Tersedia |
| Bermuda | +1441 | Tersedia |
| Grenada | +1473 | Tersedia |
| Turks & Caicos Islands | +1649 | Tersedia |
| Montserrat | +1664 | Tersedia |
| Northern Mariana Islands | +1670 | Tersedia |
| Guam | +1671 | Tersedia |
| American Samoa | +1684 | Tersedia |
| Sint Maarten | +1721 | Tersedia |
| St. Lucia | +1758 | Tersedia |
| Dominica | +1767 | Tersedia |
| Puerto Rico | +1787 | Tersedia |
| Dominican Republic | +1809 | Tersedia |
| Trinidad & Tobago | +1868 | Tersedia |
| St. Kitts & Nevis | +1869 | Tersedia |
| Jamaica | +1876 | Tersedia |