คู่มือบูรณาการ
ตรวจสอบสิทธิ์ กรอกพารามิเตอร์ และส่ง
1. การรับรองความถูกต้อง
โทรจากเซิร์ฟเวอร์ของคุณด้วยส่วนหัว api-key และ Content-Type: application/json
2. ทำความเข้าใจพารามิเตอร์และตัวยึดตำแหน่ง
${code} ขอสงวนสถานที่ในเทมเพลตของคุณ params.code ระบุค่าสำหรับข้อความนี้:
รหัสของคุณคือ ${code} ซึ่งใช้ได้เป็นเวลา 5 นาที{ "params": { "code": "008848" } }รหัสของคุณคือ 008848 ซึ่งใช้ได้เป็นเวลา 5 นาที
ใช้โค้ดเป็นคีย์ ไม่ใช่ ${code} และจับคู่ตัวพิมพ์ของตัวยึดตำแหน่ง ค่าต้องเป็นสตริงเฉพาะตัวเลข เช่น "008848" ละเว้นพารามิเตอร์หากไม่มีตัวยึดตำแหน่ง
3. ส่ง SMS
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, ID เทมเพลตที่ได้รับการอนุมัติและผู้รับด้วยหมายเลขทดสอบของคุณเอง และยืนยันว่าปลายทางพร้อมใช้งาน
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 | บันทึกข้อผิดพลาดและขอตัวระบุเพื่อรับการสนับสนุน อย่าส่งซ้ำแบบสุ่มสี่สุ่มห้า |
การวัดแสง_หายไป | อาจส่ง 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 | มีอยู่ |