Documentación
superleads.mx
Documentación › Referencia de la API › Voice Ai

Voice Ai

Referencia de la API · ☕ 10 min de lectura
Actualizado el 19 Jun 2026

Voice AI API

Documentación de la API de Voice AI

Servidor base: https://services.leadconnectorhq.com

Endpoints

POST /voice-ai/agents

Crear agente Create a new voice AI agent configuration and settings

Scopes requeridos: voice-ai-agents.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Unique identifier for the location where this agent will operate - agentName — string — Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}" - businessName — string — Name of the business this agent represents. Default: Uses location name - welcomeMessage — string — Initial greeting spoken when the agent answers calls. Default: Auto generated - agentPrompt — string — Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically - voiceId — string — Identifier for the speech synthesis voice from available voice options. Default: Auto generated - language — - patienceLevel — - maxCallDuration — number — Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes) - sendUserIdleReminders — boolean — Enables automatic reminders when callers are silent. Default: true - reminderAfterIdleTimeSeconds — number — Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds - inboundNumber — string — Phone number for receiving inbound calls to this agent. Default: null - numberPoolId — string — Identifier for the number pool managing phone number allocation. Default: null - callEndWorkflowIds — array — Array of workflow IDs to trigger automatically when calls end. Default: [] - sendPostCallNotificationTo — — Configuration for post-call email notifications to various recipients. Default: [] - agentWorkingHours — array — Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7) - dayOfTheWeek (requerido) — number — Day of the week for this working hours configuration (Monday=1 to Sunday=7) - intervals (requerido) — array — Array of time intervals when the agent is available on this day - startHour (requerido) — number — Starting hour of the working interval in 24-hour format (0-23) - endHour (requerido) — number — Ending hour of the working interval in 24-hour format (0-23) - startMinute (requerido) — number — Starting minute of the working interval (0-59) - endMinute (requerido) — number — Ending minute of the working interval (0-59) - timezone — string — IANA timezone identifier affecting working hours and scheduling. Default: Location timezone - isAgentAsBackupDisabled — boolean — Prevents this agent from being used as a fallback option. Default: false (Available as backup agent) - translation — — Language translation settings including enablement flag and target language code. Rules: (1) translation.enabled can only be true if the agent's language is not en-US; (2) when enabled, translation.language must be either the agent's language or en-US; (3) when enabled, translation.language is required.

Respuestas: - 201 — Agent created successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /voice-ai/agents

Listar agentes Retrieve a paginated list of agents for given location.

Scopes requeridos: voice-ai-agents.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - page (query, number) — Page number starting from 1 - pageSize (query, number) — Number of items per page - locationId (query, string) (requerido) — Id de sede - query (query, string) — Query

Respuestas: - 200 — Agent list retrieved successfully. - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /voice-ai/agents/{agentId}

Patch Agent Partially update an existing voice AI agent

Scopes requeridos: voice-ai-agents.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) — Identificador de Unique agent - locationId (query, string) (requerido) — Id de sede

Cuerpo de la peticion (application/json): - agentName — string — Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}" - businessName — string — Name of the business this agent represents. Default: Uses location name - welcomeMessage — string — Initial greeting spoken when the agent answers calls. Default: Auto generated - agentPrompt — string — Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically - voiceId — string — Identifier for the speech synthesis voice from available voice options. Default: Auto generated - language — - patienceLevel — - maxCallDuration — number — Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes) - sendUserIdleReminders — boolean — Enables automatic reminders when callers are silent. Default: true - reminderAfterIdleTimeSeconds — number — Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds - inboundNumber — string — Phone number for receiving inbound calls to this agent. Default: null - numberPoolId — string — Identifier for the number pool managing phone number allocation. Default: null - callEndWorkflowIds — array — Array of workflow IDs to trigger automatically when calls end. Default: [] - sendPostCallNotificationTo — — Configuration for post-call email notifications to various recipients. Default: [] - agentWorkingHours — array — Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7) - dayOfTheWeek (requerido) — number — Day of the week for this working hours configuration (Monday=1 to Sunday=7) - intervals (requerido) — array — Array of time intervals when the agent is available on this day - startHour (requerido) — number — Starting hour of the working interval in 24-hour format (0-23) - endHour (requerido) — number — Ending hour of the working interval in 24-hour format (0-23) - startMinute (requerido) — number — Starting minute of the working interval (0-59) - endMinute (requerido) — number — Ending minute of the working interval (0-59) - timezone — string — IANA timezone identifier affecting working hours and scheduling. Default: Location timezone - isAgentAsBackupDisabled — boolean — Prevents this agent from being used as a fallback option. Default: false (Available as backup agent) - translation — — Language translation settings including enablement flag and target language code. Rules: (1) translation.enabled can only be true if the agent's language is not en-US; (2) when enabled, translation.language must be either the agent's language or en-US; (3) when enabled, translation.language is required.

