# Requisição 1: Obter todas as ações de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as ações de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": [
{
"id": "action-uuid-1",
"type": "webhook",
"name": "Webhook de Notificação",
"description": "Envia notificação para sistema externo",
"config": {
"url": "https://api.example.com/webhook",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer webhook-token"
}
},
"is_active": true,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "action-uuid-2",
"type": "transfer",
"name": "Transferência para Supervisor",
"description": "Transfere chamada para supervisor quando necessário",
"config": {
"phone_number": "+5511987654321",
"transfer_message": "Transferindo para supervisor"
},
"is_active": true,
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 2,
"per_page": 20,
"total": 30,
"from": 1,
"to": 20
}
}
Ações
Listar Ações
Recuperar uma lista de ações para um agente específico
GET
/
api
/
v1
/
agents
/
{agent_id}
/
actions
# Requisição 1: Obter todas as ações de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as ações de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": [
{
"id": "action-uuid-1",
"type": "webhook",
"name": "Webhook de Notificação",
"description": "Envia notificação para sistema externo",
"config": {
"url": "https://api.example.com/webhook",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer webhook-token"
}
},
"is_active": true,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "action-uuid-2",
"type": "transfer",
"name": "Transferência para Supervisor",
"description": "Transfere chamada para supervisor quando necessário",
"config": {
"phone_number": "+5511987654321",
"transfer_message": "Transferindo para supervisor"
},
"is_active": true,
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 2,
"per_page": 20,
"total": 30,
"from": 1,
"to": 20
}
}
Listar Ações
Recuperar uma lista de ações configuradas para um agente específico com suporte à paginação.Endpoint
GET /api/v1/agents/{agent_id}/actions
Parâmetros de caminho
string
obrigatório
O identificador único do agente. Você pode encontrá-lo na lista de agentes.
Cabeçalhos da requisição
string
obrigatório
Token Bearer para autenticação. Formato:
Bearer talq_your_environment_token_hereParâmetros de consulta
string
Filtrar por tipo de ação. Opções:
webhook, transfer, holdinteger
Número de itens por página (padrão: 20, máximo: 100)
integer
Número da página (padrão: 1)
Exemplos de Requisição
# Requisição 1: Obter todas as ações de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todas as ações de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Filtrar por tipo de ação
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions?type=webhook&per_page=50" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Filtrar por tipo de ação
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/actions?type=webhook&per_page=50', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
Resposta
Resposta de Sucesso (200 OK)
{
"success": true,
"data": [
{
"id": "action-uuid-1",
"type": "webhook",
"name": "Webhook de Notificação",
"description": "Envia notificação para sistema externo",
"config": {
"url": "https://api.example.com/webhook",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer webhook-token"
}
},
"is_active": true,
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "action-uuid-2",
"type": "transfer",
"name": "Transferência para Supervisor",
"description": "Transfere chamada para supervisor quando necessário",
"config": {
"phone_number": "+5511987654321",
"transfer_message": "Transferindo para supervisor"
},
"is_active": true,
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 2,
"per_page": 20,
"total": 30,
"from": 1,
"to": 20
}
}
Campos da Resposta
boolean
obrigatório
Indica se a operação foi bem-sucedida.
array
obrigatório
Array de objetos de ação.
Mostrar Objeto de Ação
Mostrar Objeto de Ação
string
obrigatório
Identificador único da ação.
string
obrigatório
Tipo da ação. Opções:
webhook, transfer, hold.string
obrigatório
Nome da ação.
string
Descrição da ação.
object
obrigatório
Configuração específica da ação.
Mostrar Configuração de Webhook
Mostrar Configuração de Webhook
Mostrar Configuração de Transferência
Mostrar Configuração de Transferência
boolean
obrigatório
Se a ação está ativa.
string
obrigatório
Timestamp ISO 8601 quando a ação foi criada.
string
obrigatório
Timestamp ISO 8601 quando a ação foi atualizada pela última vez.
object
obrigatório
Metadados de paginação.
Mostrar Objeto de Paginação
Mostrar Objeto de Paginação
Respostas de erro
404 Não Encontrado
{
"success": false,
"message": "Agent not found"
}
422 Erro de Validação
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"type": [
"The selected type is invalid."
]
}
}
401 Não Autorizado
{
"success": false,
"message": "Unauthorized"
}
500 Erro do Servidor
{
"success": false,
"message": "Internal server error."
}
Códigos de erro
| Código | Descrição | Status HTTP |
|---|---|---|
AGENT_NOT_FOUND | Agente especificado não existe | 404 |
VALIDATION_ERROR | Validação dos parâmetros de consulta falhou | 422 |
INVALID_TOKEN | Token de autenticação inválido ou ausente | 401 |
SERVER_ERROR | Erro interno do servidor ocorreu | 500 |
Notas Importantes
Tipos de ação. As ações podem ser webhooks, transferências ou pausas.
Configurações específicas. Cada tipo de ação tem sua própria configuração.
Status ativo. Ações podem ser ativadas ou desativadas conforme necessário.
Suporte à paginação. Use parâmetros
page e per_page para navegar pelos resultados.Melhores Práticas
- Use paginação - Sempre use paginação para grandes conjuntos de dados
- Filtre por tipo - Use filtros de tipo para encontrar ações específicas
- Monitore status - Verifique se as ações estão ativas quando necessário
- Teste configurações - Sempre teste as configurações de ações antes de usar em produção
- Documente ações - Mantenha descrições claras para cada ação
Endpoints relacionados
- Criar/Atualizar Ação:
POST /api/v1/agents/{agent_id}/actions - Excluir Ação:
DELETE /api/v1/agents/{agent_id}/actions/{action_id} - Obter Agente:
GET /api/v1/agents/{agent_id} - Listar Agentes:
GET /api/v1/agents
Esta página foi útil?