Attendances

Criar atendimento via integração WhatsApp

post

Cria atendimento via integração WhatsApp com os dados enviados.

Autorizações
apiKeystringObrigatório

Chave do canal para integrações WhatsApp attendances.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/whatsapp/attendances

Listar sessões de atendimento

get

Retorna sessões de atendimento conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta
_idstringOpcionalExample: session_123
statusstringOpcionalExample: wait
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/attendances
200

Sucesso.

Exibir dados de uma sessão

post

Processa a solicitação de exibir dados de uma sessão e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringOpcional
contact_idstringOpcional
platform_idstringOpcional
protocolstringOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances

Listar sessões por fase

get

Retorna sessões por fase conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
session_phasestringObrigatório

Fase da sessão.

Example: human
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/attendances/phase/{session_phase}
200

Sucesso.

Aceitar atendimento em espera

post

Aceita atendimento em espera com base nos identificadores enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
attendance_idstringOpcional
agentstring · emailOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/accept

Iniciar sessão de atendimento

post

Inicia sessão de atendimento com os dados informados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
contact_idstringOpcional
platformstringOpcional
channel_idstringOpcional
team_idstringOpcional
agent_idstringOpcional
hsm_idstringOpcional
tagMessagestringOpcional
tagTypestringOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/session/init

Encerrar atendimento

post

Encerra atendimento conforme a sessão informada.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
tabulation_idstringOpcional
Respostas
chevron-right
200

Atendimento encerrado.

application/json
statusintegerOpcional
responsestringOpcional
post
/v4/attendances/finish

Obter tags da sessão

get

Recupera tags da sessão.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota
idstringObrigatórioExample: session_123
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/attendances/tags/{id}
200

Sucesso.

Transferir atendimento

post

Transfere atendimento para o destino informado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
typestring · enumObrigatórioValores possíveis:
attendance_idstringOpcional
agent_idstringOpcional
transfer_waitbooleanOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/transfer

Convidar agente para conferência

post

Processa a solicitação de convidar agente para conferência e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
agent_idstringObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/conference/invite

Aceitar convite de conferência

post

Aceita convite de conferência com base nos identificadores enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
acceptbooleanObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/conference/accept

Encerrar conferência

post

Encerra conferência conforme a sessão informada.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
session_idstringObrigatório
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/conference/finish

Listar histórico de sessões do contato

post

Retorna histórico de sessões do contato conforme filtros enviados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/historic
200

Sucesso.

Histórico por período

post

Processa a solicitação de histórico por período e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/historic/period
200

Sucesso.

Histórico de mensagens

post

Processa a solicitação de histórico de mensagens e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/historic/messages
200

Sucesso.

Histórico por protocolo

post

Processa a solicitação de histórico por protocolo e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
Other propertiesanyOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/attendances/historic/protocol
200

Sucesso.

Histórico por intervalo

get

Processa a solicitação de histórico por intervalo e retorna o resultado.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta
startstringOpcionalExample: 2024-01-01
endstringOpcionalExample: 2024-01-31
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
get
/v4/attendances/historic/interval
200

Sucesso.

Iniciar sessão (atalho)

post

Inicia sessão com os dados informados.

Autorizações
AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo
contact_idstringOpcional
platformstringOpcional
channel_idstringOpcional
team_idstringOpcional
agent_idstringOpcional
hsm_idstringOpcional
tagMessagestringOpcional
tagTypestringOpcional
Respostas
chevron-right
200

Sucesso.

application/json
Other propertiesanyOpcional
post
/v4/session/init
200

Sucesso.

Atualizado

Isto foi útil?