Jump to Content
PipeRun Atendimentos
Referência da API (V1.0)
Log InPipeRun Atendimentos
Referência da API (V1.0)
Log In
Referência da API (V1.0)

PRIMEIROS PASSOS

  • Cabeçalhos obrigatórios
  • Paginação de consultas
  • Padrões de resposta
  • Filtros em consultas
  • Ordenação de resultados
  • Entidades relacionadas em resultados

Autenticação

  • Gerar tokenpost
  • Renovar tokenpost
  • Login Apppost
  • Login App SSOpost
  • Recuperar senhapost

SDK API sync

  • Como instalar o plugin no seu sistema

*Agentes

  • Registrar geolocalizaçãopost

WEBHOOKS

  • WEBHOOK DE ATENDIMENTOS
    • Objeto mensagem do atendimento [talkHistory]
      • Objeto tipo de anexo [attachmentType]
      • Objeto usuário [user]
      • Objeto canal [channel]
    • Objeto cliente [customer]
      • Objeto informações de perfil do cliente [profileInfo]
      • Objeto campo customizado do cliente [customerCustomField]
      • Objeto telefone do cliente [customerTelephone]
      • Objeto e-mail do cliente [customerEmail]
    • Objeto tabulação do atendimento [talkEvent]
      • Objeto evento da tabulação [event]
    • Objeto variável do bot [botVariable]
    • Objeto bot [bot]
    • Objeto serviço [serviceCatalog]

CAMPOS CUSTOMIZADOS

  • Listar todos os campos customizadosget

*Clientes

  • Adicionar telefone para um clientepost
  • Adicionar um campo customizado em um clientepost
  • Atualizar telefone de um clientepatch
  • Listar campos customizados de um clienteget
  • Remover um campo customizado de um clientedel

Pausas

  • Listar pausasget

PESQUISAS (BETA)

  • Disparar uma pesquisa para um clientepost
  • Listar açõesget
  • Listar cancelamentos de inscriçãoget
  • Listar formatos de perguntasget
  • Listar metodologiasget
  • Listar pesquisas (Somente ativas)get
  • Listar pesquisas (Todas)get
  • Listar pesquisas disparadasget
  • Listar situação das respostasget
  • Listar situação dos lembretesget
  • Listar tipos de pesquisasget

Relatórios

  • Rel. agendamentosget
  • Rel. atendimentosget
  • Rel. categoriasget
  • Rel. clientesget
  • Rel. hashtagsget
  • Rel. pausasget
  • Rel. performanceget
  • Rel. serviçosget
  • Rel. tabulaçõesget
  • Rel. transferênciasget

Segmentação - Produtos

  • Listar produtosget

Segmentação - Carteiras

  • Listar carteirasget

Segmentação - Filas de atendimento

  • Listar filas de atendimentoget
  • Listar filas de atendimento de um agenteget

Tipos de anexo

  • Listar tipos de anexoget

*Usuários

  • Alterar senhapost

*Painel de atendimento

  • Adicionar geolocalização do agentepost
  • Atualizar um atendimentopatch
Powered by 

Objeto bot [bot]

< Voltar para as definições do objeto principal [talk].

Definição dos campos do objeto "bot":

CamposNullableDescrição
id
int
NÃOIdentificador interno do Bot;
description
string
NÃONome do Bot;

Exemplo de payload

{
    "id": 105,
    "description": "Informativo - TROCA DE CANAL - 2025"
}

< Voltar para as definições do objeto principal [talk].

Updated 4 months ago


Updated 4 months ago