Listar agentes

Devuelve los agentes a los que tu API Key tiene acceso. Una clave con alcance Todos los agentes devuelve todos los agentes de tu empresa; una clave con alcance Agentes específicos devuelve únicamente los agentes vinculados a esa clave.

Autenticación

AuthorizationBearer

Autentica las solicitudes desde tu servidor con una API Key de Fonema. Créala en la sección de API Keys del Dashboard y envíala en el encabezado Authorization como Bearer <token>. No pongas tus claves en código del navegador ni en repositorios públicos.

Parámetros de consulta

pageintegerOpcionalPor defecto 1

Número de página a obtener (empezando en 1). Valores menores a 1 se ajustan a 1.

limitintegerOpcionalPor defecto 20

Cantidad de agentes por página. Máximo 100.

Respuesta

totalinteger

Número total de agentes accesibles por esta clave.

limitinteger

Tamaño de página usado en esta respuesta.

offsetinteger

Cantidad de agentes omitidos antes de esta página.

currentPageinteger

Página devuelta.

totalPagesinteger

Número total de páginas disponibles.

agentsarray

Lista de agentes. Cada elemento contiene el name y el slug del agente.

tip

Usa el slug que se devuelve aquí como identificador en las solicitudes de Consultar agente y Editar agente.

GET/v1/agents

$curl -X GET "https://api.fonema.ai/v1/agents?page=1&limit=20" \
>     -H "Authorization: Bearer TU_API_KEY"

200OK

1{
2  "offset": 0,
3  "total": 42,
4  "limit": 20,
5  "currentPage": 1,
6  "totalPages": 3,
7  "agents": [
8    {
9      "name": "Agente de Ventas",
10      "slug": "agente-de-ventas-ab12cd34"
11    },
12    {
13      "name": "Agente de Soporte",
14      "slug": "agente-de-soporte-ef56gh78"
15    }
16  ]
17}