Tiếng Việt

API Reference

Tài liệu Pancake API

List pages

GET https://pages.fm/api/v1/pages

Danh sách trang

Query Parameters

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

Conversations

GET https://pages.fm/api/public_api/v2/pages/[:page_id]/conversations

Danh sách hội thoại theo thời gian cập nhật từ mới tới cũ.

Query Parameters

{
  "conversations": [{
      "page_id": "wa_c.us@84328290781",
      "customer_id": "72bea3ea-722a-4e33-b415-2b2281f44724",
      "assignee_histories": [{
          "conversation_id": "wa_84328290781@c.us_62818166016@c.us",
          "inserted_at": "2021-08-26T06:29:56",
          "payload": {
              "added_users": [{
                  "email": "phamdongtx@gmail.com",
                  "fb_id": "1831989023699268",
                  "id": "82be33ea-729a-4e83-be15-2b7c83f34724",
                  "name": "Pham Dong"
              }],
              "deleted_users": []
          }
      }],
      "type": "INBOX",
      "inserted_at": "2021-08-26T06:29:56",
      "tags": [],
      "recent_phone_numbers": [],
      "customers": [{
          "avatar_url": "84328290781@c.us_1621224114",
          "fb_id": "wa_c.us@62818166016",
          "id": "d8526c77-832a-425c-8aee-e5d7dfcd7cd0",
          "name": "Babywearit (+62 81 816 6016)"
      }],
      "has_phone": false,
      "tag_histories": [],
      "post_id": null,
      "id": "wa_84328290781@c.us_62818166016@c.us",
      "last_sent_by": {
          "avatar_url": "84328290781@c.us_1621224114",
          "id": "wa_c.us@62818166016",
          "name": "Babywearit (+62 81 816 6016)",
          "phone_number": "62818166016"
      },
  }],
  "success": true
}

Chú thích
    "conversations": Danh sách hội thoại
        Chi tiết hội thoại:
            "page_id": id trang
            "customer_id": id khách hàng 
            "assignee_histories": Lịch sử phân công hội thoại
            "type": Kiểu hội thoại(INBOX, COMMENT, RATING)
            "inserted_at": Thời  tạo hội thoại
            "tags": Tag hiện tại được gắn
            "recent_phone_numbers": Số điện thoại của hội thoại
            "customers": Thông tin khách hàng
            "has_phone": Có số điện thoại hay không
            "tag_histories": Lịch sử gắn gỡ tag
            "post_id": ID bài post nếu là comment
            "last_sent_by": Người gửi tin nhắn
            "current_assign_users": Danh sách phần công thời điểm hiện tại
            "ad_ids": Danh sách ad_id

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

Request Body

{
  "data": [  // Danh sách thẻ hiện sau khi update
    0,
    1,
    2,
    4,
    5
  ],
  "success": true, 
  "timestamp": 1652845231603964 // Thời điểm thao tác 
}

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

Request Body

