Guida all'integrazione
Autenticarsi, inserire i parametri e inviare.
1. Autenticazione
Chiama dal tuo server con chiave API e intestazioni Content-Type: application/json.
2. Comprendere i parametri e i segnaposto
${code} riserva un posto nel tuo modello. params.code fornisce il valore per questo messaggio:
Il tuo codice è ${code}, valido per 5 minuti.{ "params": { "code": "008848" } }Il tuo codice è 008848, valido per 5 minuti.
Utilizza il codice come chiave, non ${code}, e abbina le maiuscole e minuscole al segnaposto. I valori devono essere stringhe di sole cifre, ad esempio "008848". Omettere i parametri se non sono presenti segnaposto.
3. Invia un SMS
https://api.starsg.ai/api/product/sms/send| Campo | Tipo | Necessario | Cosa inserire |
|---|---|---|---|
| templateId | string | SÌ | L'ID modello approvato, ad esempio SMS_0123456789. Conserva la custodia. |
| countryCode | string | SÌ | Prefisso telefonico del paese o della regione, ad esempio "33" per la Francia, senza + e separato dal telefono. Consulta l'elenco delle destinazioni di seguito. |
| phone | string | SÌ | Numero di telefono del destinatario senza prefisso internazionale. |
| params | object<string, string> | Per modello | Nomi dei segnaposto mappati su valori effettivi, ad es. {"code":"008848"}. Per impostazione predefinita i valori sono stringhe di sole cifre. Omettere se il modello non ha segnaposto. |
Copia e personalizza questo esempio
Questo esempio utilizza il codice chiamante della Francia, 33. Sostituisci la chiave API, l'ID modello approvato e il destinatario con il tuo numero di prova e conferma che la destinazione è disponibile.
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" }
}'Invia direttamente un oggetto JSON: nessun body wrapper o /v1. extra Questo esempio utilizza un modello contenente ${code}.
4. Controlla il risultato
Controlla prima il successo. Salva messageId (ID messaggio canale) e resultId (invia ID record) in caso di successo; controllare errorCode/errorMsg in caso di errore. L'invio riuscito non conferma la ricezione sul telefono.
{
"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"
}Errori comuni e passaggi successivi
001 | Controlla i campi obbligatori, JSON, codice paese, telefono e valori stringa di sole cifre nei parametri. |
END_USER_TEMPLATE_NOT_FOUND | Controlla l'ID modello completo e la proprietà dell'utente associato alla chiave API. |
END_USER_TEMPLATE_NOT_APPROVED | Attendi l'approvazione del modello prima di inviarlo. |
END_USER_TEMPLATE_REJECTED | Leggi il motivo del rifiuto e fai domanda con il contenuto rivisto. |
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCH | Limite di frequenza raggiunto. Ridurre la tariffa delle chiamate. |
ENV_LIMITER / TEMPLATE_LIMITER | Restrizione dei criteri di ambiente o modello. Segui i dettagli dell'errore e contatta l'assistenza. |
INVIA_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999 | Salva l'errore e richiedi gli identificatori per il supporto. Non inviare nuovamente alla cieca. |
MISURAZIONE_MISSING | L'SMS potrebbe essere già stato inviato ma mancano i dati di conteggio. Non riprovare automaticamente; salva resultId e contatta l'assistenza. |
Paesi e regioni supportati
Verifica la disponibilità della destinazione prima di inviare. Le destinazioni che richiedono la registrazione SID saranno presto disponibili. Inserisci il codice chiamante di seguito in countryCode senza + e inserisci il numero di telefono separatamente in phone.
| Paese/regione | Codice di chiamata | Disponibilità |
|---|---|---|
| United States | +1 | Prossimamente |
| Russia | +7 | Prossimamente |
| Egypt | +20 | Prossimamente |
| South Africa | +27 | Disponibile |
| Greece | +30 | Disponibile |
| Netherlands | +31 | Disponibile |
| Belgium | +32 | Disponibile |
| France | +33 | Disponibile |
| Spain | +34 | Disponibile |
| Hungary | +36 | Disponibile |
| Italy | +39 | Disponibile |
| Romania | +40 | Disponibile |
| Switzerland | +41 | Disponibile |
| Austria | +43 | Disponibile |
| United Kingdom | +44 | Prossimamente |
| Denmark | +45 | Disponibile |
| Norway | +47 | Disponibile |
| Sweden | +46 | Disponibile |
| Poland | +48 | Disponibile |
| Germany | +49 | Disponibile |
| Peru | +51 | Disponibile |
| Mexico | +52 | Disponibile |
| Argentina | +54 | Disponibile |
| Brazil | +55 | Disponibile |
| Chile | +56 | Disponibile |
| Colombia | +57 | Disponibile |
| Venezuela | +58 | Disponibile |
| Malaysia | +60 | Disponibile |
| Australia | +61 | Prossimamente |
| Indonesia | +62 | Prossimamente |
| Philippines | +63 | Prossimamente |
| New Zealand | +64 | Disponibile |
| Singapore | +65 | Prossimamente |
| Thailand | +66 | Prossimamente |
| Japan | +81 | Disponibile |
| South Korea | +82 | Disponibile |
| Vietnam | +84 | Prossimamente |
| China | +86 | Prossimamente |
| Türkiye | +90 | Prossimamente |
| India | +91 | Disponibile |
| Pakistan | +92 | Prossimamente |
| Afghanistan | +93 | Prossimamente |
| Sri Lanka | +94 | Prossimamente |
| Myanmar (Burma) | +95 | Prossimamente |
| South Sudan | +211 | Disponibile |
| Morocco | +212 | Prossimamente |
| Algeria | +213 | Disponibile |
| Tunisia | +216 | Disponibile |
| Libya | +218 | Prossimamente |
| Gambia | +220 | Disponibile |
| Senegal | +221 | Disponibile |
| Mauritania | +222 | Prossimamente |
| Mali | +223 | Prossimamente |
| Guinea | +224 | Prossimamente |
| Côte d’Ivoire | +225 | Disponibile |
| Burkina Faso | +226 | Disponibile |
| Niger | +227 | Disponibile |
| Togo | +228 | Disponibile |
| Benin | +229 | Prossimamente |
| Mauritius | +230 | Prossimamente |
| Liberia | +231 | Prossimamente |
| Sierra Leone | +232 | Prossimamente |
| Ghana | +233 | Prossimamente |
| Nigeria | +234 | Prossimamente |
| Chad | +235 | Prossimamente |
| Central African Republic | +236 | Disponibile |
| Cameroon | +237 | Prossimamente |
| Cape Verde | +238 | Disponibile |
| São Tomé & Príncipe | +239 | Disponibile |
| Equatorial Guinea | +240 | Disponibile |
| Gabon | +241 | Disponibile |
| Congo - Brazzaville | +242 | Disponibile |
| Congo - Kinshasa | +243 | Disponibile |
| Angola | +244 | Disponibile |
| Guinea-Bissau | +245 | Prossimamente |
| British Indian Ocean Territory | +246 | Disponibile |
| Ascension Island | +247 | Disponibile |
| Seychelles | +248 | Disponibile |
| Sudan | +249 | Prossimamente |
| Rwanda | +250 | Prossimamente |
| Ethiopia | +251 | Prossimamente |
| Somalia | +252 | Disponibile |
| Djibouti | +253 | Disponibile |
| Kenya | +254 | Prossimamente |
| Tanzania | +255 | Prossimamente |
| Uganda | +256 | Prossimamente |
| Burundi | +257 | Disponibile |
| Mozambique | +258 | Disponibile |
| Zambia | +260 | Prossimamente |
| Madagascar | +261 | Disponibile |
| Réunion | +262 | Disponibile |
| Zimbabwe | +263 | Disponibile |
| Namibia | +264 | Disponibile |
| Malawi | +265 | Prossimamente |
| Lesotho | +266 | Disponibile |
| Botswana | +267 | Disponibile |
| Eswatini | +268 | Disponibile |
| Comoros | +269 | Disponibile |
| St. Helena | +290 | Disponibile |
| Eritrea | +291 | Disponibile |
| Aruba | +297 | Disponibile |
| Faroe Islands | +298 | Disponibile |
| Greenland | +299 | Disponibile |
| Gibraltar | +350 | Disponibile |
| Portugal | +351 | Disponibile |
| Luxembourg | +352 | Disponibile |
| Ireland | +353 | Disponibile |
| Iceland | +354 | Disponibile |
| Albania | +355 | Disponibile |
| Malta | +356 | Disponibile |
| Cyprus | +357 | Disponibile |
| Finland | +358 | Disponibile |
| Bulgaria | +359 | Disponibile |
| Lithuania | +370 | Disponibile |
| Latvia | +371 | Disponibile |
| Estonia | +372 | Disponibile |
| Moldova | +373 | Disponibile |
| Armenia | +374 | Prossimamente |
| Belarus | +375 | Prossimamente |
| Andorra | +376 | Disponibile |
| Monaco | +377 | Disponibile |
| San Marino | +378 | Disponibile |
| Ukraine | +380 | Disponibile |
| Serbia | +381 | Disponibile |
| Montenegro | +382 | Disponibile |
| Kosovo | +383 | Disponibile |
| Croatia | +385 | Disponibile |
| Slovenia | +386 | Disponibile |
| Bosnia & Herzegovina | +387 | Disponibile |
| North Macedonia | +389 | Disponibile |
| Czechia | +420 | Prossimamente |
| Slovakia | +421 | Disponibile |
| Liechtenstein | +423 | Disponibile |
| Falkland Islands | +500 | Disponibile |
| Belize | +501 | Disponibile |
| Guatemala | +502 | Disponibile |
| El Salvador | +503 | Disponibile |
| Honduras | +504 | Disponibile |
| Nicaragua | +505 | Disponibile |
| Costa Rica | +506 | Disponibile |
| Panama | +507 | Disponibile |
| Saint Pierre and Miquelon | +508 | Disponibile |
| Haiti | +509 | Disponibile |
| Guadeloupe | +590 | Disponibile |
| Bolivia | +591 | Disponibile |
| Guyana | +592 | Disponibile |
| Ecuador | +593 | Disponibile |
| French Guiana | +594 | Disponibile |
| Paraguay | +595 | Disponibile |
| Martinique | +596 | Disponibile |
| Suriname | +597 | Disponibile |
| Uruguay | +598 | Disponibile |
| Caribbean Netherlands (including Curaçao) | +599 | Disponibile |
| Timor-Leste | +670 | Disponibile |
| Norfolk Island | +672 | Disponibile |
| Brunei | +673 | Disponibile |
| Nauru | +674 | Disponibile |
| Papua New Guinea | +675 | Disponibile |
| Tonga | +676 | Disponibile |
| Solomon Islands | +677 | Disponibile |
| Vanuatu | +678 | Disponibile |
| Fiji | +679 | Disponibile |
| Palau | +680 | Disponibile |
| Wallis & Futuna | +681 | Disponibile |
| Cook Islands | +682 | Disponibile |
| Niue | +683 | Disponibile |
| Samoa | +685 | Disponibile |
| Kiribati | +686 | Disponibile |
| New Caledonia | +687 | Disponibile |
| Tuvalu | +688 | Disponibile |
| French Polynesia | +689 | Disponibile |
| Tokelau | +690 | Disponibile |
| Micronesia | +691 | Disponibile |
| Marshall Islands | +692 | Disponibile |
| Hong Kong, China | +852 | Prossimamente |
| Macao, China | +853 | Disponibile |
| Cambodia | +855 | Prossimamente |
| Laos | +856 | Disponibile |
| Bangladesh | +880 | Disponibile |
| Taiwan, China | +886 | Disponibile |
| Maldives | +960 | Disponibile |
| Lebanon | +961 | Disponibile |
| Jordan | +962 | Prossimamente |
| Iraq | +964 | Disponibile |
| Kuwait | +965 | Prossimamente |
| Saudi Arabia | +966 | Prossimamente |
| Yemen | +967 | Prossimamente |
| Oman | +968 | Prossimamente |
| Palestine | +970 | Prossimamente |
| United Arab Emirates | +971 | Prossimamente |
| Israel | +972 | Disponibile |
| Bahrain | +973 | Disponibile |
| Qatar | +974 | Prossimamente |
| Bhutan | +975 | Disponibile |
| Mongolia | +976 | Disponibile |
| Nepal | +977 | Prossimamente |
| Tajikistan | +992 | Disponibile |
| Turkmenistan | +993 | Disponibile |
| Azerbaijan | +994 | Disponibile |
| Georgia | +995 | Disponibile |
| Kyrgyzstan | +996 | Disponibile |
| Uzbekistan | +998 | Disponibile |
| Bahamas | +1242 | Disponibile |
| Barbados | +1246 | Disponibile |
| Anguilla | +1264 | Disponibile |
| Antigua & Barbuda | +1268 | Disponibile |
| British Virgin Islands | +1284 | Disponibile |
| U.S. Virgin Islands | +1340 | Disponibile |
| Cayman Islands | +1345 | Disponibile |
| Bermuda | +1441 | Disponibile |
| Grenada | +1473 | Disponibile |
| Turks & Caicos Islands | +1649 | Disponibile |
| Montserrat | +1664 | Disponibile |
| Northern Mariana Islands | +1670 | Disponibile |
| Guam | +1671 | Disponibile |
| American Samoa | +1684 | Disponibile |
| Sint Maarten | +1721 | Disponibile |
| St. Lucia | +1758 | Disponibile |
| Dominica | +1767 | Disponibile |
| Puerto Rico | +1787 | Disponibile |
| Dominican Republic | +1809 | Disponibile |
| Trinidad & Tobago | +1868 | Disponibile |
| St. Kitts & Nevis | +1869 | Disponibile |
| Jamaica | +1876 | Disponibile |