Admin

Listar administradores

get

Retorna administradores conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/admins

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

200

Sucesso.

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

Criar administrador

post

Cria administrador com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/admins

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

{
  "name": "Admin",
  "email": "[email protected]"
}

200

Sucesso.

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

Detalhar administrador

get

Recupera os dados de administrador identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: admin_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/admins/{id}

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

200

Sucesso.

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

Atualizar administrador

put

Atualiza administrador conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/admins/{id}

PUT /api/v4/admins/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "Admin 2"
}

200

Sucesso.

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

Remover administrador

delete

Remove administrador identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/admins/{id}

DELETE /api/v4/admins/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Listar grupos de administradores

get

Retorna grupos de administradores conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/admins/groups

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

200

Sucesso.

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

Status de armazenamento

get

Processa a solicitação de status de armazenamento e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/storage

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

200

Sucesso.

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

Listar arquivos por tipo

get

Retorna arquivos por tipo conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

typestringObrigatórioExample: images

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/storage/{type}

GET /api/v4/storage/{type} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Upload de arquivo

post

Processa a solicitação de upload de arquivo e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

filestring · binaryOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/storage/upload

POST /api/v4/storage/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "file": "<arquivo>"
}

200

Sucesso.

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

Relatório de atendimentos

get

Processa a solicitação de relatório de atendimentos e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/reports/attendances

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

200

Sucesso.

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

Obter configuração da aplicação

get

Recupera configuração da aplicação.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/application

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

200

Sucesso.

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

Atualizar configuração da aplicação

put

Atualiza configuração da aplicação conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/application

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

{
  "name": "Minha Aplicação"
}

200

Sucesso.

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

Obter configurações de notas de atendimento

get

Recupera configurações de notas de atendimento.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/application/attendance

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

200

Sucesso.

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

Atualizar notas de atendimento

put

Atualiza notas de atendimento conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

initial_gradenumberOpcional

final_gradenumberOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

422

Erro de validação.

application/json

put

/v4/application/attendance

PUT /api/v4/application/attendance HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "initial_grade": 1,
  "final_grade": 5
}

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

Obter mensagens automáticas

get

Recupera mensagens automáticas.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/application/messages

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

200

Sucesso.

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

Atualizar mensagens automáticas

put

Atualiza mensagens automáticas conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/application/messages

PUT /api/v4/application/messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "welcome_message": "Olá!"
}

200

Sucesso.

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

Listar números bloqueados

get

Retorna números bloqueados conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/blockedNumbers

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

200

Sucesso.

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

Adicionar número bloqueado

post

Adiciona número bloqueado conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/blockedNumbers

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

{
  "number": "+558899999999",
  "reason": "spam"
}

200

Sucesso.

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

Detalhar número bloqueado

get

Recupera os dados de número bloqueado identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: blocked_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/blockedNumbers/{id}

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

200

Sucesso.

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

Atualizar número bloqueado

put

Atualiza número bloqueado conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/blockedNumbers/{id}

PUT /api/v4/blockedNumbers/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "number": "+558899999999",
  "reason": "fraude"
}

200

Sucesso.

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

Remover número bloqueado

delete

Remove número bloqueado identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/blockedNumbers/{id}

DELETE /api/v4/blockedNumbers/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Listar filtro de palavras (agentes)

get

Retorna filtro de palavras conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/wordFilter/agents

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

200

Sucesso.

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

Adicionar filtro de palavras (agentes)

post

Adiciona filtro de palavras conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/wordFilter/agents

POST /api/v4/wordFilter/agents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "word": "proibida"
}

200

Sucesso.

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

Atualizar filtro de palavras (agentes)

put

Atualiza filtro de palavras conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/wordFilter/agents/{id}

PUT /api/v4/wordFilter/agents/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "word": "proibida"
}

200

Sucesso.

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

Remover filtro de palavras (agentes)

delete

Remove filtro de palavras identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/wordFilter/agents/{id}

DELETE /api/v4/wordFilter/agents/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Upload de filtro de palavras (agentes)

post

