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

Cấu trúc của tham số elements

  • type: JsonArray
Lưu ý

Hiện tại Zalo API hỗ trợ tối đa 5 element .

Cấu trúc của một element​

Tham số

Kiểu dữ liệu

Mô tả

title

String

Tiêu đề của action

Tối đa: 100 ký tự

subtitle

String

mô tả của action. Nếu đây là element đầu tiên trong danh sách elements thì tham số này là bắt buộc. Nếu đây không phải là action đầu tiên thì thược tính này là tùy chọn.

Tối đa: 500 ký tự

image_url

String

URL ảnh của action

default_action

String

Ví dụ:

{
  "type": "oa.open.url",
  "url": "https://developers.zalo.me/"
}


Nếu đây là element đầu tiên thì tham số này là không bắt buộc.

Xem chi tiết tham số default_action tại bảng dưới.

Cấu trúc của tham số default_action​

Tham số

Kiểu dữ liệu

Mô tả

type

String

Loại action sẽ thực hiện khi người dùng bấm vào

payload

Dữ liệu của action. Cấu trúc của payload phải phù hợp với từng loại action và được cho ở bảng bên dưới

Cấu trúc payload cho các loại action được hỗ trợ​

Giá trị type

Kiểu dữ liệu

Giá trị payload và kết quả khi người dùng bấm vào

oa.open.url

String

Url sẽ được mở trong ứng dụng Zalo khi người dùng bấm vào action. Ví dụ:

{
  "type": "oa.open.url",
  "url": "https://developers.zalo.me/"
}

oa.query.show

String

Payload là một chuỗi ký tự ví dụ “#123”. Khi người dùng bấm vào action, hệ thống sẽ gửi một tin nhắn có nội dung chứa trong data từ người dùng đến Official Account. Tin nhắn này sẽ hiện trên cửa sổ chat trên máy của người dùng. Ví dụ:

{
  "type": "oa.query.show",
  "payload": "#123"
}

oa.query.hide

String

Payload là một chuỗi ký tự ví dụ “#123”. Khi người dùng bấm vào action, hệ thống sẽ gửi một tin nhắn có nội dung chứa trong data từ người dùng đến Official Account. Tin nhắn này sẽ bị ẩn trên cửa sổ chat trên máy của người dùng. Ví dụ:

{
  "type": "oa.query.hide",
  "payload": "#123"
}

oa.open.sms

Json Object

Data đối tượng json chứa 2 thuộc tính “content” và “phone_code”, ví dụ:

{
  "type": "oa.open.sms",
  "payload": {
       "content":"alo",
       "phone_code":"84123456789″
  }
}


Khi người dùng click vào action, cửa sổ sms trên điện thoại của người dùng sẽ được mở với 2 thông tin sẵn có là phone code và nội dung tin nhắn trong data

oa.open.phone

Json Object

phone_code là số điện thoại sẽ gọi đi khi bật ứng dụng gọi điện, ví dụ:

{
  "type": "oa.open.phone",
  "payload": {
       "phone_code":"84123456789″
   }
}


Khi người dùng click vào action, cửa sổ call trên điện thoại của người dùng sẽ được mở với thông tin số điện thoại là giá trị của phone_code