Skip to main content
GET
Lấy tin nhắn hoặc cuộc trò chuyện cho một nền tảng messaging. Thời gian truy xuất khác nhau trên từng mạng xã hội. Trên Facebook, Instagram và WhatsApp, tin nhắn có sẵn qua Ayrshare theo thời gian thực. Trên X/Twitter, có độ trễ lên đến 3 phút để thấy các cập nhật tin nhắn mới. Vui lòng liên hệ hỗ trợ để tìm hiểu thêm về gói Enterprise Plan nếu bạn cần truy cập tin nhắn X/Twitter theo thời gian thực.
Bộ nhớ đệm phản hồi: Đối với Facebook và Instagram, các phản hồi được lưu vào bộ nhớ đệm trong 60 giây. Đối với X/Twitter, các phản hồi được lưu vào bộ nhớ đệm trong 15 giây để hỗ trợ polling tốt hơn. WhatsApp đọc các tin nhắn đã nhận được thông qua webhooks của Meta, vì vậy một tin nhắn mới nhận có thể xuất hiện ngay khi Ayrshare xử lý webhook của nó. Phản hồi vẫn bao gồm metadata lastUpdated và nextUpdate.
Truy xuất lịch sử tin nhắn ban đầu cho Facebook và Instagram được giới hạn ở 20 tin nhắn cuối cùng. Vui lòng xem phần Truy xuất Lịch sử Tin nhắn cho Facebook và Instagram để biết thêm thông tin.
Các cuộc trò chuyện WhatsApp được xác định bằng số điện thoại của người liên lạc (chỉ chữ số, dạng E.164 không có dấu + đứng đầu). Một tin nhắn đi (outbound) đã lưu có thể bao gồm giá trị status là sent, delivered, read, hoặc failed.
Các tin nhắn WhatsApp được gửi thông qua Send Message hiện chưa được thêm vào lịch sử Get Messages. Các tin nhắn WhatsApp đến nhận được thông qua webhooks sẽ được lưu trữ và trả về ở đây.

Tham số Header

Tham số Path

string
bắt buộc
Nền tảng để lấy tin nhắn: facebook, instagram, twitter, whatsapp

Tham số Query

string
mặc định:"active"
bắt buộc
Trả về các cuộc trò chuyện đang hoạt động hoặc cuộc trò chuyện đã lưu trữ. Giá trị: active hoặc archived.
string
Chỉ trả về cuộc trò chuyện cụ thể.
string
Chỉ trả về tin nhắn theo một chiều. Giá trị: sent hoặc received. Bỏ trống để trả về cả hai.
boolean
mặc định:false
Trả về cuộc trò chuyện thay vì tin nhắn. Trả về một trang cuộc trò chuyện — hãy theo meta.pagination.next để lấy phần còn lại. Nếu là true, conversationId sẽ bị bỏ qua.
Khi conversationsOnly=true, chi tiết cuộc trò chuyện được trả về trong converstationsDetails. Cách viết này là một phần của phản hồi API hiện tại.
integer
Kích thước trang cho tin nhắn và cho danh sách cuộc trò chuyện: số nguyên từ 1 đến 100, mặc định và tối đa là 100.Trên X/Twitter, limit còn quyết định bạn đọc tập tin nhắn nào. Bỏ qua nó để phân trang các tin nhắn đã lưu — đây là cách mọi nền tảng khác hoạt động và cũng là trường hợp duy nhất áp dụng status, action và conversationsOnly. Cung cấp nó để thay vào đó phân trang dòng thời gian trực tiếp của X bằng con trỏ của chính X, vốn không áp dụng bất kỳ bộ lọc nào trong ba bộ lọc đó.Lựa chọn này chỉ do yêu cầu đầu tiên quyết định. Khi bạn đã theo một con trỏ thì chính con trỏ quyết định: con trỏ tin nhắn đã lưu vẫn tiếp tục trả về tin nhắn đã lưu dù bạn có gửi limit, và con trỏ của X vẫn tiếp tục trả về dòng thời gian trực tiếp dù bạn bỏ qua nó. Bạn không thể chuyển giữa hai loại khi đang phân trang.
string
Con trỏ không trong suốt từ meta.pagination.next. Gửi dưới dạng next với cùng hồ sơ, nền tảng và bộ lọc. Tiếp tục khi meta.pagination.hasMore là true, ngay cả khi một trang đã lọc trả về ngắn hoặc rỗng. Có thể bỏ limit ở các yêu cầu sau (mặc định 100); trên X/Twitter, bản thân con trỏ đã ghi lại nó đến từ tập nào, nên việc gửi hay bỏ limit sẽ không chuyển bạn sang tập còn lại.

Lấy trang tiếp theo

Bắt đầu với GET /api/messages/instagram?limit=100. Để tiếp tục, hãy URL-encode giá trị meta.pagination.next được trả về và gửi GET /api/messages/instagram?limit=100&next=<opaque cursor>. Tham số là next, không phải cursor. Giữ nguyên cùng Profile-Key và các bộ lọc query trong suốt quá trình. Hãy kiểm tra meta.pagination.hasMore, không phải số lượng kết quả, để quyết định khi nào dừng. Một yêu cầu có bộ lọc có thể trả về ít hơn limit kết quả, hoặc một trang trống kèm phần tiếp tục, vì mỗi yêu cầu chỉ quét một phần giới hạn của lịch sử. Các tin nhắn trong lịch sử đã lưu được sắp xếp mới nhất trước, với ID tài liệu (document ID) dùng để phân định khi trùng nhau. Danh sách cuộc trò chuyện được sắp xếp theo ID tài liệu. Phân trang không phải là một ảnh chụp cố định: tin nhắn mới sẽ xuất hiện khi bạn bắt đầu lại từ trang đầu tiên, và việc thay đổi trạng thái cuộc trò chuyện có thể làm thay đổi kết quả đã lọc. Các trường tin nhắn hiện có và cách viết converstationsDetails không thay đổi. Các tích hợp trước đây kỳ vọng một danh sách đầy đủ từ một yêu cầu duy nhất — dù là tin nhắn hay cuộc trò chuyện, trên bất kỳ nền tảng nào — giờ phải theo con trỏ tiếp tục; không hỗ trợ tăng limit vượt quá 100.