logoเอกสาร
SMS
หน้าหลักเอกสาร
ภาพรวมผลิตภัณฑ์การเข้าถึงด่วนคอนโซลREST APISMSHook
ค้นหา
ภาษาไทย
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
เข้าสู่ระบบ
REST API / ผู้ติดต่อ

รายการผู้ติดต่อ

อัพเดทล่าสุด ：2025-07-22

API ต่อไปนี้ช่วยให้คุณสามารถค้นหา เพิ่ม ลบ และอัปเดตรายการผู้ติดต่อ SMS ได้

ค้นหารายการผู้ติดต่อ

ส่งคืนข้อมูลพื้นฐานเกี่ยวกับรายการผู้ติดต่อ SMS

URL

https://sms.api.engagelab.cc/v1/contact_lists
              
              https://sms.api.engagelab.cc/v1/contact_lists
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET
              
              GET
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization String true Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
offset Integer No ตำแหน่งเริ่มต้นของการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0
limit Integer No จำนวนการค้นหา ช่วง [0-100] ค่าเริ่มต้นคือ 100
contact_list_name string No ชื่อรายการผู้ติดต่อ รองรับการค้นหาแบบคลุมเครือ

ตัวอย่างคำขอ

curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์ คำอธิบาย
contact_list_id รหัสรายการผู้ติดต่อ
contact_list_name ชื่อรายการผู้ติดต่อ
description คำอธิบาย
member_count จำนวนสมาชิก
create_time เวลาสร้าง
update_time เวลาอัปเดต

ตัวอย่างการตอบกลับ

