Integrationsleitfaden

Authentifizieren, Parameter eingeben und senden.

1. Authentifizierung

Rufen Sie von Ihrem Server mit API-Schlüssel und Content-Type: application/json-Headern auf.

2. Parameter und Platzhalter verstehen

${code} reserviert einen Platz in Ihrer Vorlage. params.code liefert den Wert für diese Nachricht:

Vorlage · Platz reservieren
text
Ihr Code lautet ${code} und ist für 5-Minuten gültig.
Parameter · Geben Sie einen Wert an
json
{ "params": { "code": "008848" } }
Die Nachricht, die Ihr Empfänger sieht

Ihr Code lautet 008848 und ist für 5-Minuten gültig.

Verwenden Sie als Schlüssel den Code, nicht ${code}, und achten Sie auf die Groß-/Kleinschreibung des Platzhalters. Werte müssen Zeichenfolgen sein, die nur aus Ziffern bestehen, z. B. „008848“. Lassen Sie Parameter weg, wenn keine Platzhalter vorhanden sind.

3. Senden Sie eine SMS

POSThttps://api.starsg.ai/api/product/sms/send
FeldTypErforderlichWas Sie eingeben müssen
templateIdstringJaIhre genehmigte Vorlagen-ID, z. B. SMS_0123456789. Fall aufbewahren.
countryCodestringJaLänder- oder Regionsvorwahl, z. B. „33“ für Frankreich, ohne + und getrennt vom Telefon. Siehe die Zielliste unten.
phonestringJaTelefonnummer des Empfängers ohne Landesvorwahl.
paramsobject<string, string>Pro VorlagePlatzhalternamen, die tatsächlichen Werten zugeordnet sind, z. B. {"code":"008848"}. Als Werte werden standardmäßig Zeichenfolgen verwendet, die nur aus Ziffern bestehen. Lassen Sie es weg, wenn die Vorlage keine Platzhalter enthält.

Kopieren Sie dieses Beispiel und passen Sie es an

In diesem Beispiel wird der französische Rufcode 33 verwendet. Ersetzen Sie den API-Schlüssel, die genehmigte Vorlagen-ID und den Empfänger durch Ihre eigene Testnummer und bestätigen Sie, dass das Ziel verfügbar ist.

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

Senden Sie ein JSON-Objekt direkt: kein Body-Wrapper oder zusätzliches /v1.. In diesem Beispiel wird eine Vorlage verwendet, die ${code} enthält.

4. Überprüfen Sie das Ergebnis

Überprüfen Sie zunächst den Erfolg. Speichern Sie messageId (Kanalnachrichten-ID) und resultId (Sendedatensatz-ID) bei Erfolg. Überprüfen Sie errorCode/errorMsg auf Fehler. Das erfolgreiche Senden bestätigt nicht den Empfang auf dem Telefon.

Erfolgsantwort
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Fehlerreaktion
json
{
  "success": false,
  "data": null,
  "errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
  "errorMsg": "Template is awaiting review"
}

Häufige Fehler und nächste Schritte

001Überprüfen Sie die erforderlichen Felder, JSON, Landesvorwahl, Telefonnummer und reine Ziffernzeichenfolgenwerte in Parametern.
END_USER_TEMPLATE_NOT_FOUNDÜberprüfen Sie die vollständige Vorlagen-ID und den Besitz des Benutzers, der Ihrem API-Schlüssel zugeordnet ist.
END_USER_TEMPLATE_NOT_APPROVEDWarten Sie vor dem Senden auf die Genehmigung der Vorlage.
END_USER_TEMPLATE_REJECTEDLesen Sie den Ablehnungsgrund und bewerben Sie sich mit überarbeitetem Inhalt.
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCHFrequenzgrenze erreicht. Reduzieren Sie die Anrufrate.
ENV_LIMITER / TEMPLATE_LIMITEREinschränkung der Umgebungs- oder Vorlagenrichtlinie. Befolgen Sie die Fehlerdetails und wenden Sie sich an den Support.
SEND_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999Speichern Sie die Fehler- und Anforderungskennungen für den Support. Nicht blind erneut senden.
METERING_MISSINGMöglicherweise wurde die SMS bereits versendet, es fehlen jedoch Zählerdaten. Nicht automatisch erneut versuchen; Ergebnis-ID speichern und Support kontaktieren.

Unterstützte Länder und Regionen

Überprüfen Sie vor dem Senden die Verfügbarkeit des Ziels. Reiseziele, die eine SID-Registrierung erfordern, folgen in Kürze. Geben Sie die Rufvorwahl unten in „countryCode“ ohne + ein und geben Sie die Telefonnummer separat in „phone“ ein.

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