Entegrasyon kılavuzu
Kimlik doğrulayın, parametreleri doldurun ve gönderin.
1. Kimlik doğrulama
API-key ve Content-Type: application/json başlıkları ile sunucunuzdan çağrı yapın.
2. Paramları ve yer tutucuları anlama
${code} şablonunuzda bir yer ayırır. params.code bu mesajın değerini sağlar:
Kodunuz ${code} olup, 5 dakika boyunca geçerlidir.{ "params": { "code": "008848" } }Kodunuz 008848 olup, 5 dakika boyunca geçerlidir.
Anahtar olarak ${code} yerine kodu kullanın ve yer tutucunun durumunu eşleştirin. Değerler "008848" gibi yalnızca rakamdan oluşan dizeler olmalıdır. Yer tutucu yoksa parametreleri atlayın.
3. SMS gönder
https://api.starsg.ai/api/product/sms/send| Alan | Tür | Gerekli | Ne girilmeli |
|---|---|---|---|
| templateId | string | Evet | SMS_0123456789 gibi onaylanmış şablon kimliğiniz. Davayı koruyun. |
| countryCode | string | Evet | Fransa için "33" gibi, + işareti olmayan ve telefondan ayrı olan ülke veya bölge arama kodu. Aşağıdaki hedef listesine bakın. |
| phone | string | Evet | Ülke arama kodu olmadan alıcının telefon numarası. |
| params | object<string, string> | Şablon başına | Gerçek değerlerle eşlenen yer tutucu adları, ör. {"code":"008848"}. Değerler varsayılan olarak yalnızca rakamlardan oluşan dizelerdir. Şablonda yer tutucu yoksa atlayın. |
Bu örneği kopyalayıp özelleştirin
Bu örnekte Fransa'nın arama kodu 33 kullanılmaktadır. API anahtarını, onaylı şablon kimliğini ve alıcıyı kendi test numaranızla değiştirin ve hedefin kullanılabilir olduğunu onaylayın.
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" }
}'Bir JSON nesnesini doğrudan gönderin: gövde sarmalayıcı veya ekstra /v1. yok Bu örnekte ${code} içeren bir şablon kullanılıyor.
4. Sonucu kontrol edin
Önce başarıyı kontrol edin. Başarı durumunda messageId'yi (kanal mesaj kimliği) ve resultId'yi (kayıt kimliğini gönder) kaydedin; Arıza durumunda errorCode/errorMsg'yi inceleyin. Başarılı bir şekilde gönderme, telefonda alındığını onaylamaz.
{
"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"
}Yaygın hatalar ve sonraki adımlar
001 | Paramlardaki zorunlu alanları, JSON'yi, ülke kodunu, telefonu ve yalnızca rakamlardan oluşan dize değerlerini kontrol edin. |
END_USER_TEMPLATE_NOT_FOUND | API anahtarınızla ilişkili kullanıcının tam şablon kimliğini ve sahipliğini kontrol edin. |
END_USER_TEMPLATE_NOT_APPROVED | Göndermeden önce şablon onayını bekleyin. |
END_USER_TEMPLATE_REJECTED | Red nedenini okuyun ve revize edilen içerikle başvurun. |
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCH | Frekans sınırına ulaşıldı. Arama hızını azaltın. |
ENV_LIMITER / TEMPLATE_LIMITER | Ortam veya şablon ilkesi kısıtlaması. Hata ayrıntılarını takip edin ve destek ekibiyle iletişime geçin. |
SEND_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999 | Hatayı kaydedin ve destek için tanımlayıcıları isteyin. Körü körüne yeniden göndermeyin. |
METERING_MISSING | SMS zaten gönderilmiş olabilir ancak ölçüm verileri eksik. Otomatik olarak yeniden denemeyin; resultId'yi kaydedin ve desteğe başvurun. |
Desteklenen ülkeler ve bölgeler
Göndermeden önce hedefin kullanılabilirliğini kontrol edin. SID kaydı gerektiren yerler çok yakında geliyor. Aşağıdaki arama kodunu + olmadan ülke koduna girin ve telefon numarasını telefona ayrı olarak girin.
| Ülke / bölge | Arama kodu | Kullanılabilirlik |
|---|---|---|
| United States | +1 | Yakında gelecek |
| Russia | +7 | Yakında gelecek |
| Egypt | +20 | Yakında gelecek |
| South Africa | +27 | Mevcut |
| Greece | +30 | Mevcut |
| Netherlands | +31 | Mevcut |
| Belgium | +32 | Mevcut |
| France | +33 | Mevcut |
| Spain | +34 | Mevcut |
| Hungary | +36 | Mevcut |
| Italy | +39 | Mevcut |
| Romania | +40 | Mevcut |
| Switzerland | +41 | Mevcut |
| Austria | +43 | Mevcut |
| United Kingdom | +44 | Yakında gelecek |
| Denmark | +45 | Mevcut |
| Norway | +47 | Mevcut |
| Sweden | +46 | Mevcut |
| Poland | +48 | Mevcut |
| Germany | +49 | Mevcut |
| Peru | +51 | Mevcut |
| Mexico | +52 | Mevcut |
| Argentina | +54 | Mevcut |
| Brazil | +55 | Mevcut |
| Chile | +56 | Mevcut |
| Colombia | +57 | Mevcut |
| Venezuela | +58 | Mevcut |
| Malaysia | +60 | Mevcut |
| Australia | +61 | Yakında gelecek |
| Indonesia | +62 | Yakında gelecek |
| Philippines | +63 | Yakında gelecek |
| New Zealand | +64 | Mevcut |
| Singapore | +65 | Yakında gelecek |
| Thailand | +66 | Yakında gelecek |
| Japan | +81 | Mevcut |
| South Korea | +82 | Mevcut |
| Vietnam | +84 | Yakında gelecek |
| China | +86 | Yakında gelecek |
| Türkiye | +90 | Yakında gelecek |
| India | +91 | Mevcut |
| Pakistan | +92 | Yakında gelecek |
| Afghanistan | +93 | Yakında gelecek |
| Sri Lanka | +94 | Yakında gelecek |
| Myanmar (Burma) | +95 | Yakında gelecek |
| South Sudan | +211 | Mevcut |
| Morocco | +212 | Yakında gelecek |
| Algeria | +213 | Mevcut |
| Tunisia | +216 | Mevcut |
| Libya | +218 | Yakında gelecek |
| Gambia | +220 | Mevcut |
| Senegal | +221 | Mevcut |
| Mauritania | +222 | Yakında gelecek |
| Mali | +223 | Yakında gelecek |
| Guinea | +224 | Yakında gelecek |
| Côte d’Ivoire | +225 | Mevcut |
| Burkina Faso | +226 | Mevcut |
| Niger | +227 | Mevcut |
| Togo | +228 | Mevcut |
| Benin | +229 | Yakında gelecek |
| Mauritius | +230 | Yakında gelecek |
| Liberia | +231 | Yakında gelecek |
| Sierra Leone | +232 | Yakında gelecek |
| Ghana | +233 | Yakında gelecek |
| Nigeria | +234 | Yakında gelecek |
| Chad | +235 | Yakında gelecek |
| Central African Republic | +236 | Mevcut |
| Cameroon | +237 | Yakında gelecek |
| Cape Verde | +238 | Mevcut |
| São Tomé & Príncipe | +239 | Mevcut |
| Equatorial Guinea | +240 | Mevcut |
| Gabon | +241 | Mevcut |
| Congo - Brazzaville | +242 | Mevcut |
| Congo - Kinshasa | +243 | Mevcut |
| Angola | +244 | Mevcut |
| Guinea-Bissau | +245 | Yakında gelecek |
| British Indian Ocean Territory | +246 | Mevcut |
| Ascension Island | +247 | Mevcut |
| Seychelles | +248 | Mevcut |
| Sudan | +249 | Yakında gelecek |
| Rwanda | +250 | Yakında gelecek |
| Ethiopia | +251 | Yakında gelecek |
| Somalia | +252 | Mevcut |
| Djibouti | +253 | Mevcut |
| Kenya | +254 | Yakında gelecek |
| Tanzania | +255 | Yakında gelecek |
| Uganda | +256 | Yakında gelecek |
| Burundi | +257 | Mevcut |
| Mozambique | +258 | Mevcut |
| Zambia | +260 | Yakında gelecek |
| Madagascar | +261 | Mevcut |
| Réunion | +262 | Mevcut |
| Zimbabwe | +263 | Mevcut |
| Namibia | +264 | Mevcut |
| Malawi | +265 | Yakında gelecek |
| Lesotho | +266 | Mevcut |
| Botswana | +267 | Mevcut |
| Eswatini | +268 | Mevcut |
| Comoros | +269 | Mevcut |
| St. Helena | +290 | Mevcut |
| Eritrea | +291 | Mevcut |
| Aruba | +297 | Mevcut |
| Faroe Islands | +298 | Mevcut |
| Greenland | +299 | Mevcut |
| Gibraltar | +350 | Mevcut |
| Portugal | +351 | Mevcut |
| Luxembourg | +352 | Mevcut |
| Ireland | +353 | Mevcut |
| Iceland | +354 | Mevcut |
| Albania | +355 | Mevcut |
| Malta | +356 | Mevcut |
| Cyprus | +357 | Mevcut |
| Finland | +358 | Mevcut |
| Bulgaria | +359 | Mevcut |
| Lithuania | +370 | Mevcut |
| Latvia | +371 | Mevcut |
| Estonia | +372 | Mevcut |
| Moldova | +373 | Mevcut |
| Armenia | +374 | Yakında gelecek |
| Belarus | +375 | Yakında gelecek |
| Andorra | +376 | Mevcut |
| Monaco | +377 | Mevcut |
| San Marino | +378 | Mevcut |
| Ukraine | +380 | Mevcut |
| Serbia | +381 | Mevcut |
| Montenegro | +382 | Mevcut |
| Kosovo | +383 | Mevcut |
| Croatia | +385 | Mevcut |
| Slovenia | +386 | Mevcut |
| Bosnia & Herzegovina | +387 | Mevcut |
| North Macedonia | +389 | Mevcut |
| Czechia | +420 | Yakında gelecek |
| Slovakia | +421 | Mevcut |
| Liechtenstein | +423 | Mevcut |
| Falkland Islands | +500 | Mevcut |
| Belize | +501 | Mevcut |
| Guatemala | +502 | Mevcut |
| El Salvador | +503 | Mevcut |
| Honduras | +504 | Mevcut |
| Nicaragua | +505 | Mevcut |
| Costa Rica | +506 | Mevcut |
| Panama | +507 | Mevcut |
| Saint Pierre and Miquelon | +508 | Mevcut |
| Haiti | +509 | Mevcut |
| Guadeloupe | +590 | Mevcut |
| Bolivia | +591 | Mevcut |
| Guyana | +592 | Mevcut |
| Ecuador | +593 | Mevcut |
| French Guiana | +594 | Mevcut |
| Paraguay | +595 | Mevcut |
| Martinique | +596 | Mevcut |
| Suriname | +597 | Mevcut |
| Uruguay | +598 | Mevcut |
| Caribbean Netherlands (including Curaçao) | +599 | Mevcut |
| Timor-Leste | +670 | Mevcut |
| Norfolk Island | +672 | Mevcut |
| Brunei | +673 | Mevcut |
| Nauru | +674 | Mevcut |
| Papua New Guinea | +675 | Mevcut |
| Tonga | +676 | Mevcut |
| Solomon Islands | +677 | Mevcut |
| Vanuatu | +678 | Mevcut |
| Fiji | +679 | Mevcut |
| Palau | +680 | Mevcut |
| Wallis & Futuna | +681 | Mevcut |
| Cook Islands | +682 | Mevcut |
| Niue | +683 | Mevcut |
| Samoa | +685 | Mevcut |
| Kiribati | +686 | Mevcut |
| New Caledonia | +687 | Mevcut |
| Tuvalu | +688 | Mevcut |
| French Polynesia | +689 | Mevcut |
| Tokelau | +690 | Mevcut |
| Micronesia | +691 | Mevcut |
| Marshall Islands | +692 | Mevcut |
| Hong Kong, China | +852 | Yakında gelecek |
| Macao, China | +853 | Mevcut |
| Cambodia | +855 | Yakında gelecek |
| Laos | +856 | Mevcut |
| Bangladesh | +880 | Mevcut |
| Taiwan, China | +886 | Mevcut |
| Maldives | +960 | Mevcut |
| Lebanon | +961 | Mevcut |
| Jordan | +962 | Yakında gelecek |
| Iraq | +964 | Mevcut |
| Kuwait | +965 | Yakında gelecek |
| Saudi Arabia | +966 | Yakında gelecek |
| Yemen | +967 | Yakında gelecek |
| Oman | +968 | Yakında gelecek |
| Palestine | +970 | Yakında gelecek |
| United Arab Emirates | +971 | Yakında gelecek |
| Israel | +972 | Mevcut |
| Bahrain | +973 | Mevcut |
| Qatar | +974 | Yakında gelecek |
| Bhutan | +975 | Mevcut |
| Mongolia | +976 | Mevcut |
| Nepal | +977 | Yakında gelecek |
| Tajikistan | +992 | Mevcut |
| Turkmenistan | +993 | Mevcut |
| Azerbaijan | +994 | Mevcut |
| Georgia | +995 | Mevcut |
| Kyrgyzstan | +996 | Mevcut |
| Uzbekistan | +998 | Mevcut |
| Bahamas | +1242 | Mevcut |
| Barbados | +1246 | Mevcut |
| Anguilla | +1264 | Mevcut |
| Antigua & Barbuda | +1268 | Mevcut |
| British Virgin Islands | +1284 | Mevcut |
| U.S. Virgin Islands | +1340 | Mevcut |
| Cayman Islands | +1345 | Mevcut |
| Bermuda | +1441 | Mevcut |
| Grenada | +1473 | Mevcut |
| Turks & Caicos Islands | +1649 | Mevcut |
| Montserrat | +1664 | Mevcut |
| Northern Mariana Islands | +1670 | Mevcut |
| Guam | +1671 | Mevcut |
| American Samoa | +1684 | Mevcut |
| Sint Maarten | +1721 | Mevcut |
| St. Lucia | +1758 | Mevcut |
| Dominica | +1767 | Mevcut |
| Puerto Rico | +1787 | Mevcut |
| Dominican Republic | +1809 | Mevcut |
| Trinidad & Tobago | +1868 | Mevcut |
| St. Kitts & Nevis | +1869 | Mevcut |
| Jamaica | +1876 | Mevcut |