Attendances

Criar atendimento via integração WhatsApp

post

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

Autorizações

IntegrationApiKey

apiKeystringObrigatório

Chave do canal para integrações WhatsApp attendances.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

404

Não encontrado.

application/json

post

/v4/whatsapp/attendances

HTTPcURLJavaScriptPython

POST /api/v4/whatsapp/attendances HTTP/1.1
apiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "contact_id": "contact_123",
  "channel_id": "channel_123",
  "message": "Olá"
}

{
  "status": true,
  "message": "Sucesso"
}

Listar sessões de atendimento

get

Retorna sessões de atendimento conforme filtros enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

_idstringOpcionalExample: session_123

statusstringOpcionalExample: wait

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/attendances

HTTPcURLJavaScriptPython

GET /api/v4/attendances HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "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

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringOpcional

contact_idstringOpcional

platform_idstringOpcional

protocolstringOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

422

Erro de validação.

application/json

post

/v4/attendances

HTTPcURLJavaScriptPython

POST /api/v4/attendances HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Listar sessões por fase

get

Retorna sessões por fase conforme filtros enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

session_phasestringObrigatório

Fase da sessão.

Example: human

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/attendances/phase/{session_phase}

HTTPcURLJavaScriptPython

GET /api/v4/attendances/phase/{session_phase} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Aceitar atendimento em espera

post

Aceita atendimento em espera com base nos identificadores enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringObrigatório

attendance_idstringOpcional

agentstring · emailOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

409

Conflito de negócio.

application/json

412

Pré-condição falhou.

application/json

post

/v4/attendances/accept

HTTPcURLJavaScriptPython

POST /api/v4/attendances/accept HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "session_id": "session_123",
  "attendance_id": "camp_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Iniciar sessão de atendimento

post

Inicia sessão de atendimento com os dados informados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

contact_idstringOpcional

platformstringOpcional

channel_idstringOpcional

team_idstringOpcional

agent_idstringOpcional

hsm_idstringOpcional

tagMessagestringOpcional

tagTypestringOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

400

Requisição inválida.

application/json

404

Não encontrado.

application/json

500

Erro interno.

application/json

post

/v4/attendances/session/init

HTTPcURLJavaScriptPython

POST /api/v4/attendances/session/init HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "contact_id": "contact_123",
  "platform": "Whatsapp",
  "channel_id": "channel_123",
  "team_id": "camp_123",
  "agent_id": "agent_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Encerrar atendimento

post

Encerra atendimento conforme a sessão informada.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringObrigatório

tabulation_idstringOpcional

Respostas

200

Atendimento encerrado.

application/json

statusintegerOpcional

responsestringOpcional

404

Não encontrado.

application/json

post

/v4/attendances/finish

HTTPcURLJavaScriptPython

POST /api/v4/attendances/finish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "session_id": "session_123",
  "tabulation_id": "tab_123"
}

{
  "status": 200,
  "response": "Atendimento finalizado"
}

Obter tags da sessão

get

Recupera tags da sessão.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: session_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/attendances/tags/{id}

HTTPcURLJavaScriptPython

GET /api/v4/attendances/tags/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Transferir atendimento

post

Transfere atendimento para o destino informado.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringObrigatório

typestring · enumObrigatórioValores possíveis:

attendance_idstringOpcional

agent_idstringOpcional

transfer_waitbooleanOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

400

Requisição inválida.

application/json

404

Não encontrado.

application/json

412

Pré-condição falhou.

application/json

post

/v4/attendances/transfer

HTTPcURLJavaScriptPython

POST /api/v4/attendances/transfer HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "session_id": "session_123",
  "type": "attendance",
  "attendance_id": "camp_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Convidar agente para conferência

post

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringObrigatório

agent_idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

403

Proibido.

application/json

409

Conflito de negócio.

application/json

post

/v4/attendances/conference/invite

HTTPcURLJavaScriptPython

POST /api/v4/attendances/conference/invite HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "session_id": "session_123",
  "agent_id": "agent_456"
}

{
  "status": true,
  "message": "Sucesso"
}

Aceitar convite de conferência

post

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringObrigatório

acceptbooleanObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

post

/v4/attendances/conference/accept

HTTPcURLJavaScriptPython

POST /api/v4/attendances/conference/accept HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "session_id": "session_123",
  "accept": true
}

{
  "status": true,
  "message": "Sucesso"
}

Encerrar conferência

post

Encerra conferência conforme a sessão informada.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

session_idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

412

Pré-condição falhou.

application/json

post

/v4/attendances/conference/finish

HTTPcURLJavaScriptPython

POST /api/v4/attendances/conference/finish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Listar histórico de sessões do contato

post

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/attendances/historic

HTTPcURLJavaScriptPython

POST /api/v4/attendances/historic HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "contact_id": "contact_123"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Histórico por período

post

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/attendances/historic/period

HTTPcURLJavaScriptPython

POST /api/v4/attendances/historic/period HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "contact_id": "contact_123",
  "period": "2024-01"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Histórico de mensagens

post

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/attendances/historic/messages

HTTPcURLJavaScriptPython

POST /api/v4/attendances/historic/messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "session_id": "session_123"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Histórico por protocolo

post

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/attendances/historic/protocol

HTTPcURLJavaScriptPython

POST /api/v4/attendances/historic/protocol HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "protocol": "ABC-123"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Histórico por intervalo

get

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

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

startstringOpcionalExample: 2024-01-01

endstringOpcionalExample: 2024-01-31

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/attendances/historic/interval

HTTPcURLJavaScriptPython

GET /api/v4/attendances/historic/interval HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Iniciar sessão (atalho)

post

Inicia sessão com os dados informados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

application/json

contact_idstringOpcional

platformstringOpcional

channel_idstringOpcional

team_idstringOpcional

agent_idstringOpcional

hsm_idstringOpcional

tagMessagestringOpcional

tagTypestringOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/session/init

HTTPcURLJavaScriptPython

POST /api/v4/session/init HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "contact_id": "contact_123",
  "platform": "Whatsapp",
  "channel_id": "channel_123",
  "team_id": "camp_123",
  "agent_id": "agent_123"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}