Ir para conteúdo principal

Chamadas - Referência da API de Chamadas Ativas

A Outbound Call API permite que você inicie chamadas de voz automatizadas de forma programática. Por meio deste endpoint, você pode atribuir pipelines dinamicamente, substituir a mensagem de abertura padrão e injetar dados variáveis diretamente.

S
Escrito por Support Team

Detalhes do 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)

Cabeçalhos (Headers)

Cabeçalho

Valor

Descrição

Content-Type

application/json

Especifica o formato do payload.

X-API-KEY

string

A Chave de API (API Key) associada à sua Unidade Organizacional (OU).

Parâmetros do Payload da Requisição

Envie os seguintes parâmetros no corpo (body) JSON da sua requisição:

Parâmetro

Tipo

Descrição

channel_id

Inteiro

O identificador único do canal de chamada. Pode ser encontrado no Retool.

from_phone_number

String

O número de telefone do canal que origina a chamada.

to_phone_number

String

O número de telefone de destino do cliente.

customer_name

String

O nome do cliente que recebe a chamada.

initial_pipeline_id

String

Opcional. Substitui o pipeline predeterminado. Adicione o ID do pipeline específico que você deseja utilizar.

prompt_templates

Objeto

Opcional. Vincula as tags {{variable_name}} dentro da missão da IA aos seus respectivos valores dinâmicos.

first_message

String

Opcional. Substitui a primeira mensagem (mensagem de abertura) configurada por padrão no pipeline.

variable_values

Objeto

Opcional. Vincula as tags {{variable_name}} utilizadas especificamente dentro da sua first_messagepersonalizada aos seus valores correspondentes.

Exemplos de Código

Exemplo 1: Chamada Ativa Padrão com Variáveis de Prompt Personalizadas

Este exemplo demonstra como iniciar uma chamada injetando variáveis dinâmicas tanto no prompt da missão quanto em uma primeira mensagem personalizada.

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"     } }'
Isto respondeu à sua pergunta?