Jump to Content
Referência da API (V1.0)
v1.0
v2.0
Log In
Referência da API (V1.0)
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Referência da API (V1.0)
Gerar token
Search
JUMP TO
Autenticação
Gerar token
post
Renovar token
post
SDK API sync
Como instalar o plugin no seu sistema
*Agentes
Alterar status do agente logado
patch
Consultar status de um agente
get
Deslogar um agente
post
Encerrar pausa do agente
post
Listar agentes
get
Listar agentes aptos para receber transferência
get
Listar agentes de uma fila de atendimento
get
Solicitar pausa para um agente
post
*Campanhas
Adicionar campanha
post
Listar campanhas
get
Interromper campanha
post
*Canais de atendimento
Listar caixas de e-mail
get
Listar canais de atendimento
get
Listar canais de SMS
get
Listar canais do Instagram
get
Listar canais do Messenger
get
Listar canais do Telegram
get
Listar canais do WhatsApp
get
*Catálogos
Listar catálogos
get
Listar anexos dos catálogos
get
*Classificações de e-mail
Listar classificações de e-mail
get
*Classificações de telefone
Listar classificações de telefone
get
*Clientes
Adicionar cliente
post
Adicionar e-mail na lista de bloqueio
post
Adicionar e-mail para um cliente
post
Adicionar telefone na lista de bloqueio
post
Adicionar telefone para um cliente
post
Atualizar classificações dos e-mails de um cliente
patch
Atualizar classificações dos telefones de um cliente
patch
Atualizar cliente
put
Listar campos customizáveis de um cliente
get
Listar clientes
get
Listar e-mails de um cliente
get
Listar telefones de um cliente
get
*Filiais
Listar filiais
get
*Hashtags
Listar hashtags
get
*Idiomas
Listar idiomas
get
*Maillings
Adicionar mailling usando arquivo
post
Atualizar mailing
patch
Download do arquivo modelo
get
Listar maillings
get
*ORGANIZAÇÕES
Listar organizações
get
Pausas (DEPRECATED)
Listar pausas
get
PESQUISAS (DEPRECATED)
Disparar uma pesquisa para um cliente
post
Listar pesquisas (Somente ativas)
get
*Pesquisas de avaliação
Listar pesquisas de avaliação
get
Listar SLA de pesquisas de avaliação
get
*Relatórios
Rel. agendamentos
get
Rel. atendimentos consolidado
get
Rel. atendimentos por clientes
get
Rel. avaliações analítico
get
Rel. clientes
get
Rel. exportados
get
Rel. hashtags analítico
get
Rel. hashtags consolidado
get
Rel. pausas analítico
get
Rel. pausas consolidado
get
Rel. tabulações analítico
get
Rel. tabulações consolidado
get
*Segmentação - Produtos
Listar produtos
get
*Segmentação - Carteiras
Listar carteiras
get
*Segmentação - Filas de atendimento
Listar filas de atendimento
get
Listar filas de atendimento de um agente
get
*STATUS DO AGENTES
Listar todos os status de agentes
get
*Tabulações
Listar todas as tabulações
get
*Tipos de anexo
Listar tipos de anexo
get
*Turnos de trabalho
Listar turnos de trabalho
get
*Usuários
Adicionar um usuário
post
Atualizar um usuário
patch
Listar usuários
get
*Variáveis de sistema
Listar variáveis de sistema
get
*Painel de atendimento
Abrir formulário de callback
get
Adicionar contato recebido
post
Adicionar formulário de callback
post
Adicionar hashtag em um atendimento
post
Adicionar tabulação em um atendimento
post
Agendar um atendimento
post
Alterar prioridade de um atendimento
patch
Converter áudio de uma mensagem para MP3
get
Enviar lista de distribuição
post
Enviar uma mensagem
post
Iniciar um atendimento externo
post
Listar atendimentos abertos de um agente
get
Listar dados de uma mensagem
get
Listar detalhes de um atendimento
get
Listar fluxo do atendimento
get
Listar hashtags de um atendimento
get
Listar histórico de um atendimento
get
Listar histórico de atendimentos de um cliente
get
Listar prioridades de atendimento
get
Listar status das mensagens
get
Listar tabulações disponíveis para um atendimento
get
Listar templates de mensagem
get
Marcar atendimento como não lido
patch
Pesquisar atendimentos de um agente
get
Reabrir um atendimento
post
Remover hashtag de um atendimento
delete
Solicitar próximo atendimento
get
Transferir um atendimento para outra fila
post
Transferir um atendimento para outro agente
post
Powered by
Gerar token
post
https://{subdominio}.cxm.pipe.run/oauth/token
Language
Shell
URL
Base URL
https://
subdominio
.cxm.pipe.run
/oauth/token
RESPONSE
Click
Try It!
to start a request and see the response here!
