Obter assistentes outbound

curl --request GET \
  --url https://api.example.com/user/assistants/outbound

import requests

url = "https://api.example.com/user/assistants/outbound"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/user/assistants/outbound', 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/outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/user/assistants/outbound"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/user/assistants/outbound")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/user/assistants/outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "id": 123,
    "user_id": 1,
    "name": "Assistente de Vendas Outbound",
    "type": "outbound",
    "mode": "pipeline",
    "status": "active",
    "voice_id": 8,
    "language_id": 1,
    "timezone": "America/New_York",
    "initial_message": "Olá, aqui é a Sarah da Sua Empresa. Espero estar ligando em um bom momento. Como você está hoje?",
    "system_prompt": "Você é um representante de vendas da Sua Empresa. Seja profissional, cordial e foque na qualificação de leads.",
    "variables": {
      "company_name": "Sua Empresa",
      "product_line": "Serviços Premium"
    },
    "webhook_url": "https://omnitechsolucoes.com.br/api/webhooks/outbound-calls",
    "is_webhook_active": true,
    "created_at": "2025-07-15T14:32:15.000000Z",
    "updated_at": "2025-08-02T09:18:42.000000Z"
  },
  {
    "id": 124,
    "user_id": 1,
    "name": "Assistente de Follow-up",
    "type": "outbound",
    "mode": "multimodal",
    "status": "inactive",
    "voice_id": 12,
    "language_id": 1,
    "timezone": "America/Los_Angeles",
    "initial_message": "Olá! Estou ligando para dar continuidade à nossa conversa anterior. Você teria alguns minutos para conversarmos?",
    "system_prompt": "Você é um especialista em follow-up. Seja cordial e profissional enquanto coleta feedbacks e próximos passos.",
    "variables": {
      "purpose": "follow_up",
      "max_duration": "5_minutes"
    },
    "webhook_url": null,
    "is_webhook_active": false,
    "created_at": "2025-07-20T10:15:30.000000Z",
    "updated_at": "2025-07-25T16:45:22.000000Z"
  }
]

GET

user

assistants

outbound

Obter assistentes outbound

curl --request GET \
  --url https://api.example.com/user/assistants/outbound

import requests

url = "https://api.example.com/user/assistants/outbound"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/user/assistants/outbound', 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/outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/user/assistants/outbound"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/user/assistants/outbound")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/user/assistants/outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "id": 123,
    "user_id": 1,
    "name": "Assistente de Vendas Outbound",
    "type": "outbound",
    "mode": "pipeline",
    "status": "active",
    "voice_id": 8,
    "language_id": 1,
    "timezone": "America/New_York",
    "initial_message": "Olá, aqui é a Sarah da Sua Empresa. Espero estar ligando em um bom momento. Como você está hoje?",
    "system_prompt": "Você é um representante de vendas da Sua Empresa. Seja profissional, cordial e foque na qualificação de leads.",
    "variables": {
      "company_name": "Sua Empresa",
      "product_line": "Serviços Premium"
    },
    "webhook_url": "https://omnitechsolucoes.com.br/api/webhooks/outbound-calls",
    "is_webhook_active": true,
    "created_at": "2025-07-15T14:32:15.000000Z",
    "updated_at": "2025-08-02T09:18:42.000000Z"
  },
  {
    "id": 124,
    "user_id": 1,
    "name": "Assistente de Follow-up",
    "type": "outbound",
    "mode": "multimodal",
    "status": "inactive",
    "voice_id": 12,
    "language_id": 1,
    "timezone": "America/Los_Angeles",
    "initial_message": "Olá! Estou ligando para dar continuidade à nossa conversa anterior. Você teria alguns minutos para conversarmos?",
    "system_prompt": "Você é um especialista em follow-up. Seja cordial e profissional enquanto coleta feedbacks e próximos passos.",
    "variables": {
      "purpose": "follow_up",
      "max_duration": "5_minutes"
    },
    "webhook_url": null,
    "is_webhook_active": false,
    "created_at": "2025-07-20T10:15:30.000000Z",
    "updated_at": "2025-07-25T16:45:22.000000Z"
  }
]

Este endpoint retorna uma lista de todos os assistentes outbound pertencentes ao usuário autenticado. Assistentes outbound são utilizados para realizar chamadas para leads e prospects.

Campos da Resposta

data

array

Show propriedades

integer

Identificador único do assistente

user_id

integer

ID do usuário proprietário do assistente

name

string

Nome do assistente

type

string

Tipo do assistente (sempre “outbound” para este endpoint)

mode

string

Modo da engine (pipeline ou multimodal)

status

string

Status atual do assistente

voice_id

integer

ID da voz utilizada pelo assistente

language_id

integer

ID do idioma utilizado pelo assistente

timezone

string

Configuração de fuso horário do assistente

initial_message

string

Mensagem inicial que o assistente irá falar

system_prompt

string

Prompt de sistema que define o comportamento do assistente

variables

object

Variáveis personalizadas definidas para o assistente

webhook_url

string

URL do webhook para notificações pós-chamada

is_webhook_active

boolean

Indica se as notificações de webhook estão habilitadas

created_at

string

Data e hora de criação do assistente

updated_at

string

Data e hora da última atualização do assistente

[
  {
    "id": 123,
    "user_id": 1,
    "name": "Assistente de Vendas Outbound",
    "type": "outbound",
    "mode": "pipeline",
    "status": "active",
    "voice_id": 8,
    "language_id": 1,
    "timezone": "America/New_York",
    "initial_message": "Olá, aqui é a Sarah da Sua Empresa. Espero estar ligando em um bom momento. Como você está hoje?",
    "system_prompt": "Você é um representante de vendas da Sua Empresa. Seja profissional, cordial e foque na qualificação de leads.",
    "variables": {
      "company_name": "Sua Empresa",
      "product_line": "Serviços Premium"
    },
    "webhook_url": "https://omnitechsolucoes.com.br/api/webhooks/outbound-calls",
    "is_webhook_active": true,
    "created_at": "2025-07-15T14:32:15.000000Z",
    "updated_at": "2025-08-02T09:18:42.000000Z"
  },
  {
    "id": 124,
    "user_id": 1,
    "name": "Assistente de Follow-up",
    "type": "outbound",
    "mode": "multimodal",
    "status": "inactive",
    "voice_id": 12,
    "language_id": 1,
    "timezone": "America/Los_Angeles",
    "initial_message": "Olá! Estou ligando para dar continuidade à nossa conversa anterior. Você teria alguns minutos para conversarmos?",
    "system_prompt": "Você é um especialista em follow-up. Seja cordial e profissional enquanto coleta feedbacks e próximos passos.",
    "variables": {
      "purpose": "follow_up",
      "max_duration": "5_minutes"
    },
    "webhook_url": null,
    "is_webhook_active": false,
    "created_at": "2025-07-20T10:15:30.000000Z",
    "updated_at": "2025-07-25T16:45:22.000000Z"
  }
]

Observações Este endpoint retorna apenas assistentes do tipo “outbound” Todos os assistentes pertencentes ao usuário autenticado são retornados (sem paginação) Utilize esses assistentes em conjunto com o endpoint de realização de chamadas para iniciar chamadas outbound Assistentes outbound podem ser utilizados para vendas, follow-ups, pesquisas e outros cenários de chamadas ativas

Listar assistentes

Criar assistente

Referência da API

Assistants

Calls

Mid Call Tools

Leads

Campaigns

SMS

Webhooks

Obter assistentes outbound

Campos da Resposta

​Campos da Resposta

Campos da Resposta