Руководство по интеграции

Аутентифицируйтесь, заполняйте параметры и отправляйте.

1. Аутентификация

Вызов с вашего сервера с помощью API-ключа и заголовков Content-Type: application/json.

2. Понимание параметров и заполнителей

${code} резервирует место в вашем шаблоне. params.code предоставляет значение для этого сообщения:

Шаблон · Забронировать место
text
Ваш код — ${code}, действителен в течение 5 минут.
Параметры · Укажите значение
json
{ "params": { "code": "008848" } }
Сообщение, которое видит получатель

Ваш код — 008848, действителен в течение 5 минут.

Используйте в качестве ключа код, а не ${code}, и соблюдайте регистр заполнителя. Значения должны представлять собой строки, состоящие только из цифр, например «008848». Опустите параметры, если нет заполнителей.

3. Отправить СМС

POSThttps://api.starsg.ai/api/product/sms/send
ПолеТипНеобходимыйЧто ввести
templateIdstringДаУтвержденный идентификатор шаблона, например SMS_0123456789. Сохраните дело.
countryCodestringДаТелефонный код страны или региона, например «33» для Франции, без + и отдельно от телефона. См. список направлений ниже.
phonestringДаНомер телефона получателя без кода страны.
paramsobject<string, string>По шаблонуИмена заполнителей, сопоставленные с фактическими значениями, например. {"code":"008848"}. Значения по умолчанию представляют собой строки, состоящие только из цифр. Пропустите, если в шаблоне нет заполнителей.

Скопируйте и настройте этот пример

В этом примере используется телефонный код Франции 33. Замените ключ API, идентификатор утвержденного шаблона и получателя на свой собственный номер теста и подтвердите, что пункт назначения доступен.

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

Отправьте объект JSON напрямую: без оболочки тела или дополнительного /v1.. В этом примере используется шаблон, содержащий ${code}.

4. Проверьте результат

Сначала проверьте успех. Сохраните messageId (идентификатор сообщения канала) и resultId (идентификатор отправки записи) в случае успеха; проверьте errorCode/errorMsg в случае сбоя. Успешная отправка не подтверждает получение на телефоне.

Успешный ответ
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Ответ об ошибке
json
{
  "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Доступный