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