Guide d'intégration

Authentifiez-vous, renseignez les paramètres et envoyez.

1. Authentification

Appelez depuis votre serveur avec la clé API et les en-têtes Content-Type : application/json.

2. Comprendre les paramètres et les espaces réservés

${code} réserve une place dans votre modèle. params.code fournit la valeur de ce message :

Modèle · Réserver une place
text
Votre code est ${code}, valable pour les minutes 5.
Paramètres · Fournir une valeur
json
{ "params": { "code": "008848" } }
Le message que votre destinataire voit

Votre code est 008848, valable pour les minutes 5.

Utilisez le code comme clé, et non ${code}, et faites correspondre la casse de l'espace réservé. Les valeurs doivent être des chaînes composées uniquement de chiffres, telles que « 008848 ». Omettez les paramètres s'il n'y a pas d'espace réservé.

3. Envoyer un SMS

POSThttps://api.starsg.ai/api/product/sms/send
ChampTypeRequisQue saisir
templateIdstringOuiVotre ID de modèle approuvé, tel que SMS_0123456789. Préserver le cas.
countryCodestringOuiIndicatif d'appel du pays ou de la région, tel que "33" pour la France, sans + et distinct du téléphone. Consultez la liste des destinations ci-dessous.
phonestringOuiNuméro de téléphone du destinataire sans l'indicatif du pays.
paramsobject<string, string>Par modèleNoms d'espace réservé mappés à des valeurs réelles, par ex. {"code":"008848"}. Les valeurs par défaut sont des chaînes composées uniquement de chiffres. Omettre si le modèle ne contient aucun espace réservé.

Copiez et personnalisez cet exemple

Cet exemple utilise l’indicatif d’appel de la France, 33. Remplacez la clé API, l'ID de modèle approuvé et le destinataire par votre propre numéro de test, et confirmez que la destination est disponible.

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

Envoyer directement un objet JSON : pas de wrapper de corps ni /v1. supplémentaire. Cet exemple utilise un modèle contenant ${code}.

4. Vérifiez le résultat

Vérifiez d'abord le succès. Enregistrez messageId (ID de message de canal) et resultId (ID d'enregistrement d'envoi) en cas de succès ; inspectez errorCode/errorMsg en cas d’échec. L'envoi réussi ne confirme pas la réception au téléphone.

Réponse réussie
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Réponse à l'erreur
json
{
  "success": false,
  "data": null,
  "errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
  "errorMsg": "Template is awaiting review"
}

Erreurs courantes et étapes suivantes

001Vérifiez les champs obligatoires, JSON, le code du pays, le téléphone et les valeurs de chaîne à chiffres uniquement dans les paramètres.
END_USER_TEMPLATE_NOT_FOUNDVérifiez l'ID complet du modèle et la propriété de l'utilisateur associé à votre clé API.
END_USER_TEMPLATE_NOT_APPROVEDAttendez l’approbation du modèle avant de l’envoyer.
END_USER_TEMPLATE_REJECTEDLisez le motif du refus et postulez avec le contenu révisé.
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCHLimite de fréquence atteinte. Réduisez le taux d’appel.
ENV_LIMITER / TEMPLATE_LIMITERRestriction de stratégie d’environnement ou de modèle. Suivez les détails de l’erreur et contactez l’assistance.
SEND_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999Enregistrez l’erreur et demandez des identifiants pour obtenir de l’aide. Ne renvoyez pas aveuglément.
MESURE_MISSINGLe SMS a peut-être déjà été envoyé, mais les données de comptage sont manquantes. Ne réessayez pas automatiquement ; enregistrez resultId et contactez l’assistance.

Pays et régions pris en charge

Vérifiez la disponibilité de la destination avant l'envoi. Les destinations nécessitant un enregistrement SID seront bientôt disponibles. Entrez l'indicatif d'appel ci-dessous dans countryCode sans + et entrez le numéro de téléphone séparément dans phone.

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