API Reference
Tài liệu Pancake API
List pages
GET
https://pages.fm/api/v1/pages
Danh sách trang
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 để lấy token này https://pages.fm/account |
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 page_access_token
Query Parameters
Name | Type | Description |
---|---|---|
page_id* | String | ID trang của khách hàng |
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 để lấy token này https://pages.fm/account - Cần sử dụng access_token có quyền ADMINISTER trên trang để tạo page_access_token |
Conversations
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations
Danh sách cuộc trò truyện
Query Parameters
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
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 |
Conversation assignment
POST
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
| string | ID của trang |
| string | ID của hội thoại |
| 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
Name | Type | Description |
---|---|---|
current_count | number | Dùng để đánh index vị trí muốn lấy tin nhắn cũ. Số này được tính bằng tổng số tin nhắn đã được kéo về - Hệ thống sẽ trả về 30 tin nhắn cũ liền trước tin ở vị trí current_count. |
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 Conversations) |
conversation_id* | string | ID hội thoại của bạn muốn lấy tin nhắn (Lấy từ API Conversations) |
page_id* | string | ID trang của bạn muốn lấy dữ |
Ads statistics
Campaign
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/pages_campaigns
Thống kê chiến dịch 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 trước khi gọi api)
Query Parameters
Name | Type | Description |
---|---|---|
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) |
Ads
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/ads
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 trước khi gọi api)
Query Parameters
Name | Type | Description |
---|---|---|
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) |
type* | String | Dạng dữ liệu muốn truy xuất. Có hai tuỳ chọn.
|
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) |
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 | Danh sách id nhân viên cần lọc phân tách nhau bằng dấu ,. Xem ở api https://docs.pancake.vn/developers/api-reference#user-list |
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 |
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
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 để 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 |
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
Query Parameters
Name | Type | Description |
---|---|---|
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ụ) |
since* | timestamp | Thời gian bắt đầu(dạng unix in seconds) |
until* | timestamp | Thời gian bắt đầu(dạng unix in seconds) |
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 đà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ụ) |
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 | 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) |
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 |
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ụ) |
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* | 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) |
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) |
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 list
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/users
Danh sách người dùng của trang
Query Parameters
Name | Type | Description |
---|---|---|
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ụ) |
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.
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 để lấy token này https://pages.fm/account |
Headers
Name | Type | Description |
---|---|---|
page_id* | string | ID trang của bạn |
conversation_id* | string | ID hội thoại chứa bình luận |
Request Body
Name | Type | Description |
---|---|---|
post_id* | string | ID bài viết chứa bình luận đó |
message_id | string | ID bình luận mà bạn muốn gửi tin nhắn từ bình luận đó |
action* | string | Để gửi tin nhắn từ bình luận cần đặt giá trị |
message* | string | Nội dung trả lời |
Send inbox
POST
https://pages.fm/api/v1/pages/[:page_id]/conversations/[:conversation_id]/messages
Gửi tin nhắn tới khách hàng
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 để lấy token này https://pages.fm/account |
Headers
Name | Type | Description |
---|---|---|
page_id* | string | ID trang của bạn |
conversation_id* | string | ID hội thoại |
Request Body
Name | Type | Description |
---|---|---|
name | string | Tên của file |
mime_type | string | mime_type của file muốn gửi(image,...) |
content_url | string | Đường dẫn của hình ảnh(file) muốn gửi (https://i.ibb.co/mzh7ck8/alaska-beo-acef3fcb1cc541a79048f4bbafed71c8-grande.png) |
attachmentType | string | Kiểu dữ liệu của attachment muốn gửi (PHOTO, DOCUMENT) |
action* | string | Để gửi tin nhắn cần đặt giá trị |
message | string | Nội dung tin nhắn |
thread_key | string | key của hội thoại muốn gửi tin nhắn |
Reply comment
Gửi trả lời bình luận của khách hàng.
N dung gửi phải chứa tối thiểu một message hoặc một image.
POST
https://pages.fm/api/v1/pages/[:page_id]/conversations/[:conversation_id]/messages
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 để lấy token này https://pages.fm/account |
Headers
Name | Type | Description |
---|---|---|
page_id* | string | ID trang của bạn |
conversation_id* | string | ID hội thoại |
Request Body
Name | Type | Description |
---|---|---|
action* | string | Để gửi tin nhắn cần đặt giá trị |
message_id | string | ID của comment muốn gửi phản hồi. |
message | string | Nội dung tin nhắn |
content_url | string | Đường dẫn của hình ảnh(file) muốn gửi (https://i.ibb.co/mzh7ck8/alaska-beo-acef3fcb1cc541a79048f4bbafed71c8-grande.png) |
image_data | string | data của file muốn gửi. Cần có nếu có content_url. VD: {height: 100, width: 100} |
Last updated