API Reference
Tài liệu Pancake API
Tài liệu Pancake API
GET
https://pages.fm/api/v1/pages
Danh sách trang
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations
Danh sách cuộc trò truyện
POST
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/tags
Thêm gỡ thẻ hội
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
Đánh dấu hội thoại thành đã đọc hoặc chưa đọc.
POST
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/read?page_access_token=[:page_access_token]
POST
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/unread?page_access_token=[:page_access_token]
Response
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/conversations/[:conversation_id]/messages
Danh sách tin nhắn
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)
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/customer_engagements
Thống kê tương tác
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/pages
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/tags
Thống kê thẻ hội thoại
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/users
Thống kê nhân viên
GET
https://pages.fm/api/v1/statistics/user
Thống kê nhân viên chế độ gộp
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
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/page_customers
Thông tin khách hàng
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/sip_call_logs
Danh sách cuộc gọi
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/tags
Danh sách thẻ của trang
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/posts
GET
https://pages.fm/api/public_api/v1/pages/[:page_id]/users
Danh sách người dùng của trang
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.
POST
https://pages.fm/api/v1/pages/[:page_id]/conversations/[:conversation_id]/messages
Gửi tin nhắn tới khách hàng
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
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
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_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 ADVANCE để lấy token này https://pages.fm/account
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
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
action*
String
Hành động (add: thêm thẻ, remove: gỡ thẻ)
tag_id*
String
ID của thẻ lấy từ api list
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ụ)
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
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ụ)
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ữ
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)
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_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)
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)
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)
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
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_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)
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
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ụ)
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ụ)
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ụ)
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_id*
string
ID trang của bạn
conversation_id*
string
ID hội thoại chứa bình luận
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ị private_replies
message*
string
Nội dung trả lời
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_id*
string
ID trang của bạn
conversation_id*
string
ID hội thoại
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ị reply_inbox
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
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_id*
string
ID trang của bạn
conversation_id*
string
ID hội thoại
action*
string
Để gửi tin nhắn cần đặt giá trị reply_comment
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}