คู่มือบูรณาการ

ตรวจสอบสิทธิ์ กรอกพารามิเตอร์ และส่ง

1. การรับรองความถูกต้อง

โทรจากเซิร์ฟเวอร์ของคุณด้วยส่วนหัว api-key และ Content-Type: application/json

2. ทำความเข้าใจพารามิเตอร์และตัวยึดตำแหน่ง

${code} ขอสงวนสถานที่ในเทมเพลตของคุณ params.code ระบุค่าสำหรับข้อความนี้:

เทมเพลต · จองสถานที่
text
รหัสของคุณคือ ${code} ซึ่งใช้ได้เป็นเวลา 5 นาที
พารามิเตอร์ · ระบุค่า
json
{ "params": { "code": "008848" } }
ข้อความที่ผู้รับของคุณเห็น

รหัสของคุณคือ 008848 ซึ่งใช้ได้เป็นเวลา 5 นาที

ใช้โค้ดเป็นคีย์ ไม่ใช่ ${code} และจับคู่ตัวพิมพ์ของตัวยึดตำแหน่ง ค่าต้องเป็นสตริงเฉพาะตัวเลข เช่น "008848" ละเว้นพารามิเตอร์หากไม่มีตัวยึดตำแหน่ง

3. ส่ง SMS

POSThttps://api.starsg.ai/api/product/sms/send
สนามชนิดข้อมูลที่จำเป็นสิ่งที่จะเข้า
templateIdstringใช่รหัสเทมเพลตของคุณที่ได้รับอนุมัติ เช่น SMS_0123456789 เก็บรักษากรณี
countryCodestringใช่รหัสโทรศัพท์ในประเทศหรือภูมิภาค เช่น "33" สำหรับฝรั่งเศส โดยไม่มีเครื่องหมาย + และแยกจากโทรศัพท์ ดูรายการปลายทางด้านล่าง
phonestringใช่หมายเลขโทรศัพท์ของผู้รับที่ไม่มีรหัสโทรศัพท์ในประเทศ
paramsobject<string, string>ต่อเทมเพลตชื่อตัวยึดตำแหน่งที่แมปกับค่าจริง เช่น {"code":"008848"} ค่าดีฟอลต์เป็นสตริงเฉพาะตัวเลข ละเว้นหากเทมเพลตไม่มีตัวยึดตำแหน่ง

คัดลอกและปรับแต่งตัวอย่างนี้

ตัวอย่างนี้ใช้รหัสโทรศัพท์ของฝรั่งเศส 33 แทนที่คีย์ API, ID เทมเพลตที่ได้รับการอนุมัติและผู้รับด้วยหมายเลขทดสอบของคุณเอง และยืนยันว่าปลายทางพร้อมใช้งาน

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บันทึกข้อผิดพลาดและขอตัวระบุเพื่อรับการสนับสนุน อย่าส่งซ้ำแบบสุ่มสี่สุ่มห้า
การวัดแสง_หายไปอาจส่ง 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มีอยู่