API Reference
Dokumen Pancake API
Conversations
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations
Daftar percakapan
Query Parameters
Name | Type | Description |
---|---|---|
access_token* | string | Akses token user (dapat dibuat oleh pelanggan) |
until* | number | Waktu berakhir (type: unix) |
since* | number | Waktu mulai (type: unix) |
page_id* | string | ID halaman |
page_number* | number | Halaman saat ini (minimal 1) |
order_by | String | Urutan percakapan (bawaan inserted_at) : inserted_at: waktu masuk percakapan updated_at: waktu update percakapan |
Get messages
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/messages
Danh sách tin nhắn
Query Parameters
Name | Type | Description |
---|---|---|
current_count | number | Dùng để đánh index vị trí muốn lấy tin nhắn - Khi gọi API không truyền current_count hệ thống sẽ trả về 20 tin nhắn mới nhất. - Tiếp tục khi truyền tham số current_count là 20 hệ thống sẽ trả về 25 tin nhắn cũ hơn từ vị trí thứ 20 - Lưu ý: khi không truyền current_count sẽ trả về 20 tin nhắn, có current_count sẽ trả về 25 tin nhắn |
access_token* | string | Chuỗi access_token của khách hàng cung cấp từ Pancake |
customer_id* | string | ID của khách hàng(Lấy từ api get conversation) |
conversation_id* | string | ID hội thoại của bạn muốn lấy tin nhắn(Lấy từ api get conversation) |
page_id* | string | ID trang của bạn muốn lấy dữ |
Engagement statistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/customer_engagements
Thống kê tương tác
Query Parameters
Name | Type | Description |
---|---|---|
by_hour | boolean | Thống kê theo giờ |
date_range* | string | Khoảng thời gian thống kê (ví dụ: 27/07/2021 00:00:00 - 26/08/2021 23:59:59) |
access_token* | string | Chuỗi token của page (Khách hàng có thể tạo ở mục cài đặt công cụ) |
Page statistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/pages
Query Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của bạn |
access_token* | String | Chuỗi token của page (Khách hàng có thể tạo ở mục cài đặt công cụ) |
since* | Number | Thời gian bắt đầu(dạng unix) |
until* | Number | Thời gian kết thúc (dạng unix) |
Tag statistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/tags
Thống kê thẻ hội thoại
Query Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của bạn |
access_token* | String | Chuỗi token của page (Khách hàng có thể tạo ở mục cài đặt công cụ) |
since* | Number | Thời gian bắt đầu(dạng unix) |
until* | Number | Thời gian kết (dạng unix) |
Users statatistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/users
Thống kê nhân viên
Query Parameters
Name | Type | Description |
---|---|---|
access_token* | string | Chuỗi token của page (Khách hàng có thể tạo ở mục cài đặt công cụ) |
date_range* | string | Khoảng thời gian thống kê (ví dụ: 27/07/2021 00:00:00 - 26/08/2021 23:59:59) |
Users statatistics multiple pages
GET
https://pages.fm/api/v1/statistics/user
Thống kê nhân viên chế độ gộp
Query Parameters
Name | Type | Description |
---|---|---|
access_token* | String | Chuỗi token pancake của người dùng. Bạn có thể truy cập link dưới đây sau đó click vào ADVANCE để lấy token này https://pages.fm/account |
page_ids* | String | Danh sách ID trang cần thống kê ví dụ: page_id1,page_id2,... |
date_range* | String | Khoảng thời gian cần thống kê ví dụ: 05/08/2022 00:00:00 - 06/08/2022 23:59:59 |
New customer statistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/customers
Thống kê khách hàng mới theo thời gian
Path Parameters
Name | Type | Description |
---|---|---|
group_by | string | Tuỳ chọn phương thức nhóm dữ liệu. Truyền vào một trong các string sau: - day (default): Trả về dữ liệu theo ngày - hour : Trả về dữ liệu theo giờ - page_id : Trả về dữ liệu theo các trang |
access_token* | string | Chuỗi token của page(Khách hàng có thể tạo ở mục cài đặt công cụ) |
date_range* | string | Khoảng thời gian cần thống kê ví dụ: 20/07/2020 - 20/08/2020 |
page_id* | string | ID trang của khách hàng |
Page customers
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/page_customers
Thông tin khách hàng
Query Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của khách hàng |
access_token* | String | Chuỗi token của page(Khách hàng có thể tạo ở mục cài đặt công cụ) |
since* | number | Thời gian bắt đầu(dạng unix) |
until* | number | Thời gian bắt đầu(dạng unix) |
page_number* | number | Trang hiện tại(nhỏ nhất 1) |
page_size | number | Độ lớn của trang(tối đa 100) |
Call logs
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/sip_call_logs
Danh sách cuộc gọi
Path Parameters
Name | Type | Description |
---|---|---|
id* | String | ID gói cước tổng |
access_token* | String | Chuỗi token của page(Khách hàng có thể tạo ở mục cài đặt công cụ) |
page_number* | Number | Trang hiện tại(nhỏ nhất 1) |
page_size* | Number | Độ dài của trang(ln nhất 30) |
since | Number | Thời gian bắt đầu(dạng unix) |
until | Number | Thời gian kết thúc(dạng unix) |
page_id* | Number | ID trang của |
List tags
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/tags
Danh sách thẻ của trang
Query Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của khách hàng |
access_token* | String | Chuỗi token của page(Khách hàng có thể tạo ở mục cài đặt công cụ) |
Tag conversation
POST
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/tags
Thêm gỡ thẻ hội
Path Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của khách hàng |
access_token* | String | Chuỗi token của page(Khách hàng có thể tạo ở mục cài đặt công cụ) |
conversation_id* | String | ID của hội thoại lấy từ api danh sách hội th |
Request Body
Name | Type | Description |
---|---|---|
action* | String | Hành động (add: thêm thẻ, remove: gỡ thẻ) |
tag_id* | String | ID của thẻ lấy từ api list |
Posts
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/posts
Query Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của khách hàng |
since* | Number | Thời gian bắt đầu(dạng unix) |
until* | Number | Thời gian kết thúc(dạng unix) |
page_number* | Number | Trang hiện tại(nhỏ nhất 1) |
page_size* | Number | Độ dài của trang(lớn nhất 30) |
Send private reply
POST
https://pages.fm/api/v1pages/[:page_id]/conversations/[:conversation_id]/messages
Dùng để gửi tin nhắn từ bình luận Gửi tin nhắn từ bình luận chỉ gửi được một lần duy nhất cho một comment. Theo quy định của Facebook chỉ gửi được tin nhắn cho bình luận được tạo không quá 7 ngày.