Method: brands.agents.list

Liệt kê tất cả các nhân viên hỗ trợ được liên kết với một thương hiệu.

Yêu cầu HTTP

GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Giá trị nhận dạng riêng biệt của thương hiệu. Nếu mã nhận dạng thương hiệu là "1234", thì tham số này sẽ phân giải thành "brands/1234". Giá trị nhận dạng thương hiệu phải là "-" để trả về tất cả các tác nhân cho một nhà mạng RCS for Business.

Tham số truy vấn

Thông số
pageSize

integer

Chỉ định số lượng kết quả tối đa mà máy chủ sẽ trả về. Máy chủ có thể hạn chế thêm số lượng kết quả tối đa được trả về trong một trang. Nếu pageSize là 0, máy chủ sẽ quyết định số lượng kết quả cần trả về.
pageToken

string

Giá trị nextPageToken được trả về từ một yêu cầu List trước đó (nếu có).
launchStateFilter

enum (LaunchState)

Không bắt buộc. Chỉ trả về những tác nhân có trạng thái ra mắt này. Chỉ hoạt động khi hãng vận chuyển sử dụng.
includeLaunchData

boolean

Nếu đúng, dữ liệu khởi chạy (không có bảng câu hỏi) sẽ được đưa vào phản hồi của trợ lý. Chỉ hoạt động khi hãng vận chuyển sử dụng.
includeArchived

boolean

Không bắt buộc. Bao gồm cả những nhân viên hỗ trợ đã lưu trữ trong phản hồi.
includeHidden

boolean

Không bắt buộc. Bao gồm các tác nhân bị ẩn trong phản hồi.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Danh sách nhân viên hỗ trợ.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Trường
agents[]

object (Agent)

Danh sách thông tin về nhân viên hỗ trợ.
nextPageToken

string

Mã thông báo phân trang để truy xuất trang kết quả tiếp theo. Nếu giá trị là "", tức là không có kết quả nào khác cho yêu cầu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/businesscommunications

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.