Consultar agente

Obtiene la configuración completa de un agente a partir de su slug.

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 ruta

slugstringObligatorio

Slug único del agente. Obtenlo desde Listar agentes o desde tu dashboard de Fonema.

Respuesta

namestring

Nombre del agente.

slugstring

Identificador único del agente.

greetingstring

Mensaje de apertura que dice el agente al iniciar la llamada.

promptstring

Prompt del sistema que define el comportamiento del agente.

textPromptstring

Prompt usado para conversaciones de texto/chat.

voiceIdstring

Identificador de la voz que usa el agente.

sipDialTargetstring | null

Destino SIP, si está configurado.

numberOfAttemptinteger

Número de intentos de llamada configurados (proviene de recallLogic).

allowReturnCallboolean

Si el agente permite llamadas de retorno.

recallLogicobject

Configuración de reintentos. Ver Editar agente.

workingHoursobject

Horario en el que el agente puede realizar llamadas. Ver Editar agente.

localizationsobject

Configuración de localización.

dtmfboolean

Si el agente puede marcar tonos del teclado (DTMF), por ejemplo para navegar menús telefónicos (IVR).

transferCallDestinationsarray

Números a los que el agente puede transferir la llamada. Ver Editar agente.

knowledgeBaseFilesarray

IDs de los archivos de base de conocimiento adjuntos.

toolsarray

Herramientas/skills disponibles para el agente.

configobject

Configuración adicional del agente (idioma del transcriptor, tiempos de espera, webhooks, etc.).

nota

Las credenciales sensibles de las herramientas (apiKey, token, credentialId) nunca se incluyen en la respuesta de tools.

Errores

404

El agente no existe o no es accesible con esta API Key.

GET/v1/agents/:slug

$curl -X GET "https://api.fonema.ai/v1/agents/agente-de-ventas-ab12cd34" \
>     -H "Authorization: Bearer TU_API_KEY"

200OK

1{
2  "name": "Agente de Ventas",
3  "slug": "agente-de-ventas-ab12cd34",
4  "greeting": "¡Hola, gracias por llamar!",
5  "prompt": "Eres un asistente de ventas servicial.",
6  "textPrompt": "...",
7  "voiceId": "TU_VOICE_ID",
8  "sipDialTarget": null,
9  "numberOfAttempt": 3,
10  "allowReturnCall": true,
11  "recallLogic": {
12    "totalCalls": 3
13  },
14  "workingHours": {},
15  "localizations": {},
16  "dtmf": false,
17  "transferCallDestinations": [],
18  "knowledgeBaseFiles": [],
19  "tools": [
20    {
21      "id": 12,
22      "name": "lookup_order",
23      "type": "API_CALL",
24      "description": "Busca un pedido por su ID",
25      "variables": [
26        {
27          "orderId": {
28            "type": "string",
29            "description": "El ID del pedido"
30          }
31        }
32      ],
33      "content": {
34        "functionName": "lookup_order",
35        "url": "https://example.com/api/orders"
36      }
37    }
38  ],
39  "config": {
40    "transcriberLanguage": "es-419",
41    "silenceTimeoutSeconds": 30,
42    "silenceMessages": [
43      "¿Sigues ahí?",
44      "Hola, ¿me escuchas?"
45    ],
46    "maxDurationSeconds": 600,
47    "endOfCallWebhook": "https://example.com/webhooks/end-of-call"
48  }
49}