聯絡人

列出聯絡人

GET /api/contacts/

參數

參數名稱
必填
類型
說明

inbox

string

Deprecated: Use inboxes instead

inboxes

string

對話平台 ID (用於過濾特定 inbox 的聯絡人)

page

integer

A page number within the paginated result set.

pageSize

integer

Number of results to return per page.

query

string

姓名或來源ID搜尋

search

string

全文搜尋

程式碼範例

# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/contacts/?inbox=550e8400-e29b-41d4-a716-446655440000&inboxes=example&page=1&pageSize=1&query=example&search=example" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。

回應內容

狀態碼: 200

回應結構範例

回應範例值


建立聯絡人

POST /api/contacts/

程式碼範例

回應內容

狀態碼: 201

回應結構範例

回應範例值


獲取聯絡人詳情

GET /api/contacts/{id}/

參數

參數名稱
必填
類型
說明

id

string

A UUID string identifying this Contact.

程式碼範例

回應內容

狀態碼: 200

回應結構範例

回應範例值


更新聯絡人

PUT /api/contacts/{id}/

參數

參數名稱
必填
類型
說明

id

string

A UUID string identifying this Contact.

請求內容

請求參數

欄位
類型
必填
說明

name

string

聯絡人姓名

inboxes

array[object]

對話平台列表(新版格式)

inbox

object

單一對話平台(舊版格式,向前相容)

inbox.id

string (uuid)

對話平台 ID

avatar

string

頭像URL

sourceId

string

來源ID

queryMetadata

string

查詢元資料

請求結構範例

請求範例值

程式碼範例

回應內容

狀態碼: 200

回應結構範例

回應範例值


更新聯絡人

PATCH /api/contacts/{id}/

參數

參數名稱
必填
類型
說明

id

string

A UUID string identifying this Contact.

請求內容

請求參數

欄位
類型
必填
說明

name

string

聯絡人姓名

inboxes

array[object]

對話平台列表(新版格式)

inbox

object

單一對話平台(舊版格式,向前相容)

inbox.id

string (uuid)

對話平台 ID

avatar

string

頭像URL

sourceId

string

來源ID

queryMetadata

string

查詢元資料

請求結構範例

請求範例值

程式碼範例

回應內容

狀態碼: 200

回應結構範例

回應範例值


刪除聯絡人

DELETE /api/contacts/{id}/

參數

參數名稱
必填
類型
說明

id

string

A UUID string identifying this Contact.

程式碼範例

回應內容

狀態碼
說明

204

No response body

400

聯絡人還有關聯的對話,無法刪除


Last updated

Was this helpful?