Pular para o conteúdo principal

Visão Geral

Permita que seus agentes gerenciem operações de suporte ao cliente através do Zendesk. Crie e atualize tickets, gerencie usuários, monitore métricas de suporte e otimize seus fluxos de atendimento ao cliente com automação impulsionada por IA.

Pré-requisitos

Antes de usar a integração com o Zendesk, certifique-se de que você possui:

Configurando a Integração Zendesk

1. Conecte sua Conta Zendesk

  1. Acesse CrewAI AMP Integrações
  2. Encontre Zendesk na seção Integrações de Autenticação
  3. Clique em Conectar e complete o fluxo OAuth
  4. Conceda as permissões necessárias para gerenciamento de tickets e usuários
  5. Copie seu Token Enterprise em Configurações de Integração

2. Instale o Pacote Necessário

3. Configuração de variável de ambiente

Para usar integrações com Agent(apps=[]), você deve definir a variável de ambiente CREWAI_PLATFORM_INTEGRATION_TOKEN com seu Enterprise Token.
Ou adicione ao seu arquivo .env:

Ferramentas Disponíveis

Gerenciamento de Tickets

Descrição: Crie um novo ticket de suporte no Zendesk.Parâmetros:
  • ticketSubject (string, obrigatório): Assunto do ticket (ex.: “Socorro, minha impressora está pegando fogo!”)
  • ticketDescription (string, obrigatório): Primeiro comentário que aparece no ticket (ex.: “A fumaça é muito colorida.”)
  • requesterName (string, obrigatório): Nome do usuário solicitando suporte (ex.: “Jane Cliente”)
  • requesterEmail (string, obrigatório): E-mail do solicitante do suporte (ex.: “jane@example.com”)
  • assigneeId (string, opcional): ID do agente Zendesk atribuído ao ticket - Use as Configurações de Fluxo de Trabalho do Portal Connect para permitir a seleção do responsável
  • ticketType (string, opcional): Tipo de ticket - Opções: problem, incident, question, task
  • ticketPriority (string, opcional): Nível de prioridade - Opções: urgent, high, normal, low
  • ticketStatus (string, opcional): Status do ticket - Opções: new, open, pending, hold, solved, closed
  • ticketDueAt (string, opcional): Data de vencimento para tickets do tipo tarefa (timestamp ISO 8601)
  • ticketTags (string, opcional): Array de tags a aplicar (ex.: ["enterprise", "outra_tag"])
  • ticketExternalId (string, opcional): ID externo para vincular tickets a registros locais
  • ticketCustomFields (object, opcional): Valores de campos personalizados em formato JSON
Descrição: Atualize um ticket de suporte existente no Zendesk.Parâmetros:
  • ticketId (string, obrigatório): ID do ticket a ser atualizado (ex.: “35436”)
  • ticketSubject (string, opcional): Assunto atualizado do ticket
  • requesterName (string, obrigatório): Nome do solicitante deste ticket
  • requesterEmail (string, obrigatório): E-mail do solicitante deste ticket
  • assigneeId (string, opcional): ID atualizado do responsável - Use as Configurações de Fluxo de Trabalho do Portal Connect
  • ticketType (string, opcional): Tipo atualizado - Opções: problem, incident, question, task
  • ticketPriority (string, opcional): Prioridade atualizada - Opções: urgent, high, normal, low
  • ticketStatus (string, opcional): Status atualizado - Opções: new, open, pending, hold, solved, closed
  • ticketDueAt (string, opcional): Nova data de vencimento (timestamp ISO 8601)
  • ticketTags (string, opcional): Array de tags atualizadas
  • ticketExternalId (string, opcional): Novo ID externo
  • ticketCustomFields (object, opcional): Valores atualizados dos campos personalizados
Descrição: Recupere um ticket específico pelo ID.Parâmetros:
  • ticketId (string, obrigatório): ID do ticket a ser recuperado (ex.: “35436”)
Descrição: Adicione um comentário ou nota interna a um ticket existente.Parâmetros:
  • ticketId (string, obrigatório): ID do ticket para adicionar o comentário (ex.: “35436”)
  • commentBody (string, obrigatório): Mensagem do comentário (aceita texto simples ou HTML, ex.: “Obrigado pela sua ajuda!”)
  • isInternalNote (boolean, opcional): Defina como verdadeiro para notas internas ao invés de respostas públicas (padrão é falso)
  • isPublic (boolean, opcional): Verdadeiro para comentários públicos, falso para notas internas
