Method: brands.agents.list

Enumera todos los agentes asociados con una marca.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el identificador único de la marca. Si el identificador de la marca es "1234", este parámetro se resuelve como "brands/1234". El identificador de marca debe ser "-" para devolver todos los agentes de un operador de RCS empresarial.

Parámetros de consulta

Parámetros
pageSize

integer

Especifica la cantidad máxima de resultados que devolverá el servidor. El servidor puede limitar aún más la cantidad máxima de resultados que se muestran en una sola página. Si pageSize es 0, el servidor decidirá la cantidad de resultados que se mostrarán.
pageToken

string

El valor nextPageToken que se muestra de una solicitud de lista previa, si existe.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es una lista de agentes.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Campos
agents[]

object (Agent)

Es una lista de información del agente.
nextPageToken

string

Es el token de paginación para recuperar la siguiente página de resultados. Si el valor es "", significa que no hay más resultados para la solicitud.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.