Tham chiếu: Hội thoại

Trang chat, hội thoại, tin nhắn, thẻ và bình luận. Mọi đường dẫn dưới https://danix.vn/api/open/v1. Đặc tả máy đọc: openapi.json.

Các trang chat được dùng

GET /pages

Chỉ liệt kê những trang mà ứng dụng kết nối được chọn lúc tạo.

Quyền cần có: khoá có quyền social.pages.read.

Ví dụ yêu cầu

curl -X GET "https://danix.vn/api/open/v1/pages" \
  -H "Authorization: Bearer dnx_live_…"

Phản hồi mẫu (200)

{
  "data": [
    {
      "id": "018f3b8e-1c2d-7a4b-9c3d-000000001301",
      "providerPageId": "1090000000000001",
      "provider": "facebook_page",
      "pageName": "Shop Mẫu",
      "avatarUrl": null,
      "status": "active"
    }
  ]
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Liệt kê hội thoại

GET /conversations

Phân trang theo con trỏ, hội thoại có tin mới nhất trước. Lọc theo trang bằng pageId (mã trang trong DANIX, id của GET /pages); trang ngoài danh sách của ứng dụng bị từ chối not-found. Hội thoại chưa có tin nào không được liệt kê (vẫn đọc được theo id).

Quyền cần có: khoá có ít nhất một trong các quyền social.conversations.read, social.conversations.reply và quyền social.pages.read.

Tham số query

Ví dụ yêu cầu

curl -X GET "https://danix.vn/api/open/v1/conversations" \
  -H "Authorization: Bearer dnx_live_…"

Phản hồi mẫu (200)

{
  "data": [
    {
      "id": "018f3b8e-1c2d-7a4b-9c3d-000000001201",
      "pageId": "018f3b8e-1c2d-7a4b-9c3d-000000001301",
      "providerPageId": "1090000000000001",
      "provider": "facebook_page",
      "type": "INBOX",
      "customerName": "Nguyễn Văn An",
      "customerAvatarUrl": null,
      "unreadCount": 1,
      "lastMessageText": "Shop ơi áo này còn size M không?",
      "lastMessageAt": "2026-10-02T03:15:00.000Z",
      "lastMessageBy": "customer",
      "tags": [],
      "createdAt": "2026-10-01T03:15:00.000Z"
    }
  ],
  "nextCursor": null
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Chi tiết một hội thoại

GET /conversations/{id}

Trả hội thoại kèm thẻ và số tin chưa đọc.

Quyền cần có: khoá có ít nhất một trong các quyền social.conversations.read, social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Ví dụ yêu cầu

curl -X GET "https://danix.vn/api/open/v1/conversations/{id}" \
  -H "Authorization: Bearer dnx_live_…"

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (200)

{
  "id": "018f3b8e-1c2d-7a4b-9c3d-000000001201",
  "pageId": "018f3b8e-1c2d-7a4b-9c3d-000000001301",
  "providerPageId": "1090000000000001",
  "provider": "facebook_page",
  "type": "INBOX",
  "customerName": "Nguyễn Văn An",
  "customerAvatarUrl": null,
  "unreadCount": 0,
  "lastMessageText": "Dạ còn ạ",
  "lastMessageAt": "2026-10-02T03:16:00.000Z",
  "lastMessageBy": "page",
  "tags": [],
  "createdAt": "2026-10-01T03:15:00.000Z"
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Đánh dấu hội thoại đã đọc

POST /conversations/{id}/read

Đặt số tin chưa đọc về 0.

Quyền cần có: khoá có ít nhất một trong các quyền social.conversations.read, social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Ví dụ yêu cầu

curl -X POST "https://danix.vn/api/open/v1/conversations/{id}/read" \
  -H "Authorization: Bearer dnx_live_…"

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (200)

{
  "ok": true
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Tin nhắn của hội thoại

GET /conversations/{id}/messages

Phân trang theo con trỏ, tin mới nhất trước.

Quyền cần có: khoá có ít nhất một trong các quyền social.conversations.read, social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Tham số query

Ví dụ yêu cầu

curl -X GET "https://danix.vn/api/open/v1/conversations/{id}/messages" \
  -H "Authorization: Bearer dnx_live_…"

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (200)

{
  "data": [
    {
      "id": "018f3b8e-1c2d-7a4b-9c3d-000000001101",
      "conversationId": "018f3b8e-1c2d-7a4b-9c3d-000000001201",
      "pageId": "018f3b8e-1c2d-7a4b-9c3d-000000001301",
      "providerPageId": "1090000000000001",
      "provider": "facebook_page",
      "direction": "outbound",
      "type": "text",
      "text": "Dạ còn ạ, anh chị cần mấy cái ạ?",
      "status": "sent",
      "isDeleted": false,
      "sentByName": "Trần Thị Bình",
      "sentByIsIntegration": false,
      "customerName": "Nguyễn Văn An",
      "attachments": [],
      "createdAt": "2026-10-02T03:15:00.000Z"
    }
  ],
  "nextCursor": null
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Gửi tin nhắn

POST /conversations/{id}/messages

Gửi một tin nhắn chữ trong hội thoại. Gửi kèm Idempotency-Key: cùng khoá trong CÙNG hội thoại không gửi hai lần (cùng khoá ở hội thoại khác là một tin mới). Ngoài khung thời gian cho phép của kênh trả messaging-window-closed.

Quyền cần có: khoá có quyền social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Header

Thân yêu cầu (JSON)

Ví dụ yêu cầu

curl -X POST "https://danix.vn/api/open/v1/conversations/{id}/messages" \
  -H "Authorization: Bearer dnx_live_…" \
  -H "Idempotency-Key: a58738ee-0d77-444d-96c4-c547752c5c17" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Dạ còn ạ, anh chị cần mấy cái ạ?"
}'

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (201)

{
  "id": "018f3b8e-1c2d-7a4b-9c3d-000000001101",
  "conversationId": "018f3b8e-1c2d-7a4b-9c3d-000000001201",
  "pageId": "018f3b8e-1c2d-7a4b-9c3d-000000001301",
  "providerPageId": "1090000000000001",
  "provider": "facebook_page",
  "direction": "outbound",
  "type": "text",
  "text": "Dạ còn ạ, anh chị cần mấy cái ạ?",
  "status": "sent",
  "isDeleted": false,
  "sentByName": "Trần Thị Bình",
  "sentByIsIntegration": false,
  "customerName": "Nguyễn Văn An",
  "attachments": [],
  "createdAt": "2026-10-02T03:15:00.000Z"
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Các thẻ hội thoại

GET /tags

Thẻ hội thoại của các trang ứng dụng được dùng. Thẻ là của từng trang (pageId): chỉ gắn được vào hội thoại cùng trang.

Quyền cần có: khoá có ít nhất một trong các quyền social.conversations.read, social.conversations.reply và quyền social.pages.read.

Ví dụ yêu cầu

curl -X GET "https://danix.vn/api/open/v1/tags" \
  -H "Authorization: Bearer dnx_live_…"

Phản hồi mẫu (200)

{
  "data": [
    {
      "id": "018f3b8e-1c2d-7a4b-9c3d-000000001401",
      "name": "Khách quen",
      "color": "blue",
      "pageId": "018f3b8e-1c2d-7a4b-9c3d-000000001301"
    }
  ]
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Gắn thẻ vào hội thoại

POST /conversations/{id}/tags

Gắn một thẻ có sẵn vào hội thoại. Gắn lại thẻ đã có là thành công.

Quyền cần có: khoá có quyền social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Thân yêu cầu (JSON)

Ví dụ yêu cầu

curl -X POST "https://danix.vn/api/open/v1/conversations/{id}/tags" \
  -H "Authorization: Bearer dnx_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "tagId": "018f3b8e-1c2d-7a4b-9c3d-000000001401"
}'

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (200)

{
  "ok": true
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Gỡ thẻ khỏi hội thoại

DELETE /conversations/{id}/tags/{tagId}

Gỡ một thẻ khỏi hội thoại.

Quyền cần có: khoá có quyền social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Ví dụ yêu cầu

curl -X DELETE "https://danix.vn/api/open/v1/conversations/{id}/tags/{tagId}" \
  -H "Authorization: Bearer dnx_live_…"

Thay {id}, {tagId} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (200)

{
  "ok": true
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Ẩn hoặc hiện một bình luận

POST /comments/{id}/hidden

Chỉ áp dụng cho bình luận (type = COMMENT) của trang Facebook.

Quyền cần có: khoá có quyền social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Thân yêu cầu (JSON)

Ví dụ yêu cầu

curl -X POST "https://danix.vn/api/open/v1/comments/{id}/hidden" \
  -H "Authorization: Bearer dnx_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "hidden": true
}'

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (200)

{
  "ok": true
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.

Nhắn riêng cho người bình luận

POST /comments/{id}/private-reply

Gửi một tin nhắn riêng đáp lại bình luận. Mỗi bình luận chỉ nhắn riêng được một lần.

Quyền cần có: khoá có quyền social.conversations.reply và quyền social.pages.read.

Tham số đường dẫn

Thân yêu cầu (JSON)

Ví dụ yêu cầu

curl -X POST "https://danix.vn/api/open/v1/comments/{id}/private-reply" \
  -H "Authorization: Bearer dnx_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Cảm ơn bạn đã quan tâm, shop nhắn riêng nhé"
}'

Thay {id} trong địa chỉ bằng mã thật của bản ghi, và dnx_live_… bằng khoá của bạn.

Phản hồi mẫu (201)

{
  "id": "018f3b8e-1c2d-7a4b-9c3d-000000001101",
  "conversationId": "018f3b8e-1c2d-7a4b-9c3d-000000001201",
  "pageId": "018f3b8e-1c2d-7a4b-9c3d-000000001301",
  "providerPageId": "1090000000000001",
  "provider": "facebook_page",
  "direction": "outbound",
  "type": "text",
  "text": "Dạ còn ạ, anh chị cần mấy cái ạ?",
  "status": "sent",
  "isDeleted": false,
  "sentByName": "Trần Thị Bình",
  "sentByIsIntegration": false,
  "customerName": "Nguyễn Văn An",
  "attachments": [],
  "createdAt": "2026-10-02T03:15:00.000Z"
}

Trường của phản hồi

Lỗi

Định dạng lỗi và bảng mọi mã code: Lỗi.