Pular para o conteúdo principal
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"

{
  "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

​
agent
string
obrigatório
O identificador único do agente. Você pode encontrá-lo na lista de agentes.

​
Cabeçalhos da requisição

​
Authorization
string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

​
Parâmetros de consulta

​
type
string
Filtrar por tipo de ação. Opções: webhook, transfer, hold
​
per_page
integer
Número de itens por página (padrão: 20, máximo: 100)
​
page
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 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"

​
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

​
success
boolean
obrigatório
Indica se a operação foi bem-sucedida.
​
data
array
obrigatório
Array de objetos de ação.
​
pagination
object
obrigatório
Metadados 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ódigoDescriçãoStatus HTTP
AGENT_NOT_FOUNDAgente especificado não existe404
VALIDATION_ERRORValidação dos parâmetros de consulta falhou422
INVALID_TOKENToken de autenticação inválido ou ausente401
SERVER_ERRORErro interno do servidor ocorreu500

​
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

  1. Use paginação - Sempre use paginação para grandes conjuntos de dados
  2. Filtre por tipo - Use filtros de tipo para encontrar ações específicas
  3. Monitore status - Verifique se as ações estão ativas quando necessário
  4. Teste configurações - Sempre teste as configurações de ações antes de usar em produção
  5. 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