{
  "assignee_group_id": "2",
  "assignee_ids": [
    "3fadfd70-1ead-4a16-a456-1fa007e38e5c",
    "6aa49b8e-c554-44e4-81ba-c50a2d5b51b3",
    "28f4673e-14f2-4556-840d-7aae58e9b8ed"
  ],
  "customers": [
    {
      "fb_id": "2810250135746666",
      "id": "03996852-8fa6-4ae9-b2d0-d95bd67d9d8e",
      "name": "Quyết Nguyễn"
    }
  ],
  "from": {
    "email": "2810250135746666@facebook.com",
    "id": "2810250135746666",
    "name": "Quyết Nguyễn"
  },
  "from_psid": "2810250135746666",
  "has_phone": true,
  "id": "110699180573884_2810250135746666",
  "inserted_at": "2020-07-11T09:02:30",
  "is_combined": false,
  "is_removed": false,
  "last_customer_interactive_at": "2023-04-05T02:21:57",
  "last_sent_by": {
    "admin_id": "570423649807405",
    "admin_name": "Quyết Nguyễn",
    "id": "110699180573884",
    "name": "MemeViet"
  },
  "message_count": 584,
  "page_id": "110699180573884",
  "post_id": null,
  "read_watermarks": [
    {
      "message_id": "m_ffBfntulf9g2vp6pR7YwsKeDRTqVhl7NbvRZnivNqM6Ne5MDNuQ0joWh0hV_vkZpeR3ufBRiwFcHlvl-Ru4csg",
      "psid": "2810250135746666",
      "watermark": 1680661734
    }
  ],
  "recent_phone_numbers": [
    {
      "captured": "0328290781",
      "length": 10,
      "m_content": "0328290781",
      "m_id": "m_8RFElPVHVrjAQU6873W5NqeDRTqVhl7NbvRZnivNqM7Pix1jcT6D8wAqt-Iz4hQrd00MZ5wSSCbA_nJ2GXKOEQ",
      "offset": 0,
      "phone_number": "0328290781",
      "status": 1
    },
    {
      "captured": "0812997207",
      "length": 10,
      "m_content": "0812997207",
      "m_id": "m_dLjh8RpYYE0ArTATcXnsuKeDRTqVhl7NbvRZnivNqM5XGk23-yiMFXeRa-Cxb786YiyNbIQVNnSB9Y6Ou0OsRw",
      "offset": 0,
      "phone_number": "0812997207",
      "status": 0
    },
    {
      "captured": "0328290798",
      "length": 10,
      "m_content": "0328290798",
      "m_id": "m_4-wlt-8bPT8zXzsJlf-U26eDRTqVhl7NbvRZnivNqM66wsnYisL2VAL-yJOv5hrQf5K9dIbKA84Jf4ZcaVghpA",
      "offset": 0,
      "phone_number": "0328290798",
      "status": 0
    },
    {
      "captured": "0328290799",
      "length": 10,
      "m_content": "0328290799",
      "m_id": "m_WmdnGmAIuYBVRREPw82Sr6eDRTqVhl7NbvRZnivNqM5_PmAyAZ-qAQjuyF_CKt76PA6MNbDbp663uf3LQfSAcg",
      "offset": 0,
      "phone_number": "0328290799",
      "status": 2
    },
    {
      "captured": "0328290781",
      "length": 10,
      "m_content": "0328290781",
      "m_id": "m_GnlF3xzsH_I9UKSttrEeRqeDRTqVhl7NbvRZnivNqM4Qh9eoZuPTPCPRSutyxWHyF85M5gEeHW2c0yfpl5FsHA",
      "offset": 0,
      "phone_number": "0328290781",
      "status": 1
    }
  ],
  "recent_seen_users": [
    {
      "fb_id": "570423649807405",
      "fb_name": "Quyết Nguyễn",
      "seen_at": "2023-04-05T02:22:06.689494"
    }
  ],
  "seen": true,
  "snippet": "[Photo]",
  "success": true,
  "tags": [
    -99,
    1,
    26,
    28,
    29,
    30,
    31,
    32,
    35,
    36,
    39,
    40,
    41,
    42,
    43,
    44,
    45
  ],
  "thread_id": "159952432315225",
  "thread_key": "t_1495217373994690",
  "type": "INBOX",
  "unread_count": 0,
  "updated_at": "2023-04-06T04:31:45"
}

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

Response

{"success": true}

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

{
  "messages": [
    {
      "attachments": [], // Media của tin nhắn
      "conversation_id": "256469571178082_3100878013328342", // ID hội thoại
      "from": { // Thông tin khách hàng
        "email": "3100878013328342@facebook.com",
        "id": "3100878013328342",
        "name": "Quyết Nguyễn"
      },
      "has_phone": false, // Có chứa số điện thoại không
      "id": "m_Ec_f7RJrKyJlRKXVdEYW5gWswhac17zNH0kIRGkMGhuBkqMkamKpUyJSpemXfRB0kULuVY8WA-ATEthHwher9g", // ID tin nhắn
      "inserted_at": "2023-12-26T08:44:29.000000", // Thời gian tạo tin nhắn
      "is_hidden": false, // Đã ẩn hay chưa chỉ dùng cho comment
      "is_livestream_order": null, 
      "is_parent": false, // Có phải comment cha không chỉ dùng cho comment
      "is_parent_hidden": false, // Comment cha đã bị ẩn chưa chỉ dùng cho comment
      "is_removed": false, // Đã bị xoá chưa
      "like_count": null, // Số lượt like chỉ dùng cho comment
      "message": "asda", // Nội dung tin nhắn
      "page_id": "256469571178082", // ID của trang
      "phone_info": [], // Thông tin số điện thoại có trong tin nhắn
      "type": "INBOX", // Loại tin nhắn [INBOX, COMMEMNT, RATING]
    }
  ],
  "success": true
}

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

