راهنمای ادغام

احراز هویت، پارامترها را پر کنید و ارسال کنید.

1. احراز هویت

از سرور خود با api-key و هدر 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ممکن است پیامک قبلا ارسال شده باشد، اما داده‌های اندازه‌گیری وجود ندارد. به طور خودکار دوباره امتحان نکنید. resultId را ذخیره کنید و با پشتیبانی تماس بگیرید.

کشورها و مناطق پشتیبانی شده

قبل از ارسال، در دسترس بودن مقصد را بررسی کنید. مقاصدی که نیاز به ثبت نام SID دارند به زودی می آیند. کد تماس زیر را در countryCode بدون + وارد کنید و شماره تلفن را جداگانه در تلفن وارد کنید.

کشور / منطقهکد تماسدر دسترس بودن
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موجود است