criarUra
curl --request POST \
--url https://{baseUrl}/ipbox/api/criarUra \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
}
'import requests
url = "https://{baseUrl}/ipbox/api/criarUra"
payload = {
"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"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
})
};
fetch('https://{baseUrl}/ipbox/api/criarUra', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{baseUrl}/ipbox/api/criarUra",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{baseUrl}/ipbox/api/criarUra"
payload := strings.NewReader("{\n \"descricao\": \"URA criada via API\",\n \"tipo\": \"REV\",\n \"fila\": \"1\",\n \"audio_inicial\": [\n {\n \"tipo\": \"A\",\n \"audio\": \"bemvindo\",\n \"dtmf\": 1\n },\n {\n \"tipo\": \"S\",\n \"bomdia\": \"4\",\n \"boatarde\": \"boatarde v2\",\n \"boanoite\": \"boanoite v2\"\n },\n {\n \"tipo\": \"T\",\n \"tts\": \"Nome Completo\",\n \"voz\": \"Elza\"\n }\n ],\n \"tecla_1\": {\n \"destino\": \"Ramal\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_2\": {\n \"destino\": \"PABX\",\n \"acao\": \"ipboxbina\",\n \"pabx\": \"1134567890\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_3\": {\n \"destino\": \"Fila\",\n \"acao\": \"15\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1,\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_4\": {\n \"destino\": \"Grupo\",\n \"acao\": \"GRUPO VENDAS\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_5\": {\n \"destino\": \"Correio de Voz\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_6\": {\n \"destino\": \"URA\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_7\": {\n \"destino\": \"Audio\",\n \"acao\": \"PROMOCAO\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"convite evento\",\n \"adicionar_lote\": \"lote api\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br?promo=1&nome=[nome]\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"tecla_8\": {\n \"destino\": \"Repetir mensagem\",\n \"acao\": \"2\"\n },\n \"tecla_9\": {\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"enriquecimento tts\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_10\": {\n \"destino\": \"Receber contato por WhatsApp\",\n \"acao\": \"texto confirmacao\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"confirma contato\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n },\n \"enviar_whats_grupo\": \"grupo de vendas\"\n }\n },\n \"tecla_11\": {\n \"destino\": \"SMS\",\n \"acao\": \"texto sms\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote sms\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_12\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Apenas desligar\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"opcao_invalida\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Desligar e remover prospect\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote invalida\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tempo_excedido\": {\n \"timeout\": 10,\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"AZURE TTS\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"NOVO\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"desliga_sem_opcao\": {\n \"destino\": \"SMS + Remover Prospect\",\n \"acao\": \"Texto SMS\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{baseUrl}/ipbox/api/criarUra")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"descricao\": \"URA criada via API\",\n \"tipo\": \"REV\",\n \"fila\": \"1\",\n \"audio_inicial\": [\n {\n \"tipo\": \"A\",\n \"audio\": \"bemvindo\",\n \"dtmf\": 1\n },\n {\n \"tipo\": \"S\",\n \"bomdia\": \"4\",\n \"boatarde\": \"boatarde v2\",\n \"boanoite\": \"boanoite v2\"\n },\n {\n \"tipo\": \"T\",\n \"tts\": \"Nome Completo\",\n \"voz\": \"Elza\"\n }\n ],\n \"tecla_1\": {\n \"destino\": \"Ramal\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_2\": {\n \"destino\": \"PABX\",\n \"acao\": \"ipboxbina\",\n \"pabx\": \"1134567890\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_3\": {\n \"destino\": \"Fila\",\n \"acao\": \"15\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1,\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_4\": {\n \"destino\": \"Grupo\",\n \"acao\": \"GRUPO VENDAS\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_5\": {\n \"destino\": \"Correio de Voz\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_6\": {\n \"destino\": \"URA\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_7\": {\n \"destino\": \"Audio\",\n \"acao\": \"PROMOCAO\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"convite evento\",\n \"adicionar_lote\": \"lote api\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br?promo=1&nome=[nome]\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"tecla_8\": {\n \"destino\": \"Repetir mensagem\",\n \"acao\": \"2\"\n },\n \"tecla_9\": {\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"enriquecimento tts\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_10\": {\n \"destino\": \"Receber contato por WhatsApp\",\n \"acao\": \"texto confirmacao\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"confirma contato\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n },\n \"enviar_whats_grupo\": \"grupo de vendas\"\n }\n },\n \"tecla_11\": {\n \"destino\": \"SMS\",\n \"acao\": \"texto sms\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote sms\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_12\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Apenas desligar\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"opcao_invalida\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Desligar e remover prospect\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote invalida\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tempo_excedido\": {\n \"timeout\": 10,\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"AZURE TTS\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"NOVO\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"desliga_sem_opcao\": {\n \"destino\": \"SMS + Remover Prospect\",\n \"acao\": \"Texto SMS\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/criarUra")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"descricao\": \"URA criada via API\",\n \"tipo\": \"REV\",\n \"fila\": \"1\",\n \"audio_inicial\": [\n {\n \"tipo\": \"A\",\n \"audio\": \"bemvindo\",\n \"dtmf\": 1\n },\n {\n \"tipo\": \"S\",\n \"bomdia\": \"4\",\n \"boatarde\": \"boatarde v2\",\n \"boanoite\": \"boanoite v2\"\n },\n {\n \"tipo\": \"T\",\n \"tts\": \"Nome Completo\",\n \"voz\": \"Elza\"\n }\n ],\n \"tecla_1\": {\n \"destino\": \"Ramal\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_2\": {\n \"destino\": \"PABX\",\n \"acao\": \"ipboxbina\",\n \"pabx\": \"1134567890\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_3\": {\n \"destino\": \"Fila\",\n \"acao\": \"15\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1,\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_4\": {\n \"destino\": \"Grupo\",\n \"acao\": \"GRUPO VENDAS\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_5\": {\n \"destino\": \"Correio de Voz\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_6\": {\n \"destino\": \"URA\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_7\": {\n \"destino\": \"Audio\",\n \"acao\": \"PROMOCAO\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"convite evento\",\n \"adicionar_lote\": \"lote api\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br?promo=1&nome=[nome]\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"tecla_8\": {\n \"destino\": \"Repetir mensagem\",\n \"acao\": \"2\"\n },\n \"tecla_9\": {\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"enriquecimento tts\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_10\": {\n \"destino\": \"Receber contato por WhatsApp\",\n \"acao\": \"texto confirmacao\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"confirma contato\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n },\n \"enviar_whats_grupo\": \"grupo de vendas\"\n }\n },\n \"tecla_11\": {\n \"destino\": \"SMS\",\n \"acao\": \"texto sms\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote sms\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_12\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Apenas desligar\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"opcao_invalida\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Desligar e remover prospect\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote invalida\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tempo_excedido\": {\n \"timeout\": 10,\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"AZURE TTS\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"NOVO\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"desliga_sem_opcao\": {\n \"destino\": \"SMS + Remover Prospect\",\n \"acao\": \"Texto SMS\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"ura_id": 42,
"descricao": "URA criada via API"
}
}URAs
criarUra
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).
- Tecla inválida (
Estrutura raiz
{
"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.
"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.
"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.
"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.
"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.
"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.
"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.
"desliga_sem_opcao": {
"destino": "SMS + Remover Prospect",
"acao": "Texto SMS"
}
Exemplo mínimo
{
"descricao": "URA criada via API",
"tipo": "REC",
"audio_inicial": [
{
"tipo": "A",
"audio": "1",
"dtmf": 1
}
],
"tecla_1": {
"destino": "Ramal",
"acao": "6000"
}
}
Um exemplo completo, com todas as teclas e opções acima em uso, está disponível no exemplo do corpo da requisição deste endpoint (abaixo).
Atenção: se os dados enviados forem estruturalmente válidos mas o conteúdo falhar numa validação de negócio (ex.: áudio/lote/grupo referenciado não existe), a resposta vem com status HTTP 200 e corpo {"status": "error", "message": "..."} — não com HTTP 409 como as demais falhas desta API. Sempre confira o campo status do corpo da resposta, não só o código HTTP.
POST
/
ipbox
/
api
/
criarUra
criarUra
curl --request POST \
--url https://{baseUrl}/ipbox/api/criarUra \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
}
'import requests
url = "https://{baseUrl}/ipbox/api/criarUra"
payload = {
"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"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
})
};
fetch('https://{baseUrl}/ipbox/api/criarUra', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{baseUrl}/ipbox/api/criarUra",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{baseUrl}/ipbox/api/criarUra"
payload := strings.NewReader("{\n \"descricao\": \"URA criada via API\",\n \"tipo\": \"REV\",\n \"fila\": \"1\",\n \"audio_inicial\": [\n {\n \"tipo\": \"A\",\n \"audio\": \"bemvindo\",\n \"dtmf\": 1\n },\n {\n \"tipo\": \"S\",\n \"bomdia\": \"4\",\n \"boatarde\": \"boatarde v2\",\n \"boanoite\": \"boanoite v2\"\n },\n {\n \"tipo\": \"T\",\n \"tts\": \"Nome Completo\",\n \"voz\": \"Elza\"\n }\n ],\n \"tecla_1\": {\n \"destino\": \"Ramal\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_2\": {\n \"destino\": \"PABX\",\n \"acao\": \"ipboxbina\",\n \"pabx\": \"1134567890\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_3\": {\n \"destino\": \"Fila\",\n \"acao\": \"15\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1,\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_4\": {\n \"destino\": \"Grupo\",\n \"acao\": \"GRUPO VENDAS\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_5\": {\n \"destino\": \"Correio de Voz\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_6\": {\n \"destino\": \"URA\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_7\": {\n \"destino\": \"Audio\",\n \"acao\": \"PROMOCAO\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"convite evento\",\n \"adicionar_lote\": \"lote api\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br?promo=1&nome=[nome]\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"tecla_8\": {\n \"destino\": \"Repetir mensagem\",\n \"acao\": \"2\"\n },\n \"tecla_9\": {\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"enriquecimento tts\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_10\": {\n \"destino\": \"Receber contato por WhatsApp\",\n \"acao\": \"texto confirmacao\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"confirma contato\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n },\n \"enviar_whats_grupo\": \"grupo de vendas\"\n }\n },\n \"tecla_11\": {\n \"destino\": \"SMS\",\n \"acao\": \"texto sms\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote sms\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_12\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Apenas desligar\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"opcao_invalida\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Desligar e remover prospect\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote invalida\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tempo_excedido\": {\n \"timeout\": 10,\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"AZURE TTS\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"NOVO\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"desliga_sem_opcao\": {\n \"destino\": \"SMS + Remover Prospect\",\n \"acao\": \"Texto SMS\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{baseUrl}/ipbox/api/criarUra")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"descricao\": \"URA criada via API\",\n \"tipo\": \"REV\",\n \"fila\": \"1\",\n \"audio_inicial\": [\n {\n \"tipo\": \"A\",\n \"audio\": \"bemvindo\",\n \"dtmf\": 1\n },\n {\n \"tipo\": \"S\",\n \"bomdia\": \"4\",\n \"boatarde\": \"boatarde v2\",\n \"boanoite\": \"boanoite v2\"\n },\n {\n \"tipo\": \"T\",\n \"tts\": \"Nome Completo\",\n \"voz\": \"Elza\"\n }\n ],\n \"tecla_1\": {\n \"destino\": \"Ramal\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_2\": {\n \"destino\": \"PABX\",\n \"acao\": \"ipboxbina\",\n \"pabx\": \"1134567890\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_3\": {\n \"destino\": \"Fila\",\n \"acao\": \"15\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1,\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_4\": {\n \"destino\": \"Grupo\",\n \"acao\": \"GRUPO VENDAS\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_5\": {\n \"destino\": \"Correio de Voz\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_6\": {\n \"destino\": \"URA\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_7\": {\n \"destino\": \"Audio\",\n \"acao\": \"PROMOCAO\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"convite evento\",\n \"adicionar_lote\": \"lote api\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br?promo=1&nome=[nome]\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"tecla_8\": {\n \"destino\": \"Repetir mensagem\",\n \"acao\": \"2\"\n },\n \"tecla_9\": {\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"enriquecimento tts\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_10\": {\n \"destino\": \"Receber contato por WhatsApp\",\n \"acao\": \"texto confirmacao\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"confirma contato\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n },\n \"enviar_whats_grupo\": \"grupo de vendas\"\n }\n },\n \"tecla_11\": {\n \"destino\": \"SMS\",\n \"acao\": \"texto sms\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote sms\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_12\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Apenas desligar\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"opcao_invalida\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Desligar e remover prospect\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote invalida\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tempo_excedido\": {\n \"timeout\": 10,\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"AZURE TTS\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"NOVO\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"desliga_sem_opcao\": {\n \"destino\": \"SMS + Remover Prospect\",\n \"acao\": \"Texto SMS\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/criarUra")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"descricao\": \"URA criada via API\",\n \"tipo\": \"REV\",\n \"fila\": \"1\",\n \"audio_inicial\": [\n {\n \"tipo\": \"A\",\n \"audio\": \"bemvindo\",\n \"dtmf\": 1\n },\n {\n \"tipo\": \"S\",\n \"bomdia\": \"4\",\n \"boatarde\": \"boatarde v2\",\n \"boanoite\": \"boanoite v2\"\n },\n {\n \"tipo\": \"T\",\n \"tts\": \"Nome Completo\",\n \"voz\": \"Elza\"\n }\n ],\n \"tecla_1\": {\n \"destino\": \"Ramal\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_2\": {\n \"destino\": \"PABX\",\n \"acao\": \"ipboxbina\",\n \"pabx\": \"1134567890\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1\n }\n },\n \"tecla_3\": {\n \"destino\": \"Fila\",\n \"acao\": \"15\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 1,\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_4\": {\n \"destino\": \"Grupo\",\n \"acao\": \"GRUPO VENDAS\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_5\": {\n \"destino\": \"Correio de Voz\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_6\": {\n \"destino\": \"URA\",\n \"acao\": \"6000\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_7\": {\n \"destino\": \"Audio\",\n \"acao\": \"PROMOCAO\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"convite evento\",\n \"adicionar_lote\": \"lote api\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br?promo=1&nome=[nome]\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"tecla_8\": {\n \"destino\": \"Repetir mensagem\",\n \"acao\": \"2\"\n },\n \"tecla_9\": {\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"enriquecimento tts\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"tecla_10\": {\n \"destino\": \"Receber contato por WhatsApp\",\n \"acao\": \"texto confirmacao\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"confirma contato\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.cliente.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n },\n \"enviar_whats_grupo\": \"grupo de vendas\"\n }\n },\n \"tecla_11\": {\n \"destino\": \"SMS\",\n \"acao\": \"texto sms\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote sms\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tecla_12\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Apenas desligar\",\n \"opcoes_extras\": {\n \"adicionar_blacklist\": 0\n }\n },\n \"opcao_invalida\": {\n \"destino\": \"Desligar\",\n \"acao\": \"Desligar e remover prospect\",\n \"opcoes_extras\": {\n \"remover_prospect\": 1,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"\",\n \"adicionar_lote\": \"lote invalida\",\n \"enviar_url\": {\n \"url\": \"https://meucrm.com.br?redial=1&prospect=[nome]&telefone=[numero_em_atendimento]\",\n \"codificar\": 1\n }\n }\n },\n \"tempo_excedido\": {\n \"timeout\": 10,\n \"destino\": \"Adicionar ao lote\",\n \"acao\": \"AZURE TTS\",\n \"opcoes_extras\": {\n \"remover_prospect\": 0,\n \"adicionar_blacklist\": 0,\n \"executar_audio\": \"NOVO\",\n \"adicionar_lote\": \"\",\n \"enviar_url\": {\n \"url\": \"https://www.teste.com.br\",\n \"codificar\": 1,\n \"enviar_antes_do_audio\": 1\n }\n }\n },\n \"desliga_sem_opcao\": {\n \"destino\": \"SMS + Remover Prospect\",\n \"acao\": \"Texto SMS\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"ura_id": 42,
"descricao": "URA criada via API"
}
}Authorizations
Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo Bearer / Basic.
Body
application/json
The body is of type object.
Response
Requisição aceita — confira o campo status no corpo: "success" (URA criada) ou "error" (dados aceitos, mas reprovados numa validação de negócio; veja message).