[
    {
        "account_id": "11112430409201147",
        "ad_id": "2384887411112310288",
        "adset_id": "2312324572270288",
        "budget_remaining": "3000",
        "cpc": null,
        "cpm": null,
        "ctr": null,
        "currency": "USD",
        "daily_budget": "3000",
        "impressions": null,
        "lifetime_budget": "0",
        "link_click": null,
        "messaging_conversation_started_7d": null,
        "messaging_first_reply": null,
        "name": "QC FB thúc đẩy doanh thu",
        "post_comments": null,
        "purchase_roas": null,
        "purchases": null,
        "purchases_conversion_value": null,
        "reach": null,
        "spend": null,
        "status": "PAUSED"
    }
]

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

[
    {
        "account_id": "11112430409201147",
        "ad_id": "2384887411112310288",
        "adset_id": "2312324572270288",
        "budget_remaining": "3000",
        "cpc": null,
        "cpm": null,
        "ctr": null,
        "currency": "USD",
        "daily_budget": "3000",
        "impressions": null,
        "lifetime_budget": "0",
        "link_click": null,
        "messaging_conversation_started_7d": null,
        "messaging_first_reply": null,
        "name": "QC FB thúc đẩy doanh thu",
        "post_comments": null,
        "purchase_roas": null,
        "purchases": null,
        "purchases_conversion_value": null,
        "reach": null,
        "spend": null,
        "status": "PAUSED"
    }
]

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

{
    "data": {
        "categories": ["26/8", "25/8", "24/8", "23/8", "22/8", "21/8", "20/8", "19/8", "18/8", "17/8", "16/8", "15/8", "14/8", "13/8", "12/8", "11/8", "10/8", "9/8", "8/8", "7/8", "6/8", "5/8", "4/8", "3/8", "2/8", "1/8", "31/7", "30/7", "29/7", "28/7", "27/7"],
        "series": [{
            "data": [0, 0, 2, 1, 0, 0, 1, 2, 2, 0, 3, 0, 3, 2, 0, 0, 6, 2, 0, 0, 0, 2, 1, 0, 0, 0, 0, 6, 1, 3, 1],
            "name": "inbox"
        }, {
            "data": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
            "name": "comment"
        }, {
            "data": [0, 0, 2, 1, 0, 0, 1, 2, 2, 0, 3, 0, 3, 2, 0, 0, 6, 2, 0, 0, 0, 2, 1, 0, 0, 0, 0, 6, 1, 3, 1],
            "name": "total"
        }, {
            "data": [0, 0, 1, 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 0, 1, 1],
            "name": "new_customer_replied"
        }, {
            "data": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
            "name": "customer_engagement_new_inbox"
        }]
    },
    "success": true
}

Chú thích:

    categories: danh sách ngày thống
    series: Dữ liệu thống kê
    series.data: Dữ liệu thống kê theo ngày tương ứng với danh sách categories
    series.name: Kiểu thống kê
        "inbox": Tương tác tin nhắn
        "comment": Tương tác comment
        "total": Tổng tương tác tin nhắn và 
        "new_customer_replied": Tương tác khách hàng 
        "customer_engagement_new_inbox": Hội thoại khách hàng 
        
        

by_hour:        
        
