API Reference
Tài liệu Pancake API
List pages
GET
https://pages.fm/api/v1/pages
Danh sách trang
Query Parameters
access_token*
String
Generate page access_token
POST
https://pages.fm/api/v1/pages/[:page_id]/
generate_page_access_token
Tạo hoặc làm mới access_token của trang
Query Parameters
page_id*
String
ID trang của khách hàng
access_token*
String
Conversations
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations
Danh sách cuộc trò truyện
Query Parameters
page_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ụ)
until*
timestamp
Thời gian kết thúc(dạng unix in seconds).
Khoảng thời gian bé hơn bằng 1 tháng
since*
timestamp
Thời gian bắt đầu(dạng unix in seconds)
page_id*
string
ID trang của khách hàng
page_number*
number
Trang hiện tại(nhỏ nhất 1)
order_by
String
Sắp xếp hội thoại (mặc định inserted_at) : inserted_at: thời gian tạo hội thoại
updated_at: thời gian cập nhật hội thoại
tags
String
Danh sách ID các thẻ cần lọc Ví dụ: 1,2,3,4
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
page_id*
String
ID trang của khách hàng
page_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
action*
String
Hành động (add: thêm thẻ, remove: gỡ thẻ)
tag_id*
String
ID của thẻ lấy từ api list
Conversation assignment
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/assign
Phân công nhân viên vào hội thoại
Query Parameters
page_id*
String
ID trang của khách hàng
conversation_id*
String
page_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ụ)
Request Body
assignee_ids*
Array
Danh sách id của nhân viên được phân công vào hội thoại vui lòng xem tại API danh sách người dùng
Mark read / unread conversation
Đánh dấu hội thoại thành đã đọc hoặc chưa đọc.
Mark read
POST
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/read?page_access_token=[:page_access_token]
Mark unread
POST
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/unread?page_access_token=[:page_access_token]
Query Parameters
page_id
*
string
ID của trang
conversation_id
*
string
ID của hội thoại
page_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ụ)
Response
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
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
page_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ụ)
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ữ
Ads statistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/pages_campaigns
Thống kê quảng cáo(bạn cần đăng nhập tài khoản có quyền xem báo cáo quảng cáo ở facebook và chọn page bạn muốn lấy thống kê trước khi gọi api)
Query Parameters
page_id*
String
ID trang của bạn
page_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*
timestamp
Thời gian bắt đầu(dạng unix in seconds)
until*
timestamp
Thời gian kết thúc (dạng unix in seconds)
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
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)
page_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ụ)
user_ids
String
Page statistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/pages
Query Parameters
page_id*
String
ID trang của bạn
page_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*
timestamp
Thời gian bắt đầu(dạng unix in seconds)
until*
timestamp
Thời gian kết thúc (dạng unix in seconds)
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
page_id*
String
ID trang của bạn
page_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*
timestamp
Thời gian bắt đầu(dạng unix in seconds)
until*
timestamp
Thời gian kết (dạng unix in seconds)
Users statatistics
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/users
Thống kê nhân viên
Query Parameters
page_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
access_token*
String
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
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
page_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