دليل التكامل

قم بالمصادقة، واملأ المعلمات، ثم أرسل.

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 بالفعل، ولكن بيانات القياس مفقودة. لا تقم بإعادة المحاولة تلقائيًا؛ احفظ معرف النتيجة واتصل بالدعم.

البلدان والمناطق المدعومة

تحقق من توفر الوجهة قبل الإرسال. الوجهات التي تتطلب تسجيل 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متاح