{
    "statistics": [{
        "comment": 0,
        "hour": "2021-08-26T13:00:00",
        "inbox": 1,
        "new_customer": 0,
        "new_customer_from_inbox": 0,
        "total": 1
    }, {
        "comment": 0,
        "hour": "2021-08-26T10:00:00",
        "inbox": 1,
        "new_customer": 0,
        "new_customer_from_inbox": 0,
        "total": 1
    }],
    "success": true
}

Page statistics

GET https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/pages

Query Parameters

{
    // Response
}

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

{
    // Response
}

Users statatistics

GET https://pages.fm/api/public_api/v1/pages/[:page_id]/statistics/users

Thống kê nhân viên

Query Parameters

{
    "data": {
        "statistics": {
            "c5a50cce-fb0a-4eb3-892a-74ad182f7c03": [{
                "average_response_time": 3376234,
                "comment_count": 0,
                "hour": "2021-07-27T09:00:00",
                "inbox_count": 2,
                "phone_number_count": 0,
                "private_reply_count": 0,
                "unique_comment_count": 0,
                "unique_inbox_count": 1
            }, {
                "average_response_time": 74276,
                "comment_count": 0,
                "hour": "2021-07-28T10:00:00",
                "inbox_count": 6,
                "phone_number_count": 0,
                "private_reply_count": 0,
                "unique_comment_count": 0,
                "unique_inbox_count": 2
            }]
        },
        "users": {
            "c5a50cce-fb0a-4eb3-892a-74ad182f7c03": {
                "average_response_time": 588569,
                "comment_count": 0,
                "hour": "2021-08-26T13:00:00",
                "inbox_count": 637,
                "phone_number_count": 0,
                "private_reply_count": 0,
                "unique_comment_count": 0,
                "unique_inbox_count": 30,
                "user_fb_id": "570423649807405",
                "user_name": "Quyết Nguyễn"
            }
        }
    },
    "success": true
}

Chú thích:
    "statistics": Thống kê theo thời gian
    "users": Thống kê theo nhân viên
    "average_response_time": Thời gian phản hổi trung
    "comment_count": Tổng số bình luận thực 
    "inbox_count": Tổng số tin nhắn thực 
    "phone_number_count": Tổng số điện thoại
    "private_reply_count": "Hành động gửi tin nhắn từ bình luận",
    "unique_comment_count": Phản hồi cho mỗi bình luận của khách hàng (Thường bằng số bình luận của khách hàng)
    "unique_inbox_count": Phản hồi cho mỗi tin nhắn của khách hàng (Thường bằng số lượng tin nhắn của khách hàng)
    "hour": Thời gian thống kê
    "user_name": Tên nhân viên
    "user_fb_id": facebook id của nhân

Users statatistics multiple pages

GET https://pages.fm/api/v1/statistics/user

Thống kê nhân viên chế độ gộp

Query Parameters

