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 :
Votre code est ${code}, valable pour les minutes 5.{ "params": { "code": "008848" } }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
https://api.starsg.ai/api/product/sms/send| Champ | Type | Requis | Que saisir |
|---|---|---|---|
| templateId | string | Oui | Votre ID de modèle approuvé, tel que SMS_0123456789. Préserver le cas. |
| countryCode | string | Oui | Indicatif 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. |
| phone | string | Oui | Numéro de téléphone du destinataire sans l'indicatif du pays. |
| params | object<string, string> | Par modèle | Noms 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.
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.
{
"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"
}Erreurs courantes et étapes suivantes
001 | Vé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_FOUND | Vérifiez l'ID complet du modèle et la propriété de l'utilisateur associé à votre clé API. |
END_USER_TEMPLATE_NOT_APPROVED | Attendez l’approbation du modèle avant de l’envoyer. |
END_USER_TEMPLATE_REJECTED | Lisez le motif du refus et postulez avec le contenu révisé. |
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCH | Limite de fréquence atteinte. Réduisez le taux d’appel. |
ENV_LIMITER / TEMPLATE_LIMITER | Restriction 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 / 999 | Enregistrez l’erreur et demandez des identifiants pour obtenir de l’aide. Ne renvoyez pas aveuglément. |
MESURE_MISSING | Le 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égion | Code d'appel | Disponibilité |
|---|---|---|
| United States | +1 | À venir |
| Russia | +7 | À venir |
| Egypt | +20 | À venir |
| South Africa | +27 | Disponible |
| Greece | +30 | Disponible |
| Netherlands | +31 | Disponible |
| Belgium | +32 | Disponible |
| France | +33 | Disponible |
| Spain | +34 | Disponible |
| Hungary | +36 | Disponible |
| Italy | +39 | Disponible |
| Romania | +40 | Disponible |
| Switzerland | +41 | Disponible |
| Austria | +43 | Disponible |
| United Kingdom | +44 | À venir |
| Denmark | +45 | Disponible |
| Norway | +47 | Disponible |
| Sweden | +46 | Disponible |
| Poland | +48 | Disponible |
| Germany | +49 | Disponible |
| Peru | +51 | Disponible |
| Mexico | +52 | Disponible |
| Argentina | +54 | Disponible |
| Brazil | +55 | Disponible |
| Chile | +56 | Disponible |
| Colombia | +57 | Disponible |
| Venezuela | +58 | Disponible |
| Malaysia | +60 | Disponible |
| Australia | +61 | À venir |
| Indonesia | +62 | À venir |
| Philippines | +63 | À venir |
| New Zealand | +64 | Disponible |
| Singapore | +65 | À venir |
| Thailand | +66 | À venir |
| Japan | +81 | Disponible |
| South Korea | +82 | Disponible |
| Vietnam | +84 | À venir |
| China | +86 | À venir |
| Türkiye | +90 | À venir |
| India | +91 | Disponible |
| Pakistan | +92 | À venir |
| Afghanistan | +93 | À venir |
| Sri Lanka | +94 | À venir |
| Myanmar (Burma) | +95 | À venir |
| South Sudan | +211 | Disponible |
| Morocco | +212 | À venir |
| Algeria | +213 | Disponible |
| Tunisia | +216 | Disponible |
| Libya | +218 | À venir |
| Gambia | +220 | Disponible |
| Senegal | +221 | Disponible |
| Mauritania | +222 | À venir |
| Mali | +223 | À venir |
| Guinea | +224 | À venir |
| Côte d’Ivoire | +225 | Disponible |
| Burkina Faso | +226 | Disponible |
| Niger | +227 | Disponible |
| Togo | +228 | Disponible |
| 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 | +236 | Disponible |
| Cameroon | +237 | À venir |
| Cape Verde | +238 | Disponible |
| São Tomé & Príncipe | +239 | Disponible |
| Equatorial Guinea | +240 | Disponible |
| Gabon | +241 | Disponible |
| Congo - Brazzaville | +242 | Disponible |
| Congo - Kinshasa | +243 | Disponible |
| Angola | +244 | Disponible |
| Guinea-Bissau | +245 | À venir |
| British Indian Ocean Territory | +246 | Disponible |
| Ascension Island | +247 | Disponible |
| Seychelles | +248 | Disponible |
| Sudan | +249 | À venir |
| Rwanda | +250 | À venir |
| Ethiopia | +251 | À venir |
| Somalia | +252 | Disponible |
| Djibouti | +253 | Disponible |
| Kenya | +254 | À venir |
| Tanzania | +255 | À venir |
| Uganda | +256 | À venir |
| Burundi | +257 | Disponible |
| Mozambique | +258 | Disponible |
| Zambia | +260 | À venir |
| Madagascar | +261 | Disponible |
| Réunion | +262 | Disponible |
| Zimbabwe | +263 | Disponible |
| Namibia | +264 | Disponible |
| Malawi | +265 | À venir |
| Lesotho | +266 | Disponible |
| Botswana | +267 | Disponible |
| Eswatini | +268 | Disponible |
| Comoros | +269 | Disponible |
| St. Helena | +290 | Disponible |
| Eritrea | +291 | Disponible |
| Aruba | +297 | Disponible |
| Faroe Islands | +298 | Disponible |
| Greenland | +299 | Disponible |
| Gibraltar | +350 | Disponible |
| Portugal | +351 | Disponible |
| Luxembourg | +352 | Disponible |
| Ireland | +353 | Disponible |
| Iceland | +354 | Disponible |
| Albania | +355 | Disponible |
| Malta | +356 | Disponible |
| Cyprus | +357 | Disponible |
| Finland | +358 | Disponible |
| Bulgaria | +359 | Disponible |
| Lithuania | +370 | Disponible |
| Latvia | +371 | Disponible |
| Estonia | +372 | Disponible |
| Moldova | +373 | Disponible |
| Armenia | +374 | À venir |
| Belarus | +375 | À venir |
| Andorra | +376 | Disponible |
| Monaco | +377 | Disponible |
| San Marino | +378 | Disponible |
| Ukraine | +380 | Disponible |
| Serbia | +381 | Disponible |
| Montenegro | +382 | Disponible |
| Kosovo | +383 | Disponible |
| Croatia | +385 | Disponible |
| Slovenia | +386 | Disponible |
| Bosnia & Herzegovina | +387 | Disponible |
| North Macedonia | +389 | Disponible |
| Czechia | +420 | À venir |
| Slovakia | +421 | Disponible |
| Liechtenstein | +423 | Disponible |
| Falkland Islands | +500 | Disponible |
| Belize | +501 | Disponible |
| Guatemala | +502 | Disponible |
| El Salvador | +503 | Disponible |
| Honduras | +504 | Disponible |
| Nicaragua | +505 | Disponible |
| Costa Rica | +506 | Disponible |
| Panama | +507 | Disponible |
| Saint Pierre and Miquelon | +508 | Disponible |
| Haiti | +509 | Disponible |
| Guadeloupe | +590 | Disponible |
| Bolivia | +591 | Disponible |
| Guyana | +592 | Disponible |
| Ecuador | +593 | Disponible |
| French Guiana | +594 | Disponible |
| Paraguay | +595 | Disponible |
| Martinique | +596 | Disponible |
| Suriname | +597 | Disponible |
| Uruguay | +598 | Disponible |
| Caribbean Netherlands (including Curaçao) | +599 | Disponible |
| Timor-Leste | +670 | Disponible |
| Norfolk Island | +672 | Disponible |
| Brunei | +673 | Disponible |
| Nauru | +674 | Disponible |
| Papua New Guinea | +675 | Disponible |
| Tonga | +676 | Disponible |
| Solomon Islands | +677 | Disponible |
| Vanuatu | +678 | Disponible |
| Fiji | +679 | Disponible |
| Palau | +680 | Disponible |
| Wallis & Futuna | +681 | Disponible |
| Cook Islands | +682 | Disponible |
| Niue | +683 | Disponible |
| Samoa | +685 | Disponible |
| Kiribati | +686 | Disponible |
| New Caledonia | +687 | Disponible |
| Tuvalu | +688 | Disponible |
| French Polynesia | +689 | Disponible |
| Tokelau | +690 | Disponible |
| Micronesia | +691 | Disponible |
| Marshall Islands | +692 | Disponible |
| Hong Kong, China | +852 | À venir |
| Macao, China | +853 | Disponible |
| Cambodia | +855 | À venir |
| Laos | +856 | Disponible |
| Bangladesh | +880 | Disponible |
| Taiwan, China | +886 | Disponible |
| Maldives | +960 | Disponible |
| Lebanon | +961 | Disponible |
| Jordan | +962 | À venir |
| Iraq | +964 | Disponible |
| Kuwait | +965 | À venir |
| Saudi Arabia | +966 | À venir |
| Yemen | +967 | À venir |
| Oman | +968 | À venir |
| Palestine | +970 | À venir |
| United Arab Emirates | +971 | À venir |
| Israel | +972 | Disponible |
| Bahrain | +973 | Disponible |
| Qatar | +974 | À venir |
| Bhutan | +975 | Disponible |
| Mongolia | +976 | Disponible |
| Nepal | +977 | À venir |
| Tajikistan | +992 | Disponible |
| Turkmenistan | +993 | Disponible |
| Azerbaijan | +994 | Disponible |
| Georgia | +995 | Disponible |
| Kyrgyzstan | +996 | Disponible |
| Uzbekistan | +998 | Disponible |
| Bahamas | +1242 | Disponible |
| Barbados | +1246 | Disponible |
| Anguilla | +1264 | Disponible |
| Antigua & Barbuda | +1268 | Disponible |
| British Virgin Islands | +1284 | Disponible |
| U.S. Virgin Islands | +1340 | Disponible |
| Cayman Islands | +1345 | Disponible |
| Bermuda | +1441 | Disponible |
| Grenada | +1473 | Disponible |
| Turks & Caicos Islands | +1649 | Disponible |
| Montserrat | +1664 | Disponible |
| Northern Mariana Islands | +1670 | Disponible |
| Guam | +1671 | Disponible |
| American Samoa | +1684 | Disponible |
| Sint Maarten | +1721 | Disponible |
| St. Lucia | +1758 | Disponible |
| Dominica | +1767 | Disponible |
| Puerto Rico | +1787 | Disponible |
| Dominican Republic | +1809 | Disponible |
| Trinidad & Tobago | +1868 | Disponible |
| St. Kitts & Nevis | +1869 | Disponible |
| Jamaica | +1876 | Disponible |