{ "result": [{ "contact_List_id": 998, "contact_list_name": "test", "description": "", "member_count": 4, "create_time": "2016-05-10T15:18:38+0800", "update_time": "2016-05-11T10:04:20+0800" }, { "contact_List_id": 999, "contact_list_name": "test2", "description": "", "member_count": 1, "create_time": "2016-06-29T12:54:59+0800", "update_time": "2016-06-29T12:54:59+0800" } ], "count":2 "total": 10 }
              
              {
        "result": [{
                "contact_List_id": 998,
                "contact_list_name": "test",
                "description": "",
                "member_count": 4,
                "create_time": "2016-05-10T15:18:38+0800",
                "update_time": "2016-05-11T10:04:20+0800"
            },
            {
                "contact_List_id": 999,
                "contact_list_name": "test2",
                "description": "",
                "member_count": 1,
                "create_time": "2016-06-29T12:54:59+0800",
                "update_time": "2016-06-29T12:54:59+0800"
            }
        ],
        "count":2
        "total": 10
    
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

เพิ่มรายการผู้ติดต่อ

ส่งคืนข้อมูลเกี่ยวกับรายการผู้ติดต่อที่เพิ่มสำเร็จ

URL

https://sms.api.engagelab.cc/v1/contact_lists
              
              https://sms.api.engagelab.cc/v1/contact_lists
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST
              
              POST
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json
              
              application/json
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization String true Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
contact_list_name string Yes ชื่อรายการผู้ติดต่อ รองรับเฉพาะตัวเลข ตัวอักษร ขีดล่าง หรือขีดกลาง สูงสุด 48 ตัวอักษร
description string No คำอธิบาย สูงสุด 255 ตัวอักษร

ตัวอย่างคำขอ

curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "contact_list_name": "beijing", "description": "test" }' 
              
              curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "contact_list_name": "beijing",
    "description": "test"
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์ คำอธิบาย
contact_list_id รหัสรายการผู้ติดต่อ
contact_list_name ชื่อรายการผู้ติดต่อ
description คำอธิบายรายการ
member_count จำนวนสมาชิก
create_time เวลาสร้าง
update_time เวลาอัปเดต

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": { "contact_list_id": 35, "contact_list_name": "beijing", "description": "test", "member_count": 28, "create_time": "2016-08-02T14:06:10+0800", "update_time": "2017-05-19T10:55:24+0800" } }
              
              {
    "result": {
            "contact_list_id": 35,
            "contact_list_name": "beijing",
            "description": "test",
            "member_count": 28,
            "create_time": "2016-08-02T14:06:10+0800",
            "update_time": "2017-05-19T10:55:24+0800"	
    }
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    
    "code": 30000,
    "message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

// ตัวอย่างการตอบกลับล้มเหลว { "code": 35004, "message": "contact_list_name cannot be empty" }
              
              // ตัวอย่างการตอบกลับล้มเหลว
{
    "code": 35004,
        "message": "contact_list_name cannot be empty"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

อัปเดตรายการผู้ติดต่อ

ส่งคืนข้อมูลพื้นฐานเกี่ยวกับรายการผู้ติดต่อที่อัปเดตสำเร็จ

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

PUT
              
              PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json
              
              application/json
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization String true Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
contact_list_name string No ชื่อรายการผู้ติดต่อ รองรับเฉพาะตัวเลข ตัวอักษร ขีดล่าง หรือขีดกลาง สูงสุด 48 ตัวอักษร
description string No คำอธิบาย สูงสุด 255 ตัวอักษร

หมายเหตุ:

  1. การอัปเดต contact_list_name และ description ของรายการจะอัปเดตเวลาของรายการ การอัปเดตสมาชิกจะไม่อัปเดตเวลาอัปเดตรายการ

ตัวอย่างคำขอ

curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "contact_list_name": "shanghai", "description": "222" }' 
              
              curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "contact_list_name": "shanghai",
    "description": "222"
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์ คำอธิบาย
count จำนวนระเบียนที่แก้ไขสำเร็จ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count":1 }
              
              {
    "count":1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    
    "code": 30000,
    "message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

// ตัวอย่างการตอบกลับล้มเหลว { "code": 35004, "message": "contact_list_name cannot be empty" }
              
              // ตัวอย่างการตอบกลับล้มเหลว
{
    "code": 35004,
        "message": "contact_list_name cannot be empty"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

ลบรายการผู้ติดต่อ

ส่งคืนข้อมูลพื้นฐานเกี่ยวกับการส่งคำขอสำเร็จหรือไม่

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE
              
              DELETE
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/x-www-form-urlencoded
              
              application/x-www-form-urlencoded
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization String true Basic base64(sms_user:sms_key)

ตัวอย่างคำขอ

curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

ฟิลด์ คำอธิบาย
count จำนวนระเบียนที่ลบสำเร็จ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count": 1 }
              
              {
"count": 1 
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    
    "code": 30000,
    "message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

// ตัวอย่างการตอบกลับล้มเหลว { "code": 35008, "message": "The contactListName does not exist" }
              
              // ตัวอย่างการตอบกลับล้มเหลว
{
    "code": 35008,
        "message": "The contactListName does not exist"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

คุณสามารถใช้ API ด้านล่างนี้เพื่อสอบถาม เพิ่ม ลบ และอัปเดตรายชื่อสมาชิกในรายการผู้ติดต่อ SMS

สอบถามสมาชิกในรายการ

ส่งคืนข้อมูลพื้นฐานของสมาชิกในรายการผู้ติดต่อ SMS

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET
              
              GET
โค้ดนี้โชว์เป็นหน้าต่างลอย

หัวข้อคำขอ

Header Type Required Description
Authorization String true Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

Parameter Type Required Description
offset Integer no ตำแหน่งเริ่มต้น [0-] ค่าเริ่มต้นคือ 0
limit Integer no จำนวน [0-100] ค่าเริ่มต้นคือ 100
phone string no เบอร์โทรศัพท์ของสมาชิก รองรับการค้นหาแบบคลุมเครือ
member_ids string no ID สมาชิก หลายรายการใช้เครื่องหมายจุลภาคคั่น สูงสุด 100 รายการ

ตัวอย่างคำขอ

curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายค่าที่ส่งกลับ

Parameter Description
member_id ID สมาชิก
phone เบอร์โทรศัพท์ของสมาชิก
name ชื่อสมาชิก
vars ตัวแปร
create_time เวลาสร้างรายการผู้ติดต่อ
update_time เวลาปรับปรุงรายการผู้ติดต่อ

ตัวอย่างค่าที่ส่งกลับ

{ "result": [ { "member_id": 440164, "phone": "18********", "name": "", "vars": "{'beizhu':'hello'}", "create_time": "2016-10-18T15:13:27+0800", "update_time": "2016-10-18T15:13:27+0800", }, { "member_id": 440964, "phone": "13********", "name": "", "vars": "{'beizhu':'ss'}", "create_time": "2016-10-18T15:13:27+0800", "update_time": "2016-10-18T15:13:27+0800", } ], "total": 2, "count": 2 }
              
              {
    "result": [
          {
                "member_id": 440164,
                "phone": "18********",
                "name": "",
                "vars": "{'beizhu':'hello'}",
                "create_time": "2016-10-18T15:13:27+0800",
                "update_time": "2016-10-18T15:13:27+0800",
            },
            {
                "member_id": 440964,
                "phone": "13********",
                "name": "",
                "vars": "{'beizhu':'ss'}",
                "create_time": "2016-10-18T15:13:27+0800",
                "update_time": "2016-10-18T15:13:27+0800",
            }
        ],
        "total": 2,
        "count": 2
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

เพิ่มสมาชิกในรายการ

เพิ่มสมาชิกในรายการผู้ติดต่อ

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST 
              
              POST
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json
              
              application/json
โค้ดนี้โชว์เป็นหน้าต่างลอย

หัวข้อคำขอ

Header Type Required Description
Authorization String true Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

Parameter Type Required Description
members Array [object] yes รายชื่อสมาชิก สูงสุด 1000 รายการ
phone string yes เบอร์โทรศัพท์ รูปแบบเบอร์โทรศัพท์สากล
name string no ชื่อสมาชิก สูงสุด 48 ตัวอักษร
vars object no ตัวแปร ขนาดสูงสุด 1 KB

คำแนะนำ:

  1. เมื่อเพิ่มตัวแปร vars โปรดทราบว่า key ไม่จำเป็นต้องเพิ่ม '%' และความยาวของ key ต้องไม่เกิน 32 ตัวอักษร
  2. ในตัวแปร vars key ที่เป็น name จะถูกแทนที่ด้วยพารามิเตอร์ name

ตัวอย่างคำขอ

curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "members": [ { "phone": "+86158452369825", "name": "aaa", "vars": {"sex":"male","code":"1"} }, { "phone": "+8618754265414", "name": "aaa", "vars": {"sex":"female","code":"2"} } ] }' 
              
              curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "members": [
        {
            "phone": "+86158452369825",
            "name": "aaa",
            "vars": {"sex":"male","code":"1"}
        },
        {
            "phone": "+8618754265414",
            "name": "aaa",
            "vars": {"sex":"female","code":"2"}
        }
    ]
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายค่าที่ส่งกลับ

Parameter Description
count จำนวนสมาชิกที่เพิ่มสำเร็จ
invalid สมาชิกที่ไม่ถูกต้อง

ตัวอย่างค่าที่ส่งกลับ

Response-success

HTTP Status: 200

{ "result": { "count": 1, "invalid": ["130****"] } }
              
              {
   "result": {
        "count": 1,
        "invalid": ["130****"]
    }
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    
    "code": 30000,
    "message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

// ตัวอย่างผลลัพธ์ที่ล้มเหลว { "code": 35008, "message": "The contactListId does not exist" }
              
              // ตัวอย่างผลลัพธ์ที่ล้มเหลว
{
    "code": 35008,
        "message": "The contactListId does not exist"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

แก้ไขสมาชิกในรายการ

อัปเดตสมาชิกในรายการผู้ติดต่อ

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}/members/{member_id}
              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}/members/{member_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

PUT 
              
              PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json
              
              application/json
โค้ดนี้โชว์เป็นหน้าต่างลอย

หัวข้อคำขอ

Header Type Required Description
Authorization String true Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

Parameter Type Required Description
member Object yes สมาชิกในรายการผู้ติดต่อ
phone string no เบอร์โทรศัพท์ รูปแบบเบอร์โทรศัพท์สากล
name string no ชื่อสมาชิก สูงสุด 48 ตัวอักษร
vars object no ตัวแปร ขนาดสูงสุด 1 KB ความยาว key ต้องไม่เกิน 32 ตัวอักษร

ตัวอย่างคำขอ

curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "member": { "phone": "158452369825", "name": "aaa", "vars": {"sex":"male","code":"1"} } }' 
              
              curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "member": 
        {
            "phone": "158452369825",
            "name": "aaa",
            "vars": {"sex":"male","code":"1"}
        }
    
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายค่าที่ส่งกลับ

Parameter Description
count จำนวนสมาชิกที่แก้ไขสำเร็จ

ตัวอย่างค่าที่ส่งกลับ

Response-success

HTTP Status: 200

{ "count": 1 }
              
              {
        "count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    
    "code": 30000,
    "message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

// ตัวอย่างผลลัพธ์ที่ล้มเหลว { "code": 35008, "message": "The contactListId does not exist" }
              
              // ตัวอย่างผลลัพธ์ที่ล้มเหลว
{
    "code": 35008,
        "message": "The contactListId does not exist"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

ลบสมาชิกในรายการ

ส่งคืนผลลัพธ์การลบสำเร็จหรือไม่

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DElETE
              
              DElETE
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/x-www-form-urlencoded
              
              application/x-www-form-urlencoded
โค้ดนี้โชว์เป็นหน้าต่างลอย

หัวข้อคำขอ

Header Type Required Description
Authorization String true Basic base64(sms_user:sms_key)

ตัวอย่างคำขอ

curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายค่าที่ส่งกลับ

Parameter Description
count จำนวนสมาชิกที่ลบสำเร็จ

ตัวอย่างค่าที่ส่งกลับ

Response-success

HTTP Status: 200

{ "count": 1 }
              
              {
"count": 1 
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    
    "code": 30000,
    "message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

// ตัวอย่างผลลัพธ์ที่ล้มเหลว { "code": 35008, "message": "The contactListId does not exist" }
              
              // ตัวอย่างผลลัพธ์ที่ล้มเหลว
{
    "code": 35008,
        "message": "The contactListId does not exist"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
icon
ติดต่อฝ่ายขาย