ข้อมูลที่ส่ง
สถิติข้อมูลที่ส่งรายวัน
สถิติข้อมูล SMS รายวัน
URL
https://sms.api.engagelab.cc/v1/stats_day
https://sms.api.engagelab.cc/v1/stats_day
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
คำอธิบายพารามิเตอร์
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| template_ids | string | No | รหัสแม่แบบหลายรายการ แยกด้วย ";" เช่น template_ids=1;2;3 รองรับสูงสุด 10 แม่แบบ |
| sms_users | string | No | ดึงข้อมูลสถิติสำหรับ SMS_USER เฉพาะ แยกด้วย ";" เช่น sms_users=a;b;c รองรับสูงสุด 10 ผู้ใช้ |
| label_ids | string | No | รายการรหัสป้ายกำกับ SMS แยกด้วย ";" เช่น label_ids=123456;456789 รองรับสูงสุด 10 ป้ายกำกับ |
| start_date | string | Yes | วันที่เริ่มต้นในรูปแบบ yyyy-MM-dd |
| end_date | string | Yes | วันที่สิ้นสุดในรูปแบบ yyyy-MM-dd |
| msg_type | string | No | ประเภท SMS, 2 หมายถึง SMS ระหว่างประเทศ |
| aggregate_by | string | No | การรวมข้อมูล, 0 ไม่รวม, 1 รวม, ค่าเริ่มต้นคือ 0 |
หมายเหตุ:
- ช่วงเวลาการค้นหาไม่ควรเกิน 90 วัน
- เมื่อ aggregate_by เป็น 1 ข้อมูลจะถูกรวมตาม msg_type; เมื่อ aggregate_by เป็น 0 จะไม่มีการรวมข้อมูล
ตัวอย่างคำร้องขอ
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| send_date | วันที่ส่ง |
| msg_type | ประเภท SMS |
| sms_user | SMS_USER |
| template_id | รหัสแม่แบบ SMS |
| label_id | รหัสป้ายกำกับ |
| targets | เป้าหมายทั้งหมด |
| sent | จำนวนที่ส่ง |
| process_failed | จำนวนที่ประมวลผลล้มเหลว |
| delivered | จำนวนที่ส่งสำเร็จ |
| send_failed | จำนวนที่ส่งล้มเหลว |
| wait_result | จำนวนที่รอผลรับ |
| billing_count | จำนวนการเรียกเก็บเงิน |
| process_failed_percent | เปอร์เซ็นต์การประมวลผลล้มเหลว |
| delivered_percent | เปอร์เซ็นต์การส่งสำเร็จ |
| send_failed_percent | เปอร์เซ็นต์การส่งล้มเหลว |
| wait_result_percent | เปอร์เซ็นต์การรอผลรับ |
ตัวอย่างการตอบกลับ
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
สถิติการประมวลผลล้มเหลว
ดึงข้อมูลสถิติการประมวลผลล้มเหลวที่จัดหมวดหมู่
URL
https://sms.api.engagelab.cc/v1/stats/process_failed
https://sms.api.engagelab.cc/v1/stats/process_failed
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(smsUser:smsKey) |
คำอธิบายพารามิเตอร์
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| sms_users | string | No | ดึงข้อมูลสถิติสำหรับ SMS_USER เฉพาะ แยกด้วย ";" เช่น sms_users=a;b;c รองรับสูงสุด 10 ผู้ใช้ |
| start_date | string | Yes | วันที่เริ่มต้นในรูปแบบ yyyy-MM-dd |
| end_date | string | Yes | วันที่สิ้นสุดในรูปแบบ yyyy-MM-dd |
| msg_type | string | No | ประเภทธุรกิจ, 2 หมายถึง SMS ระหว่างประเทศ, ค่าเริ่มต้นคือ 2 |
| label_ids | string | No | รายการรหัสป้ายกำกับ SMS แยกด้วย ";" เช่น label_ids=123456;456789 รองรับสูงสุด 10 ป้ายกำกับ |
| template_ids | string | No | รหัสแม่แบบหลายรายการ แยกด้วย ";" เช่น template_Ids=1;2;3 รองรับสูงสุด 10 แม่แบบ |
| aggregate_by | string | No | การรวมข้อมูล, 0 ไม่รวม, 1 รวม, ค่าเริ่มต้นคือ 0 |
หมายเหตุ:
- ช่วงเวลาการค้นหาไม่ควรเกิน 90 วัน
- เมื่อ aggregate_by เป็น 1 ข้อมูลจะถูกรวมตาม msg_type; เมื่อ aggregate_by เป็น 0 จะไม่มีการรวมข้อมูล
ตัวอย่างคำร้องขอ
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| send_date | วันที่ส่ง |
| label_id | รหัสป้ายกำกับ |
| msg_type | ประเภท SMS |
| sms_user | SMS_USER |
| template_id | รหัสแม่แบบ SMS |
| global_block | จำนวนการบล็อกทั่วโลก |
| partial_block | จำนวนการบล็อกบางส่วน |
| unsubscribe | จำนวนการยกเลิกการสมัคร |
| keyword_block | จำนวนการบล็อกคำสำคัญ |
| variable_error | จำนวนข้อผิดพลาดตัวแปร |
| content_error | จำนวนข้อผิดพลาดเนื้อหา |
| frequency_overrun | จำนวนการเกินความถี่ |
| other | จำนวนอื่นๆ |
ตัวอย่างการตอบกลับ
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
{
"result" : {
"msg_type" : "2",
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
สถิติการส่งล้มเหลว
ดึงข้อมูลสถิติการส่งล้มเหลวที่จัดหมวดหมู่
URL
https://sms.api.engagelab.cc/v1/stats/send_failed
https://sms.api.engagelab.cc/v1/stats/send_failed
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
คำอธิบายพารามิเตอร์
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| sms_users | string | No | ดึงข้อมูลสถิติสำหรับ SMS_USER เฉพาะ แยกด้วย ";" เช่น sms_users=a;b;c รองรับสูงสุด 10 ผู้ใช้ |
| start_date | string | Yes | วันที่เริ่มต้นในรูปแบบ yyyy-MM-dd |
| end_date | string | Yes | วันที่สิ้นสุดในรูปแบบ yyyy-MM-dd |
| msg_type | string | No | ประเภท SMS, 2 หมายถึง SMS ระหว่างประเทศ |
| label_ids | string | No | รายการรหัสป้ายกำกับ SMS แยกด้วย ";" เช่น label_Ids=123456;456789 รองรับสูงสุด 10 ป้ายกำกับ |
| template_ids | string | No | รหัสแม่แบบหลายรายการ แยกด้วย ";" เช่น template_Ids=1;2;3 รองรับสูงสุด 10 แม่แบบ |
| aggregate_by | string | No | การรวมข้อมูล, 0 ไม่รวม, 1 รวม, ค่าเริ่มต้นคือ 0 |
หมายเหตุ:
- ช่วงเวลาการค้นหาไม่ควรเกิน 90 วัน
- เมื่อ aggregate_by เป็น 1 ข้อมูลจะถูกรวมตาม msg_type; เมื่อ aggregate_by เป็น 0 จะไม่มีการรวมข้อมูล
ตัวอย่างคำร้องขอ
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| send_date | วันที่ส่ง |
| label_id | รหัสป้ายกำกับ |
| msg_type | ประเภท SMS |
| sms_user | SMS_USER |
| template_id | รหัสแม่แบบ SMS |
| empty | จำนวนหมายเลขว่าง |
| out_of_service | จำนวนหมายเลขที่ไม่ให้บริการ |
| blacklist | จำนวนหมายเลขในบัญชีดำ |
| busy | จำนวนหมายเลขที่สายไม่ว่าง |
| no_answer | จำนวนหมายเลขที่ไม่มีการตอบรับ |
| interception | จำนวนหมายเลขที่ถูกสกัดกั้น |
| break_down | จำนวนหมายเลขที่เครื่องเสีย |
| not_in_service | จำนวนหมายเลขที่ไม่อยู่ในบริการ |
| power_off | จำนวนหมายเลขที่ปิดเครื่อง |
| other | จำนวนอื่นๆ |
ตัวอย่างการตอบกลับ
aggregate_by=0
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
