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:

Şablon · Yer ayırt
text
Kodunuz ${code} olup, 5 dakika boyunca geçerlidir.
Parametreler · Bir değer girin
json
{ "params": { "code": "008848" } }
Alıcınızın gördüğü mesaj

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

POSThttps://api.starsg.ai/api/product/sms/send
AlanTürGerekliNe girilmeli
templateIdstringEvetSMS_0123456789 gibi onaylanmış şablon kimliğiniz. Davayı koruyun.
countryCodestringEvetFransa için "33" gibi, + işareti olmayan ve telefondan ayrı olan ülke veya bölge arama kodu. Aşağıdaki hedef listesine bakın.
phonestringEvetÜlke arama kodu olmadan alıcının telefon numarası.
paramsobject<string, string>Şablon başınaGerç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.

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" }
  }'

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.

Başarı yanıtı
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Hata yanıtı
json
{
  "success": false,
  "data": null,
  "errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
  "errorMsg": "Template is awaiting review"
}

Yaygın hatalar ve sonraki adımlar

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