Lấy thông tin chi tiết tin nhắn

Lưu ý:

  • Đối với các API sử dụng cho Shop thì API_KEY: <api_key>. Thông tin base_url của Shop

  • Đối với các API sử dụng cho Partner thì API_KEY: <shop_key>. Thông tin base_url của Partner

GetMessage

post
Body
msg_idstringOptional
oa_idstring · int64Optional
Responses
200

A successful response

application/json
post
/api/shop.Zalo/GetMessage
POST /api/shop.Zalo/GetMessage HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "msg_id": "text",
  "oa_id": "text"
}
200

A successful response

{
  "campaign_id": "text",
  "created_at": "2025-11-02T02:05:55.205Z",
  "delivery_status": "unknown",
  "delivery_time": "2025-11-02T02:05:55.205Z",
  "error_code": 1,
  "error_message": "text",
  "fee_main": 1,
  "fee_token": 1,
  "feedback": [
    "text"
  ],
  "id": "text",
  "is_charged": true,
  "is_development": true,
  "journey_id": "text",
  "msg_id": "text",
  "note": "text",
  "oa_id": "text",
  "phone": "text",
  "rate": 1,
  "request_time": "2025-11-02T02:05:55.205Z",
  "response_data": "text",
  "sending_mode": "unknown",
  "sent_time": "2025-11-02T02:05:55.205Z",
  "shop_id": "text",
  "status": "Z",
  "submit_time": "2025-11-02T02:05:55.205Z",
  "template_data": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "template_id": 1,
  "timeout": 1,
  "tracking_id": "text",
  "type": "unknown",
  "updated_at": "2025-11-02T02:05:55.205Z",
  "user_id": "text",
  "zl_user_id": "text"
}

Request:

curl --location '$BASE_URL.Zalo/GetMessage' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "oa_id": "<int64>",
  "msg_id": "<string>"
}'

Response

{
  "campaign_id": "text",
  "created_at": "2025-10-10T03:37:53.764Z",
  "delivery_status": "unknown",
  "delivery_time": "2025-10-10T03:37:53.764Z",
  "error_code": 1,
  "error_message": "text",
  "fee_main": 1,
  "fee_token": 1,
  "feedback": [
    "text"
  ],
  "id": "text",
  "is_charged": true,
  "is_development": true,
  "journey_id": "text",
  "msg_id": "text",
  "note": "text",
  "oa_id": "text",
  "phone": "text",
  "rate": 1,
  "request_time": "2025-10-10T03:37:53.764Z",
  "response_data": "text",
  "sending_mode": "unknown",
  "sent_time": "2025-10-10T03:37:53.764Z",
  "shop_id": "text",
  "status": "Z",
  "submit_time": "2025-10-10T03:37:53.764Z",
  "template_data": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "template_id": 1,
  "timeout": 1,
  "tracking_id": "text",
  "type": "unknown",
  "updated_at": "2025-10-10T03:37:53.764Z",
  "user_id": "text",
  "zl_user_id": "text"
}

Cấu trúc body của request

Tham số
Kiểu dữ liệu
Mô tả

oa_id*

int64

ID của OA

msg_id*

string

ID tin nhắn

Cấu trúc thuộc tính dữ liệu trả về

Tham số
Kiểu dữ liệu
Mô tả

id

int64

ID tin nhắn trên hệ thống của eTelecom

shop_id

int64

ID cửa hàng trên hệ thống của eTelecom

user_id

int64

ID người gửi tin trên hệ thống của eTelecom

campaign_id

int64

ID của chiến dịch

delivery_status

string

Unkown: Không xác định

Received: Đã nhận

delivery_time

string<date-time>

Thời gian thiết bị của người dùng nhận được thông báo ZNS

error_code

int

Mã lỗi

error_message

string

Thông báo lỗi

fee_main

int

Phí chính

fee_token

int

Phí khởi tạo token

is_charged

boolean

True: Tin ZNS được tính phí

False: Tin ZNS không được tính phí

journey_id

string

ID của journey

msg_id

string

ID của thông báo ZNS

type

string

template: ZNS thường

journey: ZNS journey

status

string

Trạng thái Z: Mới tạo P: Enable N: Disable

rate

integer

Số sao được khách hàng đánh giá

note

string

Phần ghi chú thêm của khách hàng

feedback

array

Phần nhận xét từ khách hàng

submit_time

string<date-time>

Thời điểm khách hàng gửi đánh giá

template_data

object

Tham số tin nhắn

phone

string

Số điện thoại người nhận

sent_time

string<date-time>

Thời gian gửi thông báo ZNS

template_id

integer

ID của mẫu tin

timeout

integer

Thời gian tối đa mà hệ thống xử lý yêu cầu

tracking_id

string

Mã số đánh dấu lần gọi API của bạn, do bạn định nghĩa. Bạn có thể dùng tracking_id để đối soát mà không phụ thuộc vào message_id của eTelecom cung cấp.

updated_at

string<date-time>

Ngày cập nhật

created_at

string<date-time>

Ngày tạo

response_data

string

Là nội dung phản hồi của khách hàng đối với tin response button

Last updated