สร้างการสนทนา

นักพัฒนาสามารถสร้างการสนทนาผ่าน API แล้วส่งข้อความถึงลูกค้าโดยใช้ Conversation ID

วิธีการส่งคำขอ

POST

URL คำขอ

https://livedesk-api.engagelab.com/api/v2/accounts/conversations

การตรวจสอบสิทธิ์

ดูรายละเอียดได้ที่คำแนะนำเกี่ยวกับการตรวจสอบสิทธิ์ใน ภาพรวม API

คำขอ

ตัวอย่างคำขอสร้างการสนทนา

curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "inbox_id": 407, "contact_id": 2219256, "source_id": "123456789" }'
              
              curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(api_key:api_secret)' \
  -d '{
    "inbox_id": 407,
    "contact_id": 2219256,
    "source_id": "123456789"
  }'

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

จำเป็นต้องระบุ inbox_id และระบุ contact_id หรือ source_id อย่างใดอย่างหนึ่ง โดยต้องระบุค่าใดค่าหนึ่งเพื่อระบุผู้ติดต่อให้ถูกต้อง

พารามิเตอร์ส่วนหัวคำขอ

Field Type Description
Authorization string ตรวจสอบสิทธิ์โดยใช้ Authorization: Basic base64(API Key:API Secret) ไปที่หน้าคีย์ API เพื่อรับ API key และ API secret จากนั้นเชื่อมค่าทั้งสองด้วยเครื่องหมายโคลอน แล้วเข้ารหัสผลลัพธ์ด้วย Base64
Content-Type application/json ประเภทข้อมูล ใช้ application/json สำหรับข้อมูลข้อความทั่วไป

พารามิเตอร์เนื้อหาคำขอ

Field Type Required Description
inbox_id String Yes ID ของช่องทาง ซึ่งต้องสอดคล้องกับ ID ที่ใช้โดย Create Contact API
contact_id String No ID ของผู้ติดต่อ ซึ่งเป็น ID ที่ส่งคืนโดย Create Contact API
source_id String No ID ของแหล่งที่มา

การตอบกลับ

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

{ "meta": { "sender": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219256, "name": "wjTest", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571624 }, "channel": "Channel::Api", "hmac_verified": false }, "id": 40, "messages": [], "account_id": 17623000010928, "uuid": "660ce36f-46bb-4153-948c-8a26e6dab634", "inbox_id": 407, "additional_attributes": {}, "agent_last_seen_at": 0, "assignee_last_seen_at": 0, "can_reply": true, "contact_last_seen_at": 0, "custom_attributes": {}, "labels": [], "muted": false, "snoozed_until": null, "status": "open", "priority": null, "conversation_category": "chat", "chat_mode": "private_chat", "is_forum": false, "created_at": 1766572062, "updated_at": 1766572062.5803902, "timestamp": 1766572062, "first_reply_created_at": 0, "unread_count": 0, "last_non_activity_message": null, "last_activity_at": 1766572062, "waiting_since": 1766572062, "sla_policy_id": null, "ticket_id": null, "over_limit": false, "content_preview": { "content": null, "message_type": null, "created_at": null }, "platform": { "channel_type": "Channel::Api", "inbox_name": "JennyApi", "inbox_id": 407 }, "account_info": { "contact_name": "wjTest", "contact_email": null, "contact_phone": null, "contact_id": 2219256, "contact_avatar": "" }, "assignment": { "assignee_id": null, "assignee_name": null, "assignee_email": null, "team_id": null, "team_name": null } }
              
              {
    "meta": {
        "sender": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": null,
            "id": 2219256,
            "name": "wjTest",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "created_at": 1766571624
        },
        "channel": "Channel::Api",
        "hmac_verified": false
    },
    "id": 40,
    "messages": [],
    "account_id": 17623000010928,
    "uuid": "660ce36f-46bb-4153-948c-8a26e6dab634",
    "inbox_id": 407,
    "additional_attributes": {},
    "agent_last_seen_at": 0,
    "assignee_last_seen_at": 0,
    "can_reply": true,
    "contact_last_seen_at": 0,
    "custom_attributes": {},
    "labels": [],
    "muted": false,
    "snoozed_until": null,
    "status": "open",
    "priority": null,
    "conversation_category": "chat",
    "chat_mode": "private_chat",
    "is_forum": false,
    "created_at": 1766572062,
    "updated_at": 1766572062.5803902,
    "timestamp": 1766572062,
    "first_reply_created_at": 0,
    "unread_count": 0,
    "last_non_activity_message": null,
    "last_activity_at": 1766572062,
    "waiting_since": 1766572062,
    "sla_policy_id": null,
    "ticket_id": null,
    "over_limit": false,
    "content_preview": {
        "content": null,
        "message_type": null,
        "created_at": null
    },
    "platform": {
        "channel_type": "Channel::Api",
        "inbox_name": "JennyApi",
        "inbox_id": 407
    },
    "account_info": {
        "contact_name": "wjTest",
        "contact_email": null,
        "contact_phone": null,
        "contact_id": 2219256,
        "contact_avatar": ""
    },
    "assignment": {
        "assignee_id": null,
        "assignee_name": null,
        "assignee_email": null,
        "team_id": null,
        "team_name": null
    }
}

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

