> ## Documentation Index > Fetch the complete documentation index at: https://docs.ipbox.com.br/llms.txt > Use this file to discover all available pages before exploring further. # criarUra > # criarUra ## Visão Geral Este documento descreve o **formato de configuração JSON** utilizado para criação de URAs via API IPBoX. A URA define **fluxos de atendimento telefônico automatizados**, contendo: - Descrição e tipo da URA; - Áudios iniciais (`audio_inicial`); - Opções DTMF (`tecla_1`, `tecla_2`, `tecla_3`, etc) com destinos e ações; - Tratamento de situações especiais, como: - Tecla inválida (`opcao_invalida`); - Tempo excedido (`tempo_excedido`); - Desliga sem digitar opção (`desliga_sem_opcao`). --- ## Estrutura Raiz ``` json { "descricao": "URA criada via API", "tipo": "REV", "fila": "1", "audio_inicial": [ ... ], "tecla_1": { ... }, "tecla_2": { ... }, ... "opcao_invalida": { ... }, "tempo_excedido": { ... }, "desliga_sem_opcao": { ... } } ``` ### Campos principais | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **descricao** | `string` | Sim | Texto descritivo ou identificador da URA. | | **tipo** | `string` | Sim | Tipo da URA (`REV`\=Ura Reversa ou `REC`\=Ura Ativa/Receptiva). | | **fila** | `string` ou `integer` | Sim para tipo `REV` | ID ou nome da fila mensagem da URA. | | **audio_inicial** | `array` | Sim | Lista de áudios reproduzidas antes do menu de opções. | | **tecla_N** | `object` | Não | Definição das opções (teclas 1, 2, 3, etc). | | **opcao_invalida** | `object` | Não | Ação executada ao pressionar tecla inválida. | | **tempo_excedido** | `object` | Não | Ação executada quando o tempo de espera expira. | | **desliga_sem_opcao** | `object` | Não | Ação executada quando a ligação termina sem escolha. | --- ## `` Campo `audio_inicial` `` `Define os **áudios ou mensagens de boas-vindas** reproduzidos antes do menu de opções.` ``` json "audio_inicial": [ { "tipo": "A", "audio": "bemvindo", "dtmf": 1 }, { "tipo": "S", "bomdia": "4", "boatarde": "boatarde v2", "boanoite": "boanoite v2" }, { "tipo": "T", "tts": "Nome Completo", "voz": "Elza" } ] ``` ### ``Tipos de entrada (`tipo`)`` | Tipo | Descrição | Campos associados | | --- | --- | --- | | **A** | Áudio | `audio` (id ou descrição do áudio), `dtmf` (`1`\=Ativo ou `0`\=Desativado) | | **S** | Saudação | campos `bomdia`, `boatarde`, `boanoite` contendo o id ou descrição do áudio correspondente | | **T** | TTS | `tts` (tipo de dado a ser sintetizado), `voz` (voz selecionada) | ``Em cada um dos tipos acima pode-se definir o campo `dtmf` (`1`=Ativo ou `0`=Desativado). O padrão é `dtmf`=`1`.`` --- ## `☎️ Campos de opções (teclas 1, 2, 3, etc)` `Cada tecla define uma **opção DTMF** (1, 2, 3, etc). Quando o usuário pressiona uma tecla, a URA executa a ação configurada.` ``` json "tecla_1": { "destino": "Fila", "acao": "15", "opcoes_extras": { "adicionar_blacklist": 1, "enviar_url": { "url": "https://www.teste.com.br", "codificar": 1 } } } ``` ### `Campos` | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **destino** | `string` | Sim | Tipo de destino (`Ramal`, `Fila`, `URA`, `Grupo`, `Audio`, `PABX`, `SMS`, `Correio de Voz`, `Repetir mensagem`, `Adicionar ao lote`, `Receber contato por WhatsApp`, `Desligar`) | | **acao** | `string` | Sim | Valor associado à ação — pode ser número de ramal, nome de grupo, texto de SMS, nome de URA, etc. | | **opcoes_extras** | `object` | Não | Configurações adicionais relacionadas à ação. | --- ## `` 🧰 Objeto `opcoes_extras` `` `Define **ações complementares** executadas junto com a ação principal da tecla.` ``` json "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "confirma contato", "adicionar_lote": "lote sms", "enviar_url": { "url": "https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 }, "enviar_whats_grupo": "grupo de vendas" } ``` ### `Campos disponíveis` | Campo | Tipo | Padrão | Descrição | | --- | --- | --- | --- | | **remover_prospect** | `integer` (`0` ou `1`) | `0` | Se `1`, remove o prospect do lote | | **adicionar_blacklist** | `integer` (`0` ou `1`) | `0` | Se `1`, adiciona o número atual à blacklist | | **executar_audio** | `string` | "" | Id ou descrição do áudio | | **adicionar_lote** | `string` | "" | Id ou descrição do lote onde o contato será incluído. | | **enviar_url** | `object` | "" | Realiza uma requisição à url informada antes ou depois da execução. | | **enviar_whats_grupo** | `string` | "" | Nome do grupo de WhatsApp para encaminhar o contato. | --- ## `` Objeto `enviar_url` `` `Permite realizar **requisições a URLs externas**, podendo incluir variáveis de contexto.` ``` json "enviar_url": { "url": "https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1, "enviar_antes_do_audio": 1 } ``` ### `Campos` | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **url** | `string` | Sim | Endereço completo da requisição. Pode conter placeholders como `[nome]`, `[numero_em_atendimento]`, etc. | | **codificar** | `integer` (`0` ou `1`) | `1` | Se `1`, aplica URL encoding aos parâmetros. | | **enviar_antes_do_audio** | `integer` (`0` ou `1`) | `0` | Se `1`, executa a requisição antes do áudio principal (válido apenas para destino do tipo `Audio`) | --- ## `` Campo `opcao_invalida` `` `Ação executada quando o usuário digita uma tecla não configurada.` ``` json "opcao_invalida": { "destino": "Desligar", "acao": "Desligar e remover prospect", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "adicionar_lote": "lote invalida" } } ``` --- ## `` Campo `tempo_excedido` `` `Define o comportamento quando **o usuário não pressiona nenhuma tecla** em um tempo determinado.` ``` json "tempo_excedido": { "timeout": 10, "destino": "Adicionar ao lote", "acao": "AZURE TTS", "opcoes_extras": { "executar_audio": "NOVO" } } ``` ### `Campos` | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **timeout** | `integer` | Sim | Tempo máximo de espera (em segundos). Default: 10 | | **destino** | `string` | Sim | Tipo de destino a acionar após o timeout. | | **acao** | `string` | Sim | Ação a ser executada. | | **opcoes_extras** | `object` | Não | Configurações adicionais. | --- ## `` Campo `desliga_sem_opcao` `` `Executado quando a ligação é encerrada sem qualquer interação do usuário.` ``` json "desliga_sem_opcao": { "destino": "SMS + Remover Prospect", "acao": "Texto SMS" } ``` --- ## `Exemplo mínimo do json` ``` json { "descricao": "URA criada via API", "tipo": "REC", "audio_inicial" : [ { "tipo": "A", "audio": "1", "dtmf": 1 } ], "tecla_1": { "destino": "Ramal", "acao": "6000" } } ``` --- ## `Exemplo completo do json` ``` json { "descricao": "URA criada via API", "tipo": "REV", "fila": "1", "audio_inicial" : [ { "tipo": "A", "audio": "bemvindo", "dtmf": 1 }, { "tipo": "S", "bomdia": "4", "boatarde": "boatarde v2", "boanoite": "boanoite v2" }, { "tipo": "T", "tts": "Nome Completo", "voz": "Elza" } ], "tecla_1": { "destino": "Ramal", "acao": "6000", "opcoes_extras": { "adicionar_blacklist": 1 } }, "tecla_2": { "destino": "PABX", "acao": "ipboxbina", "pabx": "1134567890", "opcoes_extras": { "adicionar_blacklist": 1 } }, "tecla_3": { "destino": "Fila", "acao": "15", "opcoes_extras": { "adicionar_blacklist": 1, "enviar_url": { "url": "https://www.teste.com.br", "codificar": 1 } } }, "tecla_4": { "destino": "Grupo", "acao": "GRUPO VENDAS", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_5": { "destino": "Correio de Voz", "acao": "6000", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_6": { "destino": "URA", "acao": "6000", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_7": { "destino": "Audio", "acao": "PROMOCAO", "opcoes_extras": { "remover_prospect": 0, "adicionar_blacklist": 0, "executar_audio": "convite evento", "adicionar_lote": "lote api", "enviar_url": { "url": "https://www.teste.com.br?promo=1&nome=[nome]", "codificar": 1, "enviar_antes_do_audio": 1 } } }, "tecla_8": { "destino": "Repetir mensagem", "acao": "2" }, "tecla_9": { "destino": "Adicionar ao lote", "acao": "enriquecimento tts", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_10": { "destino": "Receber contato por WhatsApp", "acao": "texto confirmacao", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "confirma contato", "adicionar_lote": "", "enviar_url": { "url": "https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 }, "enviar_whats_grupo": "grupo de vendas" } }, "tecla_11": { "destino": "SMS", "acao": "texto sms", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "", "adicionar_lote": "lote sms", "enviar_url": { "url": "https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 } } }, "tecla_12": { "destino": "Desligar", "acao": "Apenas desligar", "opcoes_extras": { "adicionar_blacklist": 0 } }, "opcao_invalida": { "destino": "Desligar", "acao": "Desligar e remover prospect", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "", "adicionar_lote": "lote invalida", "enviar_url": { "url": "https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 } } }, "tempo_excedido": { "timeout": 10, "destino": "Adicionar ao lote", "acao": "AZURE TTS", "opcoes_extras": { "remover_prospect": 0, "adicionar_blacklist": 0, "executar_audio": "NOVO", "adicionar_lote": "", "enviar_url": { "url": "https://www.teste.com.br", "codificar": 1, "enviar_antes_do_audio": 1 } } }, "desliga_sem_opcao": { "destino": "SMS + Remover Prospect", "acao": "Texto SMS" } } ``` ## OpenAPI ````yaml /openapi.yaml post /ipbox/api/criarUra openapi: 3.0.0 info: title: IPBoX Api Documentation v1.1 description: >- Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os comandos são executados com chamadas POST e com respostas em formato JSON. version: 1.0.0 servers: - url: https://{baseUrl} description: Dominio (e porta, se houver) do servidor IPBoX do cliente variables: baseUrl: default: cliente.ipboxcloud.com.br:9052 description: >- Substitua pelo dominio real do seu servidor IPBoX. A maioria dos servidores usa uma porta especifica - inclua-a junto ao dominio (ex.: cliente.ipboxcloud.com.br:9052) security: - ApiToken: [] tags: - name: Agente - name: Ligações - name: Prospects - name: Agendamentos - name: Listas - name: Filas - name: Lotes - name: Relatórios - name: Outros - name: Times - name: Blacklist - name: Áudios - name: URAs paths: /ipbox/api/criarUra: post: tags: - URAs summary: criarUra description: >- # criarUra ## Visão Geral Este documento descreve o **formato de configuração JSON** utilizado para criação de URAs via API IPBoX. A URA define **fluxos de atendimento telefônico automatizados**, contendo: - Descrição e tipo da URA; - Áudios iniciais (`audio_inicial`); - Opções DTMF (`tecla_1`, `tecla_2`, `tecla_3`, etc) com destinos e ações; - Tratamento de situações especiais, como: - Tecla inválida (`opcao_invalida`); - Tempo excedido (`tempo_excedido`); - Desliga sem digitar opção (`desliga_sem_opcao`). --- ## Estrutura Raiz ``` json { "descricao": "URA criada via API", "tipo": "REV", "fila": "1", "audio_inicial": [ ... ], "tecla_1": { ... }, "tecla_2": { ... }, ... "opcao_invalida": { ... }, "tempo_excedido": { ... }, "desliga_sem_opcao": { ... } } ``` ### Campos principais | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **descricao** | `string` | Sim | Texto descritivo ou identificador da URA. | | **tipo** | `string` | Sim | Tipo da URA (`REV`\=Ura Reversa ou `REC`\=Ura Ativa/Receptiva). | | **fila** | `string` ou `integer` | Sim para tipo `REV` | ID ou nome da fila mensagem da URA. | | **audio_inicial** | `array` | Sim | Lista de áudios reproduzidas antes do menu de opções. | | **tecla_N** | `object` | Não | Definição das opções (teclas 1, 2, 3, etc). | | **opcao_invalida** | `object` | Não | Ação executada ao pressionar tecla inválida. | | **tempo_excedido** | `object` | Não | Ação executada quando o tempo de espera expira. | | **desliga_sem_opcao** | `object` | Não | Ação executada quando a ligação termina sem escolha. | --- ## `` Campo `audio_inicial` `` `Define os **áudios ou mensagens de boas-vindas** reproduzidos antes do menu de opções.` ``` json "audio_inicial": [ { "tipo": "A", "audio": "bemvindo", "dtmf": 1 }, { "tipo": "S", "bomdia": "4", "boatarde": "boatarde v2", "boanoite": "boanoite v2" }, { "tipo": "T", "tts": "Nome Completo", "voz": "Elza" } ] ``` ### ``Tipos de entrada (`tipo`)`` | Tipo | Descrição | Campos associados | | --- | --- | --- | | **A** | Áudio | `audio` (id ou descrição do áudio), `dtmf` (`1`\=Ativo ou `0`\=Desativado) | | **S** | Saudação | campos `bomdia`, `boatarde`, `boanoite` contendo o id ou descrição do áudio correspondente | | **T** | TTS | `tts` (tipo de dado a ser sintetizado), `voz` (voz selecionada) | ``Em cada um dos tipos acima pode-se definir o campo `dtmf` (`1`=Ativo ou `0`=Desativado). O padrão é `dtmf`=`1`.`` --- ## `☎️ Campos de opções (teclas 1, 2, 3, etc)` `Cada tecla define uma **opção DTMF** (1, 2, 3, etc). Quando o usuário pressiona uma tecla, a URA executa a ação configurada.` ``` json "tecla_1": { "destino": "Fila", "acao": "15", "opcoes_extras": { "adicionar_blacklist": 1, "enviar_url": { "url": "https://www.teste.com.br", "codificar": 1 } } } ``` ### `Campos` | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **destino** | `string` | Sim | Tipo de destino (`Ramal`, `Fila`, `URA`, `Grupo`, `Audio`, `PABX`, `SMS`, `Correio de Voz`, `Repetir mensagem`, `Adicionar ao lote`, `Receber contato por WhatsApp`, `Desligar`) | | **acao** | `string` | Sim | Valor associado à ação — pode ser número de ramal, nome de grupo, texto de SMS, nome de URA, etc. | | **opcoes_extras** | `object` | Não | Configurações adicionais relacionadas à ação. | --- ## `` 🧰 Objeto `opcoes_extras` `` `Define **ações complementares** executadas junto com a ação principal da tecla.` ``` json "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "confirma contato", "adicionar_lote": "lote sms", "enviar_url": { "url": "https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 }, "enviar_whats_grupo": "grupo de vendas" } ``` ### `Campos disponíveis` | Campo | Tipo | Padrão | Descrição | | --- | --- | --- | --- | | **remover_prospect** | `integer` (`0` ou `1`) | `0` | Se `1`, remove o prospect do lote | | **adicionar_blacklist** | `integer` (`0` ou `1`) | `0` | Se `1`, adiciona o número atual à blacklist | | **executar_audio** | `string` | "" | Id ou descrição do áudio | | **adicionar_lote** | `string` | "" | Id ou descrição do lote onde o contato será incluído. | | **enviar_url** | `object` | "" | Realiza uma requisição à url informada antes ou depois da execução. | | **enviar_whats_grupo** | `string` | "" | Nome do grupo de WhatsApp para encaminhar o contato. | --- ## `` Objeto `enviar_url` `` `Permite realizar **requisições a URLs externas**, podendo incluir variáveis de contexto.` ``` json "enviar_url": { "url": "https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1, "enviar_antes_do_audio": 1 } ``` ### `Campos` | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **url** | `string` | Sim | Endereço completo da requisição. Pode conter placeholders como `[nome]`, `[numero_em_atendimento]`, etc. | | **codificar** | `integer` (`0` ou `1`) | `1` | Se `1`, aplica URL encoding aos parâmetros. | | **enviar_antes_do_audio** | `integer` (`0` ou `1`) | `0` | Se `1`, executa a requisição antes do áudio principal (válido apenas para destino do tipo `Audio`) | --- ## `` Campo `opcao_invalida` `` `Ação executada quando o usuário digita uma tecla não configurada.` ``` json "opcao_invalida": { "destino": "Desligar", "acao": "Desligar e remover prospect", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "adicionar_lote": "lote invalida" } } ``` --- ## `` Campo `tempo_excedido` `` `Define o comportamento quando **o usuário não pressiona nenhuma tecla** em um tempo determinado.` ``` json "tempo_excedido": { "timeout": 10, "destino": "Adicionar ao lote", "acao": "AZURE TTS", "opcoes_extras": { "executar_audio": "NOVO" } } ``` ### `Campos` | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | **timeout** | `integer` | Sim | Tempo máximo de espera (em segundos). Default: 10 | | **destino** | `string` | Sim | Tipo de destino a acionar após o timeout. | | **acao** | `string` | Sim | Ação a ser executada. | | **opcoes_extras** | `object` | Não | Configurações adicionais. | --- ## `` Campo `desliga_sem_opcao` `` `Executado quando a ligação é encerrada sem qualquer interação do usuário.` ``` json "desliga_sem_opcao": { "destino": "SMS + Remover Prospect", "acao": "Texto SMS" } ``` --- ## `Exemplo mínimo do json` ``` json { "descricao": "URA criada via API", "tipo": "REC", "audio_inicial" : [ { "tipo": "A", "audio": "1", "dtmf": 1 } ], "tecla_1": { "destino": "Ramal", "acao": "6000" } } ``` --- ## `Exemplo completo do json` ``` json { "descricao": "URA criada via API", "tipo": "REV", "fila": "1", "audio_inicial" : [ { "tipo": "A", "audio": "bemvindo", "dtmf": 1 }, { "tipo": "S", "bomdia": "4", "boatarde": "boatarde v2", "boanoite": "boanoite v2" }, { "tipo": "T", "tts": "Nome Completo", "voz": "Elza" } ], "tecla_1": { "destino": "Ramal", "acao": "6000", "opcoes_extras": { "adicionar_blacklist": 1 } }, "tecla_2": { "destino": "PABX", "acao": "ipboxbina", "pabx": "1134567890", "opcoes_extras": { "adicionar_blacklist": 1 } }, "tecla_3": { "destino": "Fila", "acao": "15", "opcoes_extras": { "adicionar_blacklist": 1, "enviar_url": { "url": "https://www.teste.com.br", "codificar": 1 } } }, "tecla_4": { "destino": "Grupo", "acao": "GRUPO VENDAS", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_5": { "destino": "Correio de Voz", "acao": "6000", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_6": { "destino": "URA", "acao": "6000", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_7": { "destino": "Audio", "acao": "PROMOCAO", "opcoes_extras": { "remover_prospect": 0, "adicionar_blacklist": 0, "executar_audio": "convite evento", "adicionar_lote": "lote api", "enviar_url": { "url": "https://www.teste.com.br?promo=1&nome=[nome]", "codificar": 1, "enviar_antes_do_audio": 1 } } }, "tecla_8": { "destino": "Repetir mensagem", "acao": "2" }, "tecla_9": { "destino": "Adicionar ao lote", "acao": "enriquecimento tts", "opcoes_extras": { "adicionar_blacklist": 0 } }, "tecla_10": { "destino": "Receber contato por WhatsApp", "acao": "texto confirmacao", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "confirma contato", "adicionar_lote": "", "enviar_url": { "url": "https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 }, "enviar_whats_grupo": "grupo de vendas" } }, "tecla_11": { "destino": "SMS", "acao": "texto sms", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "", "adicionar_lote": "lote sms", "enviar_url": { "url": "https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 } } }, "tecla_12": { "destino": "Desligar", "acao": "Apenas desligar", "opcoes_extras": { "adicionar_blacklist": 0 } }, "opcao_invalida": { "destino": "Desligar", "acao": "Desligar e remover prospect", "opcoes_extras": { "remover_prospect": 1, "adicionar_blacklist": 0, "executar_audio": "", "adicionar_lote": "lote invalida", "enviar_url": { "url": "https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]", "codificar": 1 } } }, "tempo_excedido": { "timeout": 10, "destino": "Adicionar ao lote", "acao": "AZURE TTS", "opcoes_extras": { "remover_prospect": 0, "adicionar_blacklist": 0, "executar_audio": "NOVO", "adicionar_lote": "", "enviar_url": { "url": "https://www.teste.com.br", "codificar": 1, "enviar_antes_do_audio": 1 } } }, "desliga_sem_opcao": { "destino": "SMS + Remover Prospect", "acao": "Texto SMS" } } ``` parameters: - name: Authorization in: header schema: type: string example: '{{token}}' - name: Content-Type in: header schema: type: string example: application/json requestBody: content: application/json: schema: type: object example: descricao: URA criada via API tipo: REV fila: '1' audio_inicial: - tipo: A audio: bemvindo dtmf: 1 - tipo: S bomdia: '4' boatarde: boatarde v2 boanoite: boanoite v2 - tipo: T tts: Nome Completo voz: Elza tecla_1: destino: Ramal acao: '6000' opcoes_extras: adicionar_blacklist: 1 tecla_2: destino: PABX acao: ipboxbina pabx: '1134567890' opcoes_extras: adicionar_blacklist: 1 tecla_3: destino: Fila acao: '15' opcoes_extras: adicionar_blacklist: 1 enviar_url: url: https://www.teste.com.br codificar: 1 tecla_4: destino: Grupo acao: GRUPO VENDAS opcoes_extras: adicionar_blacklist: 0 tecla_5: destino: Correio de Voz acao: '6000' opcoes_extras: adicionar_blacklist: 0 tecla_6: destino: URA acao: '6000' opcoes_extras: adicionar_blacklist: 0 tecla_7: destino: Audio acao: PROMOCAO opcoes_extras: remover_prospect: 0 adicionar_blacklist: 0 executar_audio: convite evento adicionar_lote: lote api enviar_url: url: https://www.teste.com.br?promo=1&nome=[nome] codificar: 1 enviar_antes_do_audio: 1 tecla_8: destino: Repetir mensagem acao: '2' tecla_9: destino: Adicionar ao lote acao: enriquecimento tts opcoes_extras: adicionar_blacklist: 0 tecla_10: destino: Receber contato por WhatsApp acao: texto confirmacao opcoes_extras: remover_prospect: 1 adicionar_blacklist: 0 executar_audio: confirma contato adicionar_lote: '' enviar_url: url: >- https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento] codificar: 1 enviar_whats_grupo: grupo de vendas tecla_11: destino: SMS acao: texto sms opcoes_extras: remover_prospect: 1 adicionar_blacklist: 0 executar_audio: '' adicionar_lote: lote sms enviar_url: url: >- https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento] codificar: 1 tecla_12: destino: Desligar acao: Apenas desligar opcoes_extras: adicionar_blacklist: 0 opcao_invalida: destino: Desligar acao: Desligar e remover prospect opcoes_extras: remover_prospect: 1 adicionar_blacklist: 0 executar_audio: '' adicionar_lote: lote invalida enviar_url: url: >- https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento] codificar: 1 tempo_excedido: timeout: 10 destino: Adicionar ao lote acao: AZURE TTS opcoes_extras: remover_prospect: 0 adicionar_blacklist: 0 executar_audio: NOVO adicionar_lote: '' enviar_url: url: https://www.teste.com.br codificar: 1 enviar_antes_do_audio: 1 desliga_sem_opcao: destino: SMS + Remover Prospect acao: Texto SMS responses: '200': description: Successful response content: application/json: {} components: securitySchemes: ApiToken: type: apiKey in: header name: Authorization description: >- Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo `Bearer ` / `Basic `. ````