Descrição: Busque tickets usando diversos filtros e critérios.Parâmetros:
  • ticketSubject (string, opcional): Filtrar pelo texto no assunto do ticket
  • ticketDescription (string, opcional): Filtrar por texto na descrição e comentários do ticket
  • ticketStatus (string, opcional): Filtrar por status - Opções: new, open, pending, hold, solved, closed
  • ticketType (string, opcional): Filtrar por tipo - Opções: problem, incident, question, task, no_type
  • ticketPriority (string, opcional): Filtrar por prioridade - Opções: urgent, high, normal, low, no_priority
  • requesterId (string, opcional): Filtrar por ID do solicitante
  • assigneeId (string, opcional): Filtrar pelo ID do agente responsável
  • recipientEmail (string, opcional): Filtrar pelo e-mail do destinatário original
  • ticketTags (string, opcional): Filtrar por tags do ticket
  • ticketExternalId (string, opcional): Filtrar por ID externo
  • createdDate (object, opcional): Filtrar por data de criação com operador (EQUALS, LESS_THAN_EQUALS, GREATER_THAN_EQUALS) e valor
  • updatedDate (object, opcional): Filtrar por data de atualização com operador e valor
  • dueDate (object, opcional): Filtrar por data de vencimento com operador e valor
  • sort_by (string, opcional): Campo de ordenação - Opções: created_at, updated_at, priority, status, ticket_type
  • sort_order (string, opcional): Direção da ordenação - Opções: asc, desc

Gerenciamento de Usuários

Descrição: Crie um novo usuário no Zendesk.Parâmetros:
  • name (string, obrigatório): Nome completo do usuário
  • email (string, opcional): E-mail do usuário (ex.: “jane@example.com”)
  • phone (string, opcional): Telefone do usuário
  • role (string, opcional): Papel do usuário - Opções: admin, agent, end-user
  • externalId (string, opcional): Identificador único de outro sistema
  • details (string, opcional): Detalhes adicionais do usuário
  • notes (string, opcional): Notas internas sobre o usuário
Descrição: Atualize informações de um usuário existente.Parâmetros:
  • userId (string, obrigatório): ID do usuário a ser atualizado
  • name (string, opcional): Nome atualizado do usuário
  • email (string, opcional): Novo e-mail (adicionado como e-mail secundário na atualização)
  • phone (string, opcional): Novo telefone
  • role (string, opcional): Novo papel - Opções: admin, agent, end-user
  • externalId (string, opcional): Novo ID externo
  • details (string, opcional): Novos detalhes do usuário
  • notes (string, opcional): Novas notas internas
Descrição: Recupere um usuário específico pelo ID.Parâmetros:
  • userId (string, obrigatório): ID do usuário a ser recuperado
Descrição: Busque usuários utilizando vários critérios.Parâmetros:
  • name (string, opcional): Filtrar por nome do usuário
  • email (string, opcional): Filtrar por e-mail do usuário (ex.: “jane@example.com”)
  • role (string, opcional): Filtrar por papel - Opções: admin, agent, end-user
  • externalId (string, opcional): Filtrar por ID externo
  • sort_by (string, opcional): Campo de ordenação - Opções: created_at, updated_at
  • sort_order (string, opcional): Direção de ordenação - Opções: asc, desc

Ferramentas Administrativas

Descrição: Recupere todos os campos padrão e personalizados disponíveis para tickets.Parâmetros:
  • paginationParameters (object, opcional): Configurações de paginação
    • pageCursor (string, opcional): Cursor de página para paginação
Descrição: Obtenha registros de auditoria (histórico somente leitura) dos tickets.Parâmetros:
  • ticketId (string, opcional): Obtenha auditorias para um ticket específico (se vazio, recupera auditorias de todos os tickets não arquivados, ex.: “1234”)
  • paginationParameters (object, opcional): Configurações de paginação
    • pageCursor (string, opcional): Cursor de página para paginação

Campos Personalizados

Campos personalizados permitem armazenar informações adicionais específicas para sua organização:

Níveis de Prioridade dos Tickets

Compreendendo os níveis de prioridade:
  • urgent - Questões críticas que exigem atenção imediata
  • high - Questões importantes que devem ser tratadas rapidamente
  • normal - Prioridade padrão para a maioria dos tickets
  • low - Questões menores que podem ser tratadas quando conveniente

Fluxo de Status dos Tickets

Progresso padrão de status dos tickets:
  • new - Recém-criado, ainda não atribuído
  • open - Em andamento
  • pending - Aguardando resposta do cliente ou ação externa
  • hold - Pausa temporária
  • solved - Problema resolvido, aguardando confirmação do cliente
  • closed - Ticket finalizado e fechado

Exemplos de Uso

Configuração Básica de Agente Zendesk

Filtrando Ferramentas Zendesk Específicas

Gerenciamento Avançado de Tickets

Análise e Relatórios de Suporte