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