Ir al contenido principal

Llamadas - API de Llamadas Salientes

La API de Llamadas Salientes permite iniciar llamadas de voz automatizadas de forma programática.

S
Escrito por Support Team

Detalles del Endpoint

Método HTTP: POST URL: [https://voice-gateway-service-production.up.railway.app/api/v1/calls](https://voice-gateway-service-production.up.railway.app/api/v1/calls)

Encabezados (Headers)

Encabezado

Valor

Descripción

Content-Type

application/json

Especifica el formato del payload.

X-API-KEY

string

La clave de API (API Key) asociada a tu Unidad Organizativa (OU).

Parámetros del Payload de la Solicitud

Debes enviar los siguientes parámetros en el cuerpo (body) JSON de tu solicitud:

Parámetro

Tipo

Descripción

channel_id

Entero

El identificador único del canal de la llamada. Se puede encontrar en Retool.

from_phone_number

Cadena

El número de teléfono del canal que origina la llamada.

to_phone_number

Cadena

El número de teléfono de destino del cliente.

customer_name

Cadena

El nombre del cliente que recibe la llamada.

initial_pipeline_id

Cadena

Opcional. Sobrescribe el pipeline predeterminado. Añade el ID del pipeline específico que deseas utilizar.

prompt_templates

Objeto

Opcional. Vincula las etiquetas {{variable_name}} dentro de la misión de la IA con sus respectivos valores dinámicos.

first_message

Cadena

Opcional. Sobrescribe el primer mensaje (mensaje de apertura) configurado por defecto en el pipeline.

variable_values

Objeto

Opcional. Vincula las etiquetas {{variable_name}} utilizadas específicamente dentro de tu first_message personalizado con sus valores correspondientes.

Ejemplos de Código

Ejemplo 1: Llamada Saliente Estándar con Variables de Prompt Personalizadas

Este ejemplo demuestra cómo iniciar una llamada inyectando variables dinámicas tanto en el prompt de la misión como en un primer mensaje personalizado.

Bash

curl --location 'https://voice-gateway-service-production.up.railway.app/api/v1/calls' \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: <YOUR_API_KEY>' \ --data '{     "channel_id": 123,     "from_phone_number": "+549341567894",      "to_phone_number": "+5493415678937",     "customer_name": "John Doe",     "initial_pipeline_id": "345",     "prompt_templates": {         "consignatario": "onboarding"     },     "first_message": "Hello, how are you?",     "variable_values": {         "name": "John Doe"     } }'
¿Ha quedado contestada tu pregunta?