Integração SIP

Este guia explica como integrar seu Agente de Voz com sistemas de telefonia usando SIP para receber e fazer chamadas. A abordagem recomendada é conectar o agente de voz a uma extensão PBX para troncos de saída, ou criar um tronco SIP de saída correspondente para troncos de entrada.

O SipPulse AI permite integração SIP através do seu Proxy sip:sip.sippulse.ai:5060

Conectando AO Tronco de Entrada do SipPulse AI

Você pode criar seu próprio usuário no SipPulse AI na Página do Agente de Voz:

Configuração SIP

• URI de Destino: sip:sip.sippulse.ai
• Porta: 5060
• Número: Adicione um número ao tronco de entrada no formato E.164 (ex., +5511987654321). Este número precisa ser único e deve ser um número que você possui.
• Endereços IP Permitidos: Adicione o endereço IP de origem do seu PBX ou sistema telefônico (Opcional, ex., 203.0.113.45)
• Números de Origem Permitidos: Adicione o número no cabeçalho SIP from (Opcional, ex., +5511987654321)
• Ativar Autenticação: Defina como Sim (Altamente recomendado)
• Nome de Usuário: Crie um nome de usuário único para este tronco (ex., tronco_entrada_empresa)
• Senha: Crie uma senha forte para autenticação (ex., S3nh@F0rte!2345)

Passando Parâmetros do Agente para um Tronco de Entrada

Para passar parâmetros para o agente, como variáveis, você pode usar o cabeçalho:

X-Additional-Instructions

Este cabeçalho aceita variáveis em formato JSON codificadas em Base64.

Exemplo:

JSON original:

{
    "nome_cliente": "João Silva",
    "valor_parcela": 5000
}

Valor codificado em Base64:

ewogICAgIm5vbWVfY2xpZW50ZSI6ICJKb8OjbyBTaWx2YSIsCiAgICAidmFsb3JfcGFyY2VsYSI6IDUwMDAKfQ==

Para enviar os dados, use o cabeçalho SIP:

X-Additional-Instructions: ewogICAgIm5vbWVfY2xpZW50ZSI6ICJKb8OjbyBTaWx2YSIsCiAgICAidmFsb3JfcGFyY2VsYSI6IDUwMDAKfQ==

Configurando o Tronco de Saída

A maneira mais fácil de configurar um tronco de saída é conectá-lo a uma extensão SIP existente, se disponível na Internet. Verifique com o administrador do seu PBX se é possível conectar para chamadas de saída. Recomendamos fortemente desabilitar chamadas internacionais nesta extensão para prevenir fraudes.

Para o tronco de saída, você precisará criar uma extensão em seu sistema telefônico e usar estes detalhes para fazer chamadas através do seu Tronco SIP.

No tronco de saída, você deve especificar o endereço do seu Tronco SIP:

• Endereço: Endereço do seu Tronco SIP (ex., sip:pbx.suaempresa.com.br:5060 ou sip:203.0.113.45:5060)
• Número: O ID de chamador de onde uma chamada será iniciada (opcional, ex., +5511987654321)
• Ativar Autenticação: Defina como Sim
  • Nome de Usuário: Nome de usuário para sua extensão PBX (ex., extensao_sip_101)
  • Senha: Senha para sua extensão PBX (ex., SenhaExt!2345)

Exemplo de Configuração

Aqui está um exemplo de uma configuração completa de tronco de saída:

Endereço: sip:pbx.empresaabc.com.br:5060
Número: +5511987654321
Ativar Autenticação: Sim
Nome de Usuário: ext_101
Senha: Senha123Segura!

Fazendo Chamadas de Saída

Chamadas de saída podem ser executadas no playground ou usando a API SipPulse. Você pode passar parâmetros para o agente nas instruções adicionais.

O tronco SIP de saída é acionado por uma API RESTful.

Ela usa o método POST com o endpoint:
https://api.sippulse.ai/bots/{id}/outbound-call

Onde {id} é o identificador único do seu Agente de Voz.

No corpo da requisição, use:

{
  "number": "+5511987654321",
  "initial_text": "Olá, aqui é o SipPulse AI ligando para confirmar seu agendamento amanhã às 14h.",
  "additional_instructions": "{\"nome_cliente\":\"João Silva\",\"id_agendamento\":\"AG-12345\"}",
  "activation_threshold": 3.5
}

Parâmetros:

• number: O número de telefone para chamar no formato E.164
• initial_text: A primeira mensagem que o agente dirá quando a chamada for atendida
• additional_instructions: String JSON com variáveis para o agente
• activation_threshold: Limiar de confiança para acionar o agente

Para documentação completa da API, visite: https://api.sippulse.ai/explorer/#/BotController/BotController.makeOutboundCall