Bán hàng

Hẹn gọi & nhắc nhở

2 endpoint · https://pos.pages.fm/api/v1

Xem Markdown

Danh sách hẹn gọi & nhắc nhở

GET/shops/{SHOP_ID}/order_call_laters

Lấy danh sách hẹn gọi & nhắc nhở

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Tham số truy vấn

page_numberinteger

Số trang

Mặc định: 1
page_sizeinteger

Kích thước trang

Mặc định: 30
keystring

Lọc nhanh: today (hẹn gọi hôm nay), upcoming (hẹn gọi sau hôm nay), overdue (quá thời điểm hẹn gọi), completed (đã xử lý thành công). Không truyền tham số này nếu chỉ muốn lọc theo khoảng thời gian. Nếu truyền, điều kiện này được kết hợp đồng thời (AND) với bộ lọc thời gian.

Giá trị"today""upcoming""overdue""completed"
filter_by_timestring

Bộ lọc thời gian dạng chuỗi JSON. Truyền trong một query parameter (URL-encode chuỗi JSON), không truyền dưới dạng các query parameter lồng nhau.

  • type: inserted_at (Thời điểm tạo, mặc định), called_at (Đã xử lý lúc; loại các hẹn gọi chưa xử lý), hoặc appointment_time (Thời điểm hẹn gọi, trường needs_call_at).
  • start_time, end_time: số nguyên Unix timestamp tính bằng giây (UTC), phải truyền cả hai để áp dụng bộ lọc. Khoảng lọc bao gồm cả hai mốc. Cần chuyển khoảng ngày theo múi giờ mong muốn sang Unix timestamp trước khi gửi.
  • editor_ids: mảng ID nhân viên, bắt buộc khi lọc thời gian. Truyền ["-1"] để chọn tất cả nhân viên. Lọc theo người chỉnh sửa cuối với called_at, các loại còn lại lọc theo người tạo. Các ví dụ bên dưới lọc ngày 15/10/2026, từ 00:00:00 đến 23:59:59 theo múi giờ UTC+7.
start_needs_callinteger · int64

Mốc bắt đầu của khoảng thời điểm hẹn gọi (needs_call_at), tính cả mốc này, dạng Unix timestamp theo giây. Phải truyền cùng end_needs_call. Kết hợp đồng thời (AND) với các bộ lọc khác.

end_needs_callinteger · int64

Mốc kết thúc của khoảng thời điểm hẹn gọi (needs_call_at), tính cả mốc này, dạng Unix timestamp theo giây. Phải truyền cùng start_needs_call.

statusinteger

Trạng thái

Giá trị-1Tất cả trạng thái0Chưa xử lý3Đang gọi / Đang xử lý1Đã xử lý2Không nghe máy / Không thành công7Đã xóa
Mặc định: -1 · Ví dụ: -1

Phản hồi

object
dataarray<CallLater>

Danh sách hẹn gọi & nhắc nhở

keystring

Khóa

page_numberinteger

Số trang

page_sizeinteger

Kích thước trang

successboolean

Trạng thái thành công

total_entriesinteger

Tổng số bản ghi

total_pagesinteger

Tổng số trang

Yêu cầu
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/order_call_laters?api_key=API_KEY"
Phản hồi 200
{
  "success": true,
  "data": [
    {
      "called_at": "2024-01-30T01:54:17",
      "creator": {
        "avatar_url": null,
        "email": "vuson897654@gmail.com",
        "fb_id": "377936050731194",
        "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "name": "Vũ Sơn",
        "phone_number": null
      },
      "display_id": 70,
      "id": "1885d8d4-e210-4e56-bb32-683988a032f5",
      "need_notify_users": [
        "cee3c05e-5f85-43c4-b27e-889b99c50097"
      ],
      "needs_call_at": "2024-01-30T02:20:48",
      "notice_created": "Gọi lại cho khách",
      "order_display_id": "SOICUN-12943-02",
      "order_id": 106703,
      "status": 1,
      "type": "call"
    }
  ],
  "key": "today",
  "page_number": 1,
  "page_size": 30,
  "total_entries": 3,
  "total_pages": 1
}

Tạo hẹn gọi & nhắc nhở

POST/shops/{SHOP_ID}/order_call_laters

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Nội dung yêu cầu

Thông tin yêu cầu chứa thông tin hẹn gọi & nhắc nhở

object
order_call_laterobjectbắt buộc

Phản hồi

object
successboolean

Trạng thái thành công

Yêu cầu
curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/order_call_laters?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "order_call_later": {
    "status": 0,
    "need_notify_users": [
      "cee3c05e-5f85-43c4-b27e-889b99c50097"
    ],
    "notice_created": "Gọi lại xác nhận",
    "needs_call_at": "2024-08-29T05:50:31.700Z",
    "phone_number": "0929911922",
    "order_ids": [
      "106703"
    ]
  }
}'
Phản hồi 200
{
  "success": true
}