กฎทั่วไป
รูปแบบคำขอ API
https://sms.api.engagelab.cc/v1/ <module>
Module: ชื่อของโมดูลการทำงาน เช่น send (โมดูลการส่ง), templates (เทมเพลต) เป็นต้น
รหัสตอบกลับของ API
ผลลัพธ์ที่ส่งคืนโดย API อยู่ในรูปแบบ JSON ดังตัวอย่างด้านล่าง:
# request was successful
{
"result": {}
}
# Authentication failed
{
"code": 30000,
"message": "authentication failed",
}
# Data acquisition success
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-10T15:47:05+0800",
"update_time": "2022-11-10T15:47:05+0800"
}
]
}
# request was successful
{
"result": {}
}
# Authentication failed
{
"code": 30000,
"message": "authentication failed",
}
# Data acquisition success
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-10T15:47:05+0800",
"update_time": "2022-11-10T15:47:05+0800"
}
]
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
- httpStatus: 200 หมายถึงคำขอสำเร็จ
- result: ข้อมูล
รหัสสถานะ HTTP
| สถานะ | คำอธิบาย | ความหมาย |
|---|---|---|
| 200 | Success | การตอบกลับสำเร็จ |
| 400 | Bad Request | ข้อผิดพลาดในคำขอของผู้ใช้ |
| 401 | Unauthorized | การตรวจสอบสิทธิ์ล้มเหลว |
| 404 | Not Found | ทรัพยากรที่ร้องขอไม่มีอยู่ |
| 500 | Internal Server Error | ข้อผิดพลาดของเซิร์ฟเวอร์ มักเกิดจากเซิร์ฟเวอร์ไม่สามารถประมวลผลพารามิเตอร์ของผู้ใช้ได้อย่างถูกต้อง (ในกรณีนี้ไม่ชัดเจนว่าคำขอได้รับการตอบกลับสำเร็จหรือไม่) |
พจนานุกรมเขตเวลา
| เขตเวลา | คำอธิบาย |
|---|---|
| -12 | เส้นแบ่งวันสากลฝั่งตะวันตก |
| -11 | เวลาสากลเชิงพิกัด-11 |
| -10 | หมู่เกาะอะลูเชียน (ฮาวาย) |
| -9 | อลาสกา (เวลาสากลเชิงพิกัด-09) |
| -8 | บาฮาแคลิฟอร์เนีย (เวลาสากลเชิงพิกัด-08, เวลามาตรฐานแปซิฟิก [สหรัฐฯ และแคนาดา]) |
| -7 | อริโซนา (ชิวาวา, ลาปาซ, มาซัตลัน, เวลามาตรฐานภูเขา [สหรัฐฯ และแคนาดา], ยูคอน) |
| -6 | อเมริกากลาง (เวลามาตรฐานกลาง [สหรัฐฯ และแคนาดา], เกาะอีสเตอร์, กัวดาลาฮารา, เม็กซิโกซิตี้, มอนเตร์เรย์, ซัสแคตเชวัน) |
| -5 | โบโกตา, ลิมา, กีโต, ริโอบรังโก (เชตูมัล, เวลามาตรฐานตะวันออก [สหรัฐฯ และแคนาดา], เฮติ, ฮาวานา, อินเดียนา [ตะวันออก], เติร์กส์และเคคอส) |
| -4 | อาซุนซิออน (เวลามาตรฐานแอตแลนติก [แคนาดา], การากัส, กุยาบา, จอร์จทาวน์, ลาปาซ, มาเนาส์, ซานฮวน, ซานติอาโก) |
| -3 | อารากัวอินา (บราซิเลีย, กาเยน, ฟอร์ตาเลซา, เมืองบัวโนสไอเรส, กรีนแลนด์, มอนเตวิเดโอ, ปุนตาอาเรนัส, แซงปีแยร์และมีเกอลง, ซัลวาดอร์) |
| -2 | เวลาสากลเชิงพิกัด-02 |
| -1 | อะซอเรส (หมู่เกาะเคปเวิร์ด) |
| 0 | ดับลิน, เอดินบะระ, ลิสบอน, ลอนดอน (มอนโรเวีย, เรคยาวิก, เซาตูเม) |
| 1 | คาซาบลังกา (อัมสเตอร์ดัม, เบอร์ลิน, เบิร์น, โรม, สตอกโฮล์ม, เวียนนา, เบลเกรด, บราติสลาวา, บูดาเปสต์, ลูบลิยานา, ปราก, บรัสเซลส์, โคเปนเฮเกน, มาดริด, ปารีส, ซาราเยโว, สโกเปีย, วอร์ซอ, ซาเกร็บ, แอฟริกากลางตะวันตก) |
| 2 | อัมมาน (เอเธนส์, บูคาเรสต์, เบรุต, ไคโร, คีชีเนา, ดามัสกัส, กาซา, เฮบรอน, ฮาราเร, พริทอเรีย, เฮลซิงกิ, เคียฟ, ริกา, โซเฟีย, ทาลลินน์, วิลนีอุส, เยรูซาเล็ม, คาลินินกราด, คาร์ทูม, ตริโปลี, วินด์ฮุก) |
| 3 | แบกแดด (อิสตันบูล, คูเวต, ริยาด, มินสค์, มอสโก, เซนต์ปีเตอร์สเบิร์ก, ไนโรบี) |
| 4 | อาบูดาบี, มัสกัต (อัสตราคาน, อูลยานอฟสค์, บากู, อิเซฟสค์, ซามารา, พอร์ตหลุยส์, ซาราตอฟ, ทบิลิซี, โวลโกกราด, เยเรวาน) |
| 5 | อาชกาบัต, ทาชเคนต์ (เยคาเตรินเบิร์ก, อิสลามาบัด, การาจี, คีซิลออร์ดา) |
| 6 | อัสตานา (ธากา, ออมสค์) |
| 7 | กรุงเทพฯ, ฮานอย, จาการ์ตา (บาร์เนา, กอร์โน-อัลไตส์ก, โฮฟด์, ครัสโนยาสค์, โนโวซีบีร์สค์, ทอมสค์) |
| 8 | ปักกิ่ง, ฉงชิ่ง, ฮ่องกง, อุรุมชี (อีร์คุตสค์, กัวลาลัมเปอร์, สิงคโปร์, เพิร์ธ, ไทเป, อูลานบาตอร์) |
| 9 | ชิตา (โอซาก้า, ซัปโปโร, โตเกียว, เปียงยาง, โซล, ยาคุตสค์) |
| 10 | บริสเบน (แคนเบอร์รา, เมลเบิร์น, ซิดนีย์, กวม, พอร์ตมอร์สบี, โฮบาร์ต, วลาดิวอสตอค) |
| 11 | เกาะบูเกนวิลล์ (โชคูร์ดัค, มากาดาน, เกาะนอร์ฟอล์ก, ซาคาลิน, หมู่เกาะโซโลมอน, นิวแคลิโดเนีย) |
| 12 | อานาดีร์, เปโตรปัฟลอฟสค์-คัมชัตสกี (โอ๊คแลนด์, เวลลิงตัน, เวลาสากลเชิงพิกัด+12, ฟิจิ) |
