Chuyển tới nội dung chính

Lấy thông tin Tin nhắn gần nhất

Lưu ý
  • Quyền cần có: Quyền quản lý tin nhắn người dùng
  • API hỗ trợ lấy thông tin tối đa 10 tin nhắn gần nhất giữa OA và người dùng.

HTTP request

Example request

curl \
-X GET \
-H 'access_token: <your_access_token>' \
'https://openapi.zalo.me/v2.0/oa/listrecentchat?data={"offset":0,"count":5}'

Tham số header

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

access_token

string

yes

Token cho phép ứng dụng đại diện OA gọi API. Xem chi tiết cách lấy access token tại đây.

Tham số

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

data

Json object

yes

Thông tin truyền vào để lấy tin nhắn.

Cấu trúc tham số data

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

offset

int

yes

Thứ tự của tin nhắn đầu tiên trong danh sách trả về.

Lưu ý: Tin nhắn gần nhất có thứ tự là 0.

count

int

yes

Số lượng tin nhắn muốn lấy.

Lưu ý: mỗi request được lấy tối đa 10 tin nhắn.

Example respond

{
"data": [
{
"src": 1,
"time": 1619401853770,
"type": "text",
"message": "Chào shop",
"message_id": "92e5d851aa8178dd2192",
"from_id": "3700646744485476903",
"to_id": "3120036654733951760",
"from_display_name": "Khoa Pham",
"from_avatar": "https://s240-ava-talk.zadn.vn/3/f/4/7/16/240/10aaabe185bc828af44c50ca29ec5d79.jpg",
"to_display_name": "OA",
"to_avatar": "https://s240-ava-talk.zadn.vn/7/c/b/1/1/240/3318c818b07fb3e228eaf8b448c53d3e.jpg"
}
],
"error": 0,
"message": "Success"
}

Cấu trúc thuộc tính data

Thuộc tính

Kiểu dữ liệu

Mô tả

message_id

string

ID của tin nhắn

src

int

Thuộc tính cho biết tin nhắn được gửi từ OA hoặc người dùng. Các giá trị trả về:

· 0: tin nhắn được gửi từ OA đến người dùng

· 1: tin nhắn được gửi người dùng đến OA

time

long

Thời gian tin nhắn được gửi (định dạng timestamp)

type

string

Loại tin nhắn

Các giá trị trả về:

·        text: tin nhắn văn bản

·        voice: tin nhắn thoại

·        photo: tin nhắn ảnh

·        GIF: tin nhắn GIF

·        link: tin nhắn có nội dung là đường link

·        linkstin nhắn theo mẫu đính kèm danh sách

·        sticker: tin nhắn sticker

·        location: tin nhắn chia sẻ location

message

string

Nội dung tin nhắn

links

string array

Thuộc tính trả về 1 danh sách các đường dẫn được đính kèm trong tin nhắn

Lưu ý: thuộc tính chỉ được trả về khi loại tin nhắn là link hoặc links.

thumb

string

URL của ảnh hoặc GIF.

Lưu ý: thuộc tính chỉ được trả về khi loại tin nhắn là GIF hoặc photo

url

string

Đường dẫn đến audio (trong trường hợp loại tin nhắn là voice), hoặc đường dẫn đến ảnh/GIF/nhãn dán (trong trường hợp loại tin nhắn là photo, GIF, nhãn dán)

description

string

Mô tả của ảnh.

Lưu ý: thuộc tính chỉ được trả về khi loại tin nhắn là photo.

from_id

long

ID của đối tượng gửi tin nhắn (có thể là user_id hoặc oa_id)

to_id

long

ID của đối tượng nhận tin nhắn (có thể là user_id hoặc oa_id)

from_display_name

string

Tên hiển thị của đối tượng gửi tin nhắn

from_avatar

string

Đường dẫn đến ảnh đại diện của đối tượng gửi tin nhắn

to_display_name

string

Tên hiển thị của đối tượng nhận tin nhắn

to_avatar

string

Đường dẫn đến ảnh đại diện của đối tượng nhận tin nhắn

location

string

Thuộc tính trả về giá trị longitudelatitude của người dùng.

Lưu ý: thuộc tính chỉ được trả về khi loại tin nhắn là location.