建立對話
開發者可透過 API 為指定聯絡人建立對話。
請求方式
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)' \
{
"inbox_id": 407, // 必填
"contact_id": 2219256, // contact_id 與 source_id 可擇一傳入，但必須確保能正確識別發送者
"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)' \
{
"inbox_id": 407, // 必填
"contact_id": 2219256, // contact_id 與 source_id 可擇一傳入，但必須確保能正確識別發送者
"source_id": "123456789"
}
此代碼塊在浮窗中顯示
請求 Header 參數
| Field | Type | Description |
|---|---|---|
| Authorization | string | 使用 Authorization: Basic base64(API Key:API Secret) 進行身分驗證。請前往 API Key 頁面取得 API Key 與 API Secret，並以冒號連接後進行 Base64 編碼。 |
| Content-Type | application/json | 資料類型，純文字訊息請使用 application/json。 |
請求 Body 參數
| Field | Type | Required | Description |
|---|---|---|---|
| inbox_id | String | Yes | 渠道 ID，需與建立聯絡人介面中使用的 ID 保持一致。 |
| contact_id | String | No | 聯絡人 ID，即建立聯絡人介面回傳結果中的 id。 |
| 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 | 在線狀態。 |
| 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 | SLA 策略 ID。 |
| 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 | 團隊名稱。 |