Processa a solicitação de upload de filtro de palavras e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

filestring · binaryOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/wordFilter/agents/upload

POST /api/v4/wordFilter/agents/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "file": "<arquivo>"
}

200

Sucesso.

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

Listar filtro de palavras (contatos)

get

Retorna filtro de palavras conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/wordFilter/contacts

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

200

Sucesso.

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

Adicionar filtro de palavras (contatos)

post

Adiciona filtro de palavras conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/wordFilter/contacts

POST /api/v4/wordFilter/contacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "word": "proibida"
}

200

Sucesso.

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

Atualizar filtro de palavras (contatos)

put

Atualiza filtro de palavras conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/wordFilter/contacts/{id}

PUT /api/v4/wordFilter/contacts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "word": "proibida"
}

200

Sucesso.

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

Remover filtro de palavras (contatos)

delete

Remove filtro de palavras identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/wordFilter/contacts/{id}

DELETE /api/v4/wordFilter/contacts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Upload de filtro de palavras (contatos)

post

Processa a solicitação de upload de filtro de palavras e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

filestring · binaryOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/wordFilter/contacts/upload

POST /api/v4/wordFilter/contacts/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "file": "<arquivo>"
}

200

Sucesso.

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

Listar grupos de horário

get

Retorna grupos de horário conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/timeGroup

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

200

Sucesso.

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

Criar grupo de horário

post

Cria grupo de horário com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/timeGroup

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

{
  "name": "Horário Comercial"
}

200

Sucesso.

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

Atualizar grupo de horário

put

Atualiza grupo de horário conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/timeGroup/{id}

PUT /api/v4/timeGroup/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "Horário Especial"
}

200

Sucesso.

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

Remover grupo de horário

delete

Remove grupo de horário identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/timeGroup/{id}

DELETE /api/v4/timeGroup/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Listar grupos de usuários

get

Retorna grupos de usuários conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/userGroup

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

200

Sucesso.

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

Criar grupo de usuários

post

Cria grupo de usuários com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/userGroup

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

{
  "name": "Supervisores"
}

200

Sucesso.

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

Atualizar grupo de usuários

put

Atualiza grupo de usuários conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/userGroup/{id}

PUT /api/v4/userGroup/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "name": "Operadores"
}

200

Sucesso.

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

Remover grupo de usuários

delete

Remove grupo de usuários identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/userGroup/{id}

DELETE /api/v4/userGroup/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Listar regras de grupo de usuários

get

Retorna regras de grupo de usuários conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/userGroup/rules

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

200

Sucesso.

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

Listar multicanais

get

Retorna multicanais conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/multichannel

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

200

Sucesso.

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

Criar multicanal

post

Cria multicanal com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/multichannel

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

{
  "name": "Canal X"
}

200

Sucesso.

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

Atualizar multicanal

put

Atualiza multicanal conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/multichannel/{id}

PUT /api/v4/multichannel/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "Canal X2"
}

200

Sucesso.

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

Remover multicanal

delete

Remove multicanal identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/multichannel/{id}

DELETE /api/v4/multichannel/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Listar pausas

get

Retorna pausas conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/pauses

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

200

Sucesso.

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

Criar pausa

post

Cria pausa com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/pauses

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

{
  "name": "Almoço",
  "limit": 60
}

200

Sucesso.

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

Atualizar pausa

put

Atualiza pausa conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/pauses/{id}

PUT /api/v4/pauses/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "name": "Pausa curta"
}

200

Sucesso.

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

Remover pausa

delete

Remove pausa identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/pauses/{id}

DELETE /api/v4/pauses/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

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

Obter configuração pública da aplicação

get

Recupera configuração pública da aplicação.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/config-application