{
  "statistics": { #Thống kê theo thời gian
    "2138b20a-6745-4fe2-91b2-f75e6c43b7b0": [
      {
        "average_response_time": 10, #Thời gian phản hổi trung bình
        "comment_count": 0, #Số comment đã trả lời
        "hour": "2022-07-05T01:00:00",  #Thời gian
        "inbox_count": 1, #Số tin nhắn đã trả lời
        "order_count": 0, #Số đơn hàng đã chốt
        "phone_number_count": 0, #Số điện thoại mang về
        "private_reply_count": 0, #Số tin nhắn từ bình luận
        "unique_comment_count": 0, #Số phiên trả lời bình luận
        "unique_inbox_count": 1 #Số phiên trả lời tin nhắn 
      }
    ],
    "3fadfd70-1ead-4a16-a456-1fa007e38e5c": [
      {
        "average_response_time": 0,
        "comment_count": 0,
        "hour": "2022-07-05T12:00:00",
        "inbox_count": 0,
        "order_count": 0,
        "phone_number_count": 1,
        "private_reply_count": 0,
        "unique_comment_count": 0,
        "unique_inbox_count": 0
      }
    ],
    "6350389d-7bd6-4e3f-8a0b-a370d76f63fd": [
      {
        "average_response_time": 34389,
        "comment_count": 0,
        "hour": "2022-07-05T12:00:00",
        "inbox_count": 10,
        "order_count": 0,
        "phone_number_count": 0,
        "private_reply_count": 0,
        "unique_comment_count": 0,
        "unique_inbox_count": 1
      },
      {
        "average_response_time": 0,
        "comment_count": 0,
        "hour": "2022-07-07T09:00:00",
        "inbox_count": 0,
        "order_count": 0,
        "phone_number_count": 1,
        "private_reply_count": 0,
        "unique_comment_count": 0,
        "unique_inbox_count": 0
      }
    ]
  },
  "users": {  #Thống kê theo nhân viên
    "2138b20a-6745-4fe2-91b2-f75e6c43b7b0": {
      "average_response_time": 10,
      "comment_count": 0,
      "hour": "2022-07-05T01:00:00",
      "inbox_count": 1,
      "order_count": 0,
      "phone_number_count": 0,
      "private_reply_count": 0,
      "unique_comment_count": 0,
      "unique_inbox_count": 1,
      "user_fb_id": "1079158022137261",
      "user_name": "Khoa 12 12 tv1234567.1"
    },
    "3fadfd70-1ead-4a16-a456-1fa007e38e5c": {
      "average_response_time": 0,
      "comment_count": 0,
      "hour": "2022-07-05T12:00:00",
      "inbox_count": 0,
      "order_count": 0,
      "phone_number_count": 1,
      "private_reply_count": 0,
      "unique_comment_count": 0,
      "unique_inbox_count": 0,
      "user_fb_id": "2378637269074943",
      "user_name": "Duc Nguyen"
    },
    "6350389d-7bd6-4e3f-8a0b-a370d76f63fd": {
      "average_response_time": 34389,
      "comment_count": 0,
      "hour": "2022-07-07T09:00:00",
      "inbox_count": 10,
      "order_count": 0,
      "phone_number_count": 1,
      "private_reply_count": 0,
      "unique_comment_count": 0,
      "unique_inbox_count": 1,
      "user_fb_id": "1751542581753690",
      "user_name": "Bùi Văn Long"
    }
  }
}

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

no group_by
{
    "data":[
        {"date":"2020-08-27","new_customer_count":0,"new_page_inbox_count":1,"new_phone_number_count":0,"phone_number_count":0},
        {"date":"2020-08-24","new_customer_count":0,"new_page_inbox_count":2,"new_phone_number_count":0,"phone_number_count":0},
        {"date":"2020-08-12","new_customer_count":4,"new_page_inbox_count":3,"new_phone_number_count":0,"phone_number_count":0}
    ],
    "success":true
}

group_by: page_id
{
    "data": {
        "103205717747769": [
            {"date":"2020-08-12","new_customer_count":0,"new_page_inbox_count":1,"new_phone_number_count":0,"phone_number_count":0}
        ],
        "110699180573884":[
            {"date":"2020-08-27","new_customer_count":0,"new_page_inbox_count":2,"new_phone_number_count":0,"phone_number_count":0}
        ]
    },
    "success":true
}

group_by: hour
{
    "data":[
        {"date":"2020-08-12T16:00:00","new_customer_count":0,"new_page_inbox_count":1,"new_phone_number_count":0,"phone_number_count":0},
        {"date":"2020-08-12T17:00:00","new_customer_count":0,"new_page_inbox_count":2,"new_phone_number_count":0,"phone_number_count":0},
        {"date":"2020-08-12T18:00:00","new_customer_count":4,"new_page_inbox_count":3,"new_phone_number_count":0,"phone_number_count":0}
    ],
    "success":true
}

Page customers

GET https://pages.fm/api/public_api/v1/pages/[:page_id]/page_customers

Thông tin khách hàng

Query Parameters

{
    "total": 500,
    "customers": [{
        "birthday": null,
        "gender": null,
        "inserted_at": "2021-06-07T11:11:16",
        "name": "Tạ Tuấn Vũ",
        "phone_numbers": [],
        "psid": "3296946846995244",
        "notes": [{
          "created_at": 1665981253137,