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 da marca for "1234", esse parâmetro será resolvido como "brands/1234". O identificador da marca precisa ser "-" para retornar todos os agentes de uma operadora do RCS para Business.

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.
launchStateFilter

enum (LaunchState)

Opcional. Retorna apenas agentes com esse estado de lançamento. Funciona apenas quando usado por transportadoras.
includeLaunchData

boolean

Se for "true", os dados de lançamento (sem questionário) serão incluídos na resposta do agente. Funciona apenas quando usado por transportadoras.
includeArchived

boolean

Opcional. Inclui agentes arquivados na resposta.
includeHidden

boolean

Opcional. Inclui agentes ocultos na resposta.
orderBy

string

Opcional. Especifica uma lista separada por vírgulas de campos para ordenar os resultados.

Os campos de classificação aceitos são:

  • updateTime: classifica cronologicamente pelo carimbo de data/hora da última atualização.
  • displayName: classifica em ordem alfabética pelo nome legível do agente.
  • agentId: classifica pelo identificador exclusivo do agente gerado pelo sistema.

Os campos de classificação especificados sem um sufixo " desc" ou " asc" são definidos como ordem crescente por padrão. Se esse parâmetro for omitido, os resultados serão classificados por agentId em ordem crescente.

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 for "", significa que não há mais resultados para a solicitação.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.