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:

Modello · Prenota un posto
text
Il tuo codice è ${code}, valido per 5 minuti.
Parametri · Fornire un valore
json
{ "params": { "code": "008848" } }
Il messaggio che vede il tuo destinatario

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

POSThttps://api.starsg.ai/api/product/sms/send
CampoTipoNecessarioCosa inserire
templateIdstringSÌL'ID modello approvato, ad esempio SMS_0123456789. Conserva la custodia.
countryCodestringSÌ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.
phonestringSÌNumero di telefono del destinatario senza prefisso internazionale.
paramsobject<string, string>Per modelloNomi 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.

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

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.

Risposta di successo
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Risposta all'errore
json
{
  "success": false,
  "data": null,
  "errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
  "errorMsg": "Template is awaiting review"
}

Errori comuni e passaggi successivi

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