Respuestas: - 200 — Agent updated successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /voice-ai/agents/{agentId}

Obtener agente Retrieve detailed configuration and settings for a specific voice AI agent

Scopes requeridos: voice-ai-agents.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) — Identificador de Unique agent - locationId (query, string) (requerido) — Id de sede

Respuestas: - 200 — Agent details retrieved successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /voice-ai/agents/{agentId}

Eliminar agente Delete a voice AI agent and all its configurations

Scopes requeridos: voice-ai-agents.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - agentId (path, string) (requerido) — Identificador de Unique agent - locationId (query, string) (requerido) — Id de sede

Respuestas: - 204 — Agent deleted successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /voice-ai/dashboard/call-logs

Listar Call Logs Returns call logs for Voice AI agents scoped to a location. Supports filtering by agent, contact, call type, action types, and date range (interpreted in the provided IANA timezone). Also supports sorting and 1-based pagination.

Scopes requeridos: voice-ai-dashboard.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Location identifier. Filters results to this location. - agentId (query, string) — Agent identifier. When provided, returns logs for this agent only. - contactId (query, string) — Contact IDs (comma-separated) to filter by. - callType (query, string) — Call type filter. - startDate (query, number) — Start date filter (Unix timestamp). Must be less than endDate. Both startDate and endDate must be provided together. - endDate (query, number) — End date filter (Unix timestamp). Must be greater than startDate. Both startDate and endDate must be provided together. - actionType (query, string) — Action type filter for call logs (comma-separated ACTION_TYPE values) - sortBy (query, string) — Field to sort by. Defaults to newest if omitted. - sort (query, string) — Sort direction. Applies only when sortBy is provided. - page (query, number) — Page number (1-based). - pageSize (query, number) — Page size (max 50).

Respuestas: - 200 — Successfully retrieved call logs - 400 — Peticion invalida - 401 — No autorizado

GET /voice-ai/dashboard/call-logs/{callId}

Obtener Call Log Returns a call log by callId.

Scopes requeridos: voice-ai-dashboard.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - callId (path, string) (requerido) — Id de Call - locationId (query, string) (requerido) — Id de sede

Respuestas: - 200 — Successfully retrieved call log - 400 — Peticion invalida - 401 — No autorizado

POST /voice-ai/actions

Crear Agent Action Create a new action for a voice AI agent. Actions define specific behaviors and capabilities for the agent during calls.

Scopes requeridos: voice-ai-agent-goals.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - agentId (requerido) — string — Agent Id to attach the action to - locationId (requerido) — string — Location Id - actionType (requerido) — string — Type of action - name (requerido) — string — Human-readable name for this action - actionParameters (requerido) — — Action parameters - structure varies by actionType

Respuestas: - 201 — Action created successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /voice-ai/actions/{actionId}

Actualizar Agent Action Update an existing action for a voice AI agent. Modifies the behavior and configuration of an agent action.

Scopes requeridos: voice-ai-agent-goals.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - actionId (path, string) (requerido) — Unique identifier for the action

Cuerpo de la peticion (application/json): - agentId (requerido) — string — Agent Id to attach the action to - locationId (requerido) — string — Location Id - actionType (requerido) — string — Type of action - name (requerido) — string — Human-readable name for this action - actionParameters (requerido) — — Action parameters - structure varies by actionType

Respuestas: - 200 — Action updated successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /voice-ai/actions/{actionId}

Obtener Agent Action Retrieve details of a specific action by its Id. Returns the action configuration including actionParameters.

Scopes requeridos: voice-ai-agent-goals.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - actionId (path, string) (requerido) — Unique identifier for the action - locationId (query, string) (requerido) — Id de sede

Respuestas: - 200 — Action details retrieved successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /voice-ai/actions/{actionId}

Eliminar Agent Action Delete an existing action from a voice AI agent. This permanently removes the action and its configuration.

Scopes requeridos: voice-ai-agent-goals.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - actionId (path, string) (requerido) — Unique identifier for the action - locationId (query, string) (requerido) — Id de sede - agentId (query, string) (requerido) — Agent Id the action is attached to

Respuestas: - 204 — Action deleted successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar