Ativar webhook inbound do assistente
curl --request POST \
--url https://api.example.com/user/assistants/enable-inbound-webhook \
--header 'Content-Type: application/json' \
--data '
{
"assistant_id": 123,
"webhook_url": "<string>"
}
'import requests
url = "https://api.example.com/user/assistants/enable-inbound-webhook"
payload = {
"assistant_id": 123,
"webhook_url": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({assistant_id: 123, webhook_url: '<string>'})
};
fetch('https://api.example.com/user/assistants/enable-inbound-webhook', 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://api.example.com/user/assistants/enable-inbound-webhook",
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([
'assistant_id' => 123,
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/user/assistants/enable-inbound-webhook"
payload := strings.NewReader("{\n \"assistant_id\": 123,\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/user/assistants/enable-inbound-webhook")
.header("Content-Type", "application/json")
.body("{\n \"assistant_id\": 123,\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/user/assistants/enable-inbound-webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"assistant_id\": 123,\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Webhook inbound ativado com sucesso",
"data": []
}
{
"message": "Assistente não encontrado"
}
{
"message": "Os dados fornecidos são inválidos.",
"errors": {
"assistant_id": [
"O campo ID do assistente é obrigatório."
],
"webhook_url": [
"O campo URL do webhook é obrigatório."
]
}
}
Assistants
Ativar webhook inbound do assistente
Ativa as notificações de webhook para chamadas inbound de um assistente específico, passando a receber eventos de chamadas recebidas em tempo real.
POST
/
user
/
assistants
/
enable-inbound-webhook
Ativar webhook inbound do assistente
curl --request POST \
--url https://api.example.com/user/assistants/enable-inbound-webhook \
--header 'Content-Type: application/json' \
--data '
{
"assistant_id": 123,
"webhook_url": "<string>"
}
'import requests
url = "https://api.example.com/user/assistants/enable-inbound-webhook"
payload = {
"assistant_id": 123,
"webhook_url": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({assistant_id: 123, webhook_url: '<string>'})
};
fetch('https://api.example.com/user/assistants/enable-inbound-webhook', 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://api.example.com/user/assistants/enable-inbound-webhook",
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([
'assistant_id' => 123,
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/user/assistants/enable-inbound-webhook"
payload := strings.NewReader("{\n \"assistant_id\": 123,\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/user/assistants/enable-inbound-webhook")
.header("Content-Type", "application/json")
.body("{\n \"assistant_id\": 123,\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/user/assistants/enable-inbound-webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"assistant_id\": 123,\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Webhook inbound ativado com sucesso",
"data": []
}
{
"message": "Assistente não encontrado"
}
{
"message": "Os dados fornecidos são inválidos.",
"errors": {
"assistant_id": [
"O campo ID do assistente é obrigatório."
],
"webhook_url": [
"O campo URL do webhook é obrigatório."
]
}
}
Este endpoint ativa as notificações de webhook inbound de um assistente, permitindo o recebimento de atualizações em tempo real sobre conclusões de chamadas inbound e dados.
Corpo da Requisição
O ID do assistente para o qual o webhook será ativado
A URL para onde as notificações de webhook serão enviadas
Resposta
Mensagem de sucesso confirmando que o webhook foi ativado
Array vazio (reservado para uso futuro)
Respostas de Erro
404 Not Found
Show Resposta de Erro
Show Resposta de Erro
Mensagem de erro quando o assistente não é encontrado ou não pertence ao usuário autenticado
422 Validation Error
{
"message": "Webhook inbound ativado com sucesso",
"data": []
}
{
"message": "Assistente não encontrado"
}
{
"message": "Os dados fornecidos são inválidos.",
"errors": {
"assistant_id": [
"O campo ID do assistente é obrigatório."
],
"webhook_url": [
"O campo URL do webhook é obrigatório."
]
}
}
⌘I