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