GET /api/v4/config-application HTTP/1.1
Accept: */*

200

Sucesso.

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

Atualizar API key

post

Atualiza aPI key conforme os dados enviados.

Autorizações

Integration-KeystringObrigatório

Chave de integração Fortics BSP.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

post

/v4/fortics-bsp/update-api-key

POST /api/v4/fortics-bsp/update-api-key HTTP/1.1
Integration-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "api_key": "nova_key"
}

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

Obter whitelabel

post

Recupera whitelabel.

Autorizações

Integration-KeystringObrigatório

Chave de integração Fortics BSP.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

401

Não autorizado.

application/json

post

/v4/fortics-bsp/whitelabel

POST /api/v4/fortics-bsp/whitelabel HTTP/1.1
Integration-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "domain": "empresa.com"
}

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

AnteriorContacts PróximoCampaigns

Atualizado há 1 mês

Isto foi útil?

Boa tarde

hashtagListar administradores

hashtagCriar administrador

hashtagDetalhar administrador

hashtagAtualizar administrador

hashtagRemover administrador

hashtagListar grupos de administradores

hashtagStatus de armazenamento

hashtagListar arquivos por tipo

hashtagUpload de arquivo

hashtagRelatório de atendimentos

hashtagObter configuração da aplicação

hashtagAtualizar configuração da aplicação

hashtagObter configurações de notas de atendimento

hashtagAtualizar notas de atendimento

hashtagObter mensagens automáticas

hashtagAtualizar mensagens automáticas

hashtagListar números bloqueados

hashtagAdicionar número bloqueado

hashtagDetalhar número bloqueado

hashtagAtualizar número bloqueado

hashtagRemover número bloqueado

hashtagListar filtro de palavras (agentes)

hashtagAdicionar filtro de palavras (agentes)

hashtagAtualizar filtro de palavras (agentes)

hashtagRemover filtro de palavras (agentes)

hashtagUpload de filtro de palavras (agentes)

hashtagListar filtro de palavras (contatos)

hashtagAdicionar filtro de palavras (contatos)

hashtagAtualizar filtro de palavras (contatos)

hashtagRemover filtro de palavras (contatos)

hashtagUpload de filtro de palavras (contatos)

hashtagListar grupos de horário

hashtagCriar grupo de horário

hashtagAtualizar grupo de horário

hashtagRemover grupo de horário

hashtagListar grupos de usuários

hashtagCriar grupo de usuários

hashtagAtualizar grupo de usuários

hashtagRemover grupo de usuários

hashtagListar regras de grupo de usuários

hashtagListar multicanais

hashtagCriar multicanal

hashtagAtualizar multicanal

hashtagRemover multicanal

hashtagListar pausas

hashtagCriar pausa

hashtagAtualizar pausa

hashtagRemover pausa

hashtagObter configuração pública da aplicação

hashtagAtualizar API key

hashtagObter whitelabel

Listar administradores

Criar administrador

Detalhar administrador

Atualizar administrador

Remover administrador

Listar grupos de administradores

Status de armazenamento

Listar arquivos por tipo

Upload de arquivo

Relatório de atendimentos

Obter configuração da aplicação

Atualizar configuração da aplicação

Obter configurações de notas de atendimento

Atualizar notas de atendimento

Obter mensagens automáticas

Atualizar mensagens automáticas

Listar números bloqueados

Adicionar número bloqueado

Detalhar número bloqueado

Atualizar número bloqueado

Remover número bloqueado

Listar filtro de palavras (agentes)

Adicionar filtro de palavras (agentes)

Atualizar filtro de palavras (agentes)

Remover filtro de palavras (agentes)

Upload de filtro de palavras (agentes)

Listar filtro de palavras (contatos)

Adicionar filtro de palavras (contatos)

Atualizar filtro de palavras (contatos)

Remover filtro de palavras (contatos)

Upload de filtro de palavras (contatos)

Listar grupos de horário

Criar grupo de horário

Atualizar grupo de horário

Remover grupo de horário

Listar grupos de usuários

Criar grupo de usuários

Atualizar grupo de usuários

Remover grupo de usuários

Listar regras de grupo de usuários

Listar multicanais

Criar multicanal

Atualizar multicanal

Remover multicanal

Listar pausas

Criar pausa

Atualizar pausa

Remover pausa

Obter configuração pública da aplicação

Atualizar API key

Obter whitelabel