Hàm lấy thông tin callback tin nhắn Zalo

Hàm này chỉ dùng đối với những tin nhắn khi request gửi tin khách hàng có truyền trường CallbackUrl để nhận thông tin trạng thái tin nhắn qua callback.

Những SMSID khi request không truyền CallbackUrl, dùng hàm này sẽ không có thông tin.

HTTP request

POST https://status-sms.esms.vn/ZaloCallback/GetCallback

  • Content Type: application/json

  • Response Type: application/json

curl --location 'https://status-sms.esms.vn/ZaloCallback/GetCallback' \
--header 'Content-Type: application/json' \
--data '{
    "ApiKey":"{{ApiKey}}",
    "SecretKey":"{{SecretKey}}",
    "ListRefid": [
        "{{Refid}}",
        "{{Refid}}",
        "{{Refid}}"
    ],
    "OAId": "{{OAId}}"
}'
  • Cấu trúc body của request:

Tham sốKiểu dữ liệuTính bắt buộcMô tả

ApiKey

string

ApiKey của tài khoản.

SecretKey

string

SecretKey của tài khoản.

ListRefid

string

Danh sách ReferenceId đã gửi tin. Giới hạn 200 RefId, truyền nhiều hơn sẽ chỉ lấy callback của 200 RefId theo thứ tự từ trên xuống.

OAId

string

Id của OA đã gửi tin


  • Response:

{
    "Code": 100,
    "Message": "Success",
    "Data_callback": [
        {
            "SMSID": "4a496110-9fd3-4838-ac8b-bcaa36616f7011",
            "SendFailed": 1,
            "SendSuccess": 0,
            "SendStatus": 5,
            "TotalPrice": 0.0,
            "TotalReceiver": 1,
            "TotalSent": 1,
            "RequestId": null,
            "TypeId": 25,
            "Telcoid": 1,
            "PhoneNumber": "0909090909",
            "CallbackUrl": "https://api.esms.vn/zalo-zns/zns/receive-callback",
            "Partnerids": "7984e9b198c40e9957d6",
            "ErrorInfo": "{\"error\":-124,\"message\":\"Access token is invalid\"}Object reference not set to an instance of an object.",
            "OAId": "1090257973118325189",
            "ZnsTempId": "228386"
        } 
                    ]
  } 

Request hợp lệ.

  • Cấu trúc body của response:

Thuộc tínhKiểu dữ liệuMô tả

SMSID

string

ReferenceId của tin nhắn muốn xem callback.

SendFailed

string

Tổng số tin thất bại.

SendSuccess

string

Tổng số tin thành công.

SendStatus

string

Trạng thái tin nhắn.

  • Trạng thái 2: Chờ gửi .

  • Trạng thái 5: Đã gửi .

TotalPrice

string

Tổng số tiền của tin.

TotalReceiver

string

Tổng số tin.

TotalSent

string

Tổng số tin đã gửi.

RequestId

string

Request mà KH truyền vào API để gửi tin.

TypeId

string

Loại tin nhắn.

  • Type 24: Zalo Ưu Tiên.

  • Type 25: Zalo Bình Thường.

Telcoid

string

Mạng viễn thông của thuê bao nhận tin.

  • Mạng số 1: Viettel

  • Mạng số 2: Mobifone

  • Mạng số 3: Vinaphone

  • Mạng số 4: Vietnammobile

  • Mạng số 5: Gmobile

  • Mạng số 6: Itel

  • Mạng số 7: Reddi

PhoneNumber

string

Số điện thoại nhận tin.

CallbackUrl

string

Link nhận callback .

Partnerids

string

Mã của tin nhắn vừa được gửi (do Zalo trả về).

ErrorInfo

string

Mã lỗi và thông tin lỗi của tin nhắn.

OAId

string

Id của OA mà KH gửi tin.

ZnsTempId

string

Id của template KH gửi tin.

Chú ý:

  • Số ReferenceId tối đa cho 1 lần request là 200, nhiều hơn 200 sẽ chỉ trả 200 ReferenceId đầu tiên.

  • Giới hạn request 20TPS.

  • Thông tin chi tiết mã lỗi xem ở bảng: Mã lỗi .

  • Lấy code mẫu các ngôn ngữ trên Postman: Link code mẫu.

Last updated