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