พารามิเตอร์การตอบกลับ

Field Type Required Description
meta Object No ออบเจ็กต์ข้อมูลเมตา
sender Object No ข้อมูลผู้ส่ง
additional_attributes Object No คุณลักษณะเพิ่มเติม
availability_status String No สถานะความพร้อมใช้งาน
email Null No ที่อยู่อีเมล
id Number No ID ผู้ติดต่อ
name String No ชื่อผู้ส่ง
phone_number Null No หมายเลขโทรศัพท์
blocked Boolean No ระบุว่าผู้ส่งถูกบล็อกหรือไม่
identifier Null No ตัวระบุแอตทริบิวต์ของผู้ใช้
thumbnail String No ภาพขนาดย่อ
custom_attributes Object No คุณลักษณะที่กำหนดเอง
created_at Number No ประทับเวลาที่สร้างการสนทนา
channel String No ประเภทช่องทาง
hmac_verified Boolean No สถานะการตรวจสอบ HMAC
id Number No ID การสนทนา
messages Array No อาร์เรย์ข้อความ
account_id Number No ID โปรเจ็กต์
uuid String No ตัวระบุเฉพาะ
inbox_id Number No ID ช่องทาง
additional_attributes Object No คุณลักษณะเพิ่มเติม
agent_last_seen_at Number No เวลาที่เอเจนต์เห็นการสนทนาครั้งล่าสุด
assignee_last_seen_at Number No เวลาที่ผู้รับผิดชอบเห็นการสนทนาครั้งล่าสุด
can_reply Boolean No ระบุว่าสามารถส่งการตอบกลับได้หรือไม่
contact_last_seen_at Number No เวลาที่ผู้ติดต่อเห็นการสนทนาครั้งล่าสุด
custom_attributes Object No คุณลักษณะที่กำหนดเอง
labels Array No อาร์เรย์ป้ายกำกับ
muted Boolean No ระบุว่าการสนทนาถูกปิดเสียงหรือไม่
snoozed_until Null No เวลาที่การเลื่อนการสนทนาจะสิ้นสุด
status String No สถานะ
priority Null No ลำดับความสำคัญ
conversation_category String No หมวดหมู่การสนทนา
chat_mode String No โหมดแชท
is_forum Boolean No ระบุว่าการสนทนาเป็นฟอรัมหรือไม่
created_at Number No ประทับเวลาที่สร้าง
updated_at Number No ประทับเวลาที่อัปเดต
timestamp Number No ประทับเวลา
first_reply_created_at Number No เวลาที่สร้างการตอบกลับครั้งแรก
unread_count Number No จำนวนข้อความที่ยังไม่ได้อ่าน
last_non_activity_message Null No ข้อความล่าสุดที่ไม่ใช่กิจกรรม
last_activity_at Number No เวลาที่มีกิจกรรมล่าสุด
waiting_since Number No เวลาที่เริ่มรอ
sla_policy_id Null No ID นโยบาย SLA
ticket_id Null No ID ทิกเก็ต
over_limit Boolean No ระบุว่าเกินขีดจำกัดหรือไม่
content_preview Object No ตัวอย่างเนื้อหา
content_preview.content Null No เนื้อหาตัวอย่าง
content_preview.message_type Null No ประเภทข้อความ
content_preview.created_at Null No เวลาที่สร้าง
platform Object No ข้อมูลแพลตฟอร์ม
channel_type String No ประเภทช่องทาง
inbox_name String No ชื่อกล่องข้อความ
inbox_id Number No ID กล่องข้อความ
account_info Object No ข้อมูลบัญชี
contact_name String No ชื่อผู้ติดต่อ
contact_email Null No ที่อยู่อีเมลของผู้ติดต่อ
contact_phone Null No หมายเลขโทรศัพท์ของผู้ติดต่อ
contact_id Number No ID ผู้ติดต่อ
contact_avatar String No รูปประจำตัวของผู้ติดต่อ
assignment Object No ข้อมูลการมอบหมาย
assignee_id Null No ID ผู้รับผิดชอบ
assignee_name Null No ชื่อผู้รับผิดชอบ
assignee_email Null No ที่อยู่อีเมลของผู้รับผิดชอบ
team_id Null No ID ทีม
team_name Null No ชื่อทีม
Icon Solid Transparent White Qiyu
ติดต่อฝ่ายขาย