Method: brands.agents.list

Lista todos os agentes associados a uma marca.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O identificador exclusivo da marca. Se o identificador de marca for "1234", esse parâmetro será resolvido como "brands/1234". O identificador de marca precisa ser "-" para retornar todos os agentes de uma operadora do RBM.

Parâmetros de consulta

Parâmetros
pageSize

integer

Especifique o número máximo de resultados a serem retornados pelo servidor. O servidor pode restringir ainda mais o número máximo de resultados retornados em uma única página. Se pageSize for 0, o servidor decidirá o número de resultados a serem retornados.
pageToken

string

O valor nextPageToken retornado de uma solicitação de lista anterior, se houver.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma lista de agentes.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Campos
agents[]

object (Agent)

Lista de informações do agente.
nextPageToken

string

O token de paginação para recuperar a próxima página de resultados. Se o valor é "", significa que não há mais resultados para a solicitação.