{ "openapi": "3.0.0", "info": { "title": "Endpoints do Portal", "description": "Documenta\u00e7\u00e3o dos endpoints do portal", "version": "1.0.0" }, "servers": [ { "url": "https:\/\/{serverUrl}\/portal\/api", "description": "Servidor do Voice IP", "variables": { "serverUrl": { "default": "convert.app.br", "description": "URL do servidor do Voice IP" } } } ], "paths": { "\/SMS\/envioPortal": { "post": { "tags": [ "Envio de SMS" ], "summary": "Envio de SMS a partir do Portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Envio de SMS a partir do Portal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "msg", "numeros" ], "properties": { "campanha": { "type": "integer", "description": "Id da Campanha", "example": 45, "required": false }, "msg": { "type": "string", "description": "Mensagem a ser enviada", "example": "Teste", "required": true }, "numeros": { "type": "array", "description": "Array de n\u00fameros para envio", "example": null, "required": true, "items": { "type": "string" } }, "origem": { "type": "string", "description": "Origem para definir a mensagem (s\u00f3 Zenvia)", "example": "LETTEL", "required": false } } } } } } } }, "\/UsuarioPresenca\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos Usu\u00e1rios do Assist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPresenca\/buscarGruposPorId": { "get": { "tags": [ "Assist" ], "summary": "Buscar grupos por Id de Usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de UsuarioPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de UsuarioPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPresenca\/buscarRegistrosAuditoria": { "get": { "tags": [ "Assist" ], "summary": "Buscar registros para auditoria em relat\u00f3rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de UsuarioPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de UsuarioPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPresenca\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de UsuarioPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de UsuarioPresenca", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPresenca", "example": 1, "required": true } } } } } } } }, "\/UsuarioPresenca\/buscarParaEdicao": { "get": { "tags": [ "Assist" ], "summary": "Buscar um usu\u00e1rio para edi\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de UsuarioPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de UsuarioPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPresenca\/alterarSenhaUsuarioPresenca": { "post": { "tags": [ "Assist" ], "summary": "Alterar a senha de um usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Alterar a senha de um usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "password" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPresenca", "example": 1, "required": true }, "password": { "type": "string", "description": "Senha do usu\u00e1rio", "example": "1234", "required": true } } } } } } } }, "\/UsuarioPresenca\/atrelarGrupo": { "post": { "tags": [ "Assist" ], "summary": "Atrelar grupo a usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atrelar grupo a usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "checked", "idGrupo", "idUsuario" ], "properties": { "checked": { "type": "boolean", "description": "Define se op\u00e7\u00e3o \u00e9 de vincular ou desvincular", "example": true, "required": true }, "idGrupo": { "type": "integer", "description": "ID do Grupo", "example": 35, "required": true }, "idUsuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 5, "required": true } } } } } } } }, "\/UsuarioPresenca\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de UsuarioPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de UsuarioPresenca", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "login", "nome", "password" ], "properties": { "api_gravacao": { "type": "integer", "description": "Possibilidade de escutar liga\u00e7\u00e3o via API", "example": 1, "required": false }, "api_key": { "type": "string", "description": "Chave de API", "example": "43583490583409649", "required": false }, "api_ligacao": { "type": "integer", "description": "Possibilidade de executar liga\u00e7\u00e3o via API", "example": null, "required": false }, "api_pushbullet": { "type": "string", "description": "Chave de API de Integra\u00e7\u00e3o Pushbullet", "example": "43583490583409649", "required": false }, "cadastro": { "type": "integer", "description": "Possibilidade de cadastrar usu\u00e1rios", "example": 1, "required": false }, "contexto": { "type": "string", "description": "Contexto para executar liga\u00e7\u00f5es do Assist", "example": "interno-ramais", "required": false }, "deletar": { "type": null, "description": "Define se pode deletar contatos (Q - Quarentena, N - N\u00e3o, C - Deletar Completo)", "example": "Q", "required": false }, "email": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": false }, "fila": { "type": "string", "description": "N\u00famero da Fila (CA) atrelado para Assist Operator", "example": "440", "required": false }, "id": { "type": "integer", "description": "ID do Registro de UsuarioPresenca", "example": 1, "required": false }, "ip": { "type": "string", "description": "IP do Aparelho do Usu\u00e1rio (para mesa)", "example": "192.168.20.10", "required": false }, "limite": { "type": "integer", "description": "Limite do Usu\u00e1rio", "example": 100, "required": false }, "login": { "type": "string", "description": "Login do usu\u00e1rio", "example": "bruno", "required": true }, "movel": { "type": "string", "description": "Telefone m\u00f3vel do usu\u00e1rio", "example": "0054984080610", "required": false }, "nome": { "type": "string", "description": "Nome do Usuario", "example": "Bruno Leite", "required": true }, "numero": { "type": "string", "description": "Ramal do Usu\u00e1rio", "example": "7003", "required": false }, "password": { "type": "string", "description": "Senha do usu\u00e1rio", "example": "43589", "required": true }, "senha_ligacoes": { "type": "string", "description": "Senha para liga\u00e7\u00f5es. Apenas para vincular com assist", "example": "3040", "required": false }, "sms": { "type": null, "description": "Define forma de envio de SMS (N - N\u00e3o pode, V - Validar crednecial, C - Completo)", "example": "V", "required": false }, "visualizacao": { "type": null, "description": "Define forma de visualiza\u00e7\u00e3o (T - Total, G - Grupo)", "example": "T", "required": false }, "api_phone": { "type": "string", "description": "Chave base64 de credenciais de telefone para mesa", "example": "MzI0OjQzMg==", "required": false }, "agente_omni": { "type": "string", "description": "Agente do OmniChannel", "example": "njt34h5r2i", "required": false }, "callcenter_supervisor": { "type": "string", "description": "Callcenters Supervisionados", "example": "[ \"440\", \"441\" ]", "required": false } } } } } } } }, "\/UsuarioPresenca\/buscarPorNomeLike": { "get": { "tags": [ "Assist" ], "summary": "Buscar um usu\u00e1rio por um peda\u00e7o de seu nome", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o do nome do usu\u00e1rio para pesquisa", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o do nome do usu\u00e1rio para pesquisa", "example": "bruno", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Contato\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos Contatos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Contato\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de Contato", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Contato", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Contato", "example": 1, "required": true } } } } } } } }, "\/Contato\/restaurarQuarentena": { "post": { "tags": [ "Assist" ], "summary": "Restaurar um contato em quarentena", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Restaurar um contato em quarentena", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Contato", "example": 1, "required": true } } } } } } } }, "\/Contato\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de Contato", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Contato", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "id_tipo_contato", "nome" ], "properties": { "ativo": { "type": "integer", "description": "Define se est\u00e1 ativo", "example": 1, "required": false }, "cargo": { "type": "string", "description": "Cargo do contato", "example": "Gerente de TI", "required": false }, "cep": { "type": "string", "description": "CEP do Contato", "example": "99010-100", "required": false }, "cidade": { "type": "integer", "description": "Id da Cidade", "example": 4166, "required": false }, "data_nascimento": { "type": "string", "description": "Data", "example": "1990-01-01", "required": false }, "email1": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": false }, "email2": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": false }, "empresa": { "type": "string", "description": "Empresa do Contato", "example": "Lettel Data", "required": false }, "endereco": { "type": "string", "description": "Endere\u00e7o do Contato", "example": "Rua Uruguai, 123, Sala 201", "required": false }, "extra": { "type": "string", "description": "Informa\u00e7\u00e3o Extra", "example": "Tio do Jos\u00e9", "required": false }, "foto": { "type": "string", "description": "Arquivo de foto", "example": "123.jpg", "required": false }, "id": { "type": "integer", "description": "ID do Registro de Contato", "example": 1, "required": true }, "id_tipo_contato": { "type": "integer", "description": "Tipo de contato (1 - Publico, 2 - Particular, 3 - Interno)", "example": 1, "required": true }, "nome": { "type": "string", "description": "Nome do Contato", "example": "Bruno", "required": true }, "sobrenome": { "type": "string", "description": "Sobrenome do Contato", "example": "Leite", "required": false }, "telefone_comercial": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "005421037000", "required": false }, "telefone_extra1": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "005421037000", "required": false }, "telefone_extra2": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "005421037000", "required": false }, "telefone_movel": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "0054984080610", "required": false }, "setor": { "type": "string", "description": "Setor do contato", "example": "TI", "required": false }, "cpf": { "type": "string", "description": "CPF\/CNPJ", "example": "010.010.010-12", "required": false }, "origem": { "type": "string", "description": "Origem", "example": "CONVERT", "required": false }, "principal": { "type": "integer", "description": "Telefone principal", "example": 1, "required": false }, "consentimento": { "type": "string", "description": "Consentimento para tratamento de dados (S - Coletado, N - Pendente, X - N\u00e3o se aplica)", "example": "S", "required": false } } } } } } } }, "\/Contato\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de Contato", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Contato", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Contato", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/GrupoPresenca\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos Grupos de Usu\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/GrupoPresenca\/buscarContatosPorId": { "get": { "tags": [ "Assist" ], "summary": "Buscar contatos por Id", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de GrupoPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de GrupoPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/GrupoPresenca\/buscarContatosPorIdSMS": { "get": { "tags": [ "Assist" ], "summary": "Buscar contatos por Id SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de GrupoPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de GrupoPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/GrupoPresenca\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de GrupoPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de GrupoPresenca", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de GrupoPresenca", "example": 1, "required": true } } } } } } } }, "\/GrupoPresenca\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de GrupoPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de GrupoPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de GrupoPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/GrupoPresenca\/atrelarContato": { "post": { "tags": [ "Assist" ], "summary": "Atrelar grupo a contato", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atrelar grupo a contato", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "checked", "idContato", "idGrupo" ], "properties": { "checked": { "type": "boolean", "description": "Define se op\u00e7\u00e3o \u00e9 de vincular ou desvincular", "example": true, "required": true }, "idContato": { "type": "integer", "description": "Id do Contato para Atrelar", "example": 5, "required": true }, "idGrupo": { "type": "integer", "description": "ID do Grupo", "example": 35, "required": true } } } } } } } }, "\/GrupoPresenca\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de GrupoPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de GrupoPresenca", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome" ], "properties": { "cc": { "type": null, "description": "Define se \u00e9 um centro de custo (Y ou N)", "example": "Y", "required": false }, "codigo": { "type": "string", "description": "C\u00f3digo do Grupo", "example": "13.1", "required": false }, "id": { "type": "integer", "description": "ID do Registro de GrupoPresenca", "example": 1, "required": false }, "id_grupo_pai": { "type": "integer", "description": "ID do Pai do Grupo em Quest\u00e3o", "example": 7, "required": false }, "id_responsavel": { "type": "integer", "description": "ID do respons\u00e1vel pelo grupo", "example": 7, "required": false }, "limite": { "type": "integer", "description": "Limite do Grupo", "example": 100, "required": false }, "nivel": { "type": "string", "description": "Informa\u00e7\u00e3o adicional", "example": "Teste", "required": false }, "nome": { "type": "string", "description": "Nome do Grupo", "example": "Comercial", "required": true }, "padrao": { "type": null, "description": "N\u00e3o usado (S ou N)", "example": "N", "required": false } } } } } } } }, "\/LocalPresenca\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos Locais de Usu\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/LocalPresenca\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de LocalPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de LocalPresenca", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "descricao" ], "properties": { "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "Casa", "required": true }, "id": { "type": "integer", "description": "ID do Registro de LocalPresenca", "example": 1, "required": false } } } } } } } }, "\/LocalPresenca\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de LocalPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de LocalPresenca", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de LocalPresenca", "example": 1, "required": true } } } } } } } }, "\/LocalPresenca\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de LocalPresenca", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de LocalPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de LocalPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Blacklist\/all": { "get": { "tags": [ "Blacklist" ], "summary": "Buscar todos registros de Blacklist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Blacklist\/delete": { "post": { "tags": [ "Blacklist" ], "summary": "Deletar um registro de Blacklist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Blacklist", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Blacklist", "example": 1, "required": true } } } } } } } }, "\/Blacklist\/get": { "get": { "tags": [ "Blacklist" ], "summary": "Buscar um registro de Blacklist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Blacklist", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Blacklist", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Blacklist\/persist": { "post": { "tags": [ "Blacklist" ], "summary": "Cadastrar ou Alterar um registro de Blacklist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Blacklist", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "numero" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Blacklist", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome do Registro", "example": "Bruno Leite", "required": false }, "numero": { "type": "string", "description": "N\u00famero a ser bloqueado", "example": "54984080610", "required": true }, "razao": { "type": "string", "description": "Raz\u00e3o do bloqueio", "example": "Fraude", "required": false } } } } } } } }, "\/Callback\/all": { "get": { "tags": [ "Callback" ], "summary": "Buscar todos registros de Callback", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Callback\/delete": { "post": { "tags": [ "Callback" ], "summary": "Deletar um registro de Callback", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Callback", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Callback", "example": 1, "required": true } } } } } } } }, "\/Callback\/get": { "get": { "tags": [ "Callback" ], "summary": "Buscar um registro de Callback", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Callback", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Callback", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Callback\/persist": { "post": { "tags": [ "Callback" ], "summary": "Cadastrar ou Alterar um registro de Callback", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Callback", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "destino", "telefone" ], "properties": { "destino": { "type": "string", "description": "Destino do callback. Ramal, grupo ou fila", "example": "603", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Callback", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome do Registro", "example": "Bruno Leite", "required": false }, "telefone": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "0054984080610", "required": true } } } } } } } }, "\/Portabilidade\/all": { "get": { "tags": [ "Portabilidade" ], "summary": "Buscar todos registros de Portabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Portabilidade\/delete": { "post": { "tags": [ "Portabilidade" ], "summary": "Deletar um registro de Portabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Portabilidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Portabilidade", "example": 1, "required": true } } } } } } } }, "\/Portabilidade\/get": { "get": { "tags": [ "Portabilidade" ], "summary": "Buscar um registro de Portabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Portabilidade", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Portabilidade", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Portabilidade\/persist": { "post": { "tags": [ "Portabilidade" ], "summary": "Cadastrar ou Alterar um registro de Portabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Portabilidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "discagem", "numero" ], "properties": { "discagem": { "type": "string", "description": "Discagem de operadora", "example": "5554", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Portabilidade", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome do Registro", "example": "Bruno Leite", "required": false }, "numero": { "type": "string", "description": "N\u00famero a registrar portabilidade", "example": "0054984080610", "required": true } } } } } } } }, "\/ReportCDR\/relatorioDetalhadoCDR": { "get": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Relat\u00f3rio detalhado de CDR", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "max-time", "in": "query", "description": "Tempo m\u00e1ximo de chamada", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00e1ximo de chamada", "example": null, "required": false } }, { "name": "json-data", "in": "query", "description": "Texto adicional", "required": false, "schema": { "type": "string", "description": "Texto adicional", "example": "%Contato Fechado%", "required": false } }, { "name": "protocolo", "in": "query", "description": "Protocolo da Liga\u00e7\u00e3o (v\u00e1lido se novo protocolo)", "required": false, "schema": { "type": "string", "description": "Protocolo da Liga\u00e7\u00e3o (v\u00e1lido se novo protocolo)", "example": "45645654", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio detalhado de CDR", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false }, "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (E - Entrada, S - Sa\u00edda, I - Interna)", "example": "S", "required": false } } } } } } } }, "\/ReportCDR\/relatorioRankingOrigem": { "get": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Relat\u00f3rio de Ranking de Origem CDR", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio de Ranking de Origem CDR", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false }, "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (E - Entrada, S - Sa\u00edda, I - Interna)", "example": "S", "required": false } } } } } } } }, "\/ReportCDR\/relatorioRankingDestino": { "get": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Relat\u00f3rio de Ranking de Destino de CDR", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio de Ranking de Destino de CDR", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false }, "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (E - Entrada, S - Sa\u00edda, I - Interna)", "example": "S", "required": false } } } } } } } }, "\/ReportCDR\/graficoTipoLigacao": { "get": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Gr\u00e1fico de Tipo de Liga\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Gr\u00e1fico de Tipo de Liga\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (E - Entrada, S - Sa\u00edda, I - Interna)", "example": "S", "required": false } } } } } } } }, "\/ReportURA\/relatorioDetalhadoURA": { "get": { "tags": [ "Relat\u00f3rios de URA" ], "summary": "Relat\u00f3rio detalhado de URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "entrada", "in": "query", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "required": false, "schema": { "type": "string", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "example": "0800", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "opcao-ura", "in": "query", "description": "N\u00famero da op\u00e7\u00e3o discada", "required": false, "schema": { "type": "string", "description": "N\u00famero da op\u00e7\u00e3o discada", "example": "1", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio detalhado de URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false } } } } } } } }, "\/ReportURA\/relatorioRankingOpcaoURA": { "get": { "tags": [ "Relat\u00f3rios de URA" ], "summary": "Relat\u00f3rio de Ranking de Op\u00e7\u00e3o URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "entrada", "in": "query", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "required": false, "schema": { "type": "string", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "example": "0800", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio de Ranking de Op\u00e7\u00e3o URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false } } } } } } } }, "\/ReportURA\/relatorioRankingNumeroURA": { "get": { "tags": [ "Relat\u00f3rios de URA" ], "summary": "Relat\u00f3rio de Ranking de N\u00famero URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "entrada", "in": "query", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "required": false, "schema": { "type": "string", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "example": "0800", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "opcao-ura", "in": "query", "description": "N\u00famero da op\u00e7\u00e3o discada", "required": false, "schema": { "type": "string", "description": "N\u00famero da op\u00e7\u00e3o discada", "example": "3", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio de Ranking de N\u00famero URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false } } } } } } } }, "\/ReportURA\/graficoResumoDiaURA": { "get": { "tags": [ "Relat\u00f3rios de URA" ], "summary": "Gr\u00e1fico de resumo dia URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "entrada", "in": "query", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "required": false, "schema": { "type": "string", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "example": "0800", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "opcao-ura", "in": "query", "description": "N\u00famero da op\u00e7\u00e3o discada", "required": false, "schema": { "type": "string", "description": "N\u00famero da op\u00e7\u00e3o discada", "example": "3", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Gr\u00e1fico de resumo dia URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false } } } } } } } }, "\/CachePortabilidade\/all": { "get": { "tags": [ "Portabilidade" ], "summary": "Buscar todos registros de Cache", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CachePortabilidade\/deletarComMaisDeDias": { "post": { "tags": [ "Portabilidade" ], "summary": "Deletar registros com mais de X dias em CachePortabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar registros com mais de X dias em CachePortabilidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "dias" ], "properties": { "dias": { "type": "integer", "description": "N\u00famero de dias m\u00ednimos para deletar portabilidade", "example": 30, "required": true } } } } } } } }, "\/CachePortabilidade\/deletarPorNumero": { "post": { "tags": [ "Portabilidade" ], "summary": "Deletar um registro de CachePortabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de CachePortabilidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "numero" ], "properties": { "numero": { "type": "string", "description": "N\u00famero a ser deletado", "example": "0054984080610", "required": true } } } } } } } }, "\/VoiceMail\/all": { "get": { "tags": [ "Voicemail" ], "summary": "Buscar todos VoiceMails", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/VoiceMail\/delete": { "post": { "tags": [ "Voicemail" ], "summary": "Deletar um registro de VoiceMail", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de VoiceMail", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de VoiceMail", "example": 1, "required": true } } } } } } } }, "\/VoiceMail\/get": { "get": { "tags": [ "Voicemail" ], "summary": "Buscar um registro de VoiceMail", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de VoiceMail", "required": true, "schema": { "type": "integer", "description": "ID do Registro de VoiceMail", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/VoiceMail\/persist": { "post": { "tags": [ "Voicemail" ], "summary": "Cadastrar ou Alterar um registro de VoiceMail", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de VoiceMail", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "email", "nome", "numero" ], "properties": { "attach": { "type": "string", "description": "Anexo", "example": "yes", "required": false }, "delete_option": { "type": "string", "description": "Op\u00e7\u00e3o de deletar", "example": "yes", "required": false }, "email": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": true }, "format": { "type": "string", "description": "Formato", "example": "wav", "required": false }, "id": { "type": "integer", "description": "ID do Registro de VoiceMail", "example": 1, "required": false }, "maxsecs": { "type": "integer", "description": "M\u00e1ximo de segundos para VoiceMail", "example": 600, "required": false }, "minsecs": { "type": "integer", "description": "M\u00ednimo de segundos", "example": 2, "required": false }, "nome": { "type": "string", "description": "Nome do Usuario", "example": "Bruno Leite", "required": true }, "numero": { "type": "string", "description": "N\u00famero do Voicemail", "example": "103", "required": true }, "password": { "type": "string", "description": "Senha do voicemail", "example": "1234", "required": false } } } } } } } }, "\/Configuracao\/buscarConfiguracaoDetalhada": { "get": { "tags": [ "Sistema" ], "summary": "buscarConfiguracaoDetalhada", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "buscarConfiguracaoDetalhada", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/restartMonitoramentoRamais": { "post": { "tags": [ "Sistema" ], "summary": "Reiniciar monitoramento (pm2)", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Reiniciar monitoramento (pm2)", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/atualizarConfiguracao": { "post": { "tags": [ "Sistema" ], "summary": "Atualizar configura\u00e7\u00e3o de sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atualizar configura\u00e7\u00e3o de sistema", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "ad_account_suffix", "ad_base_dn", "ad_domain_controllers", "auth", "codigo_ddi", "id_locais_cidades", "idioma", "master_email", "senha_ligacao", "sms_servico", "sms_user" ], "properties": { "ad_account_suffix": { "type": "string", "description": "Sufixo da conta", "example": "@letteldata.com.br", "required": true }, "ad_base_dn": { "type": "string", "description": "DN Base para integra\u00e7\u00e3o AD\/LDAP", "example": "DC=br,DC=letteldata", "required": true }, "ad_domain_controllers": { "type": "string", "description": "Controlador de dom\u00ednio", "example": "adldap.letteldata.com.br", "required": true }, "ad_validar_telefone": { "type": "integer", "description": "Op\u00e7\u00e3o para validar telefone no AD", "example": 1, "required": false }, "auth": { "type": null, "description": "Tipo de autentica\u00e7\u00e3o (LOCAL, AD, OpenLDAP,LDAP)", "example": "AD", "required": true }, "codigo_ddi": { "type": "integer", "description": "C\u00f3digo DDI (n\u00e3o usado)", "example": 55, "required": true }, "id_locais_cidades": { "type": "integer", "description": "ID da Cidade", "example": 4166, "required": true }, "idioma": { "type": "string", "description": "Idioma do sistema (n\u00e3o utilizado)", "example": "pt-br", "required": true }, "master_email": { "type": "string", "description": "E-mail do Administrador (n\u00e3o usado)", "example": "brunohl@teste.com.br", "required": true }, "senha_ligacao": { "type": "integer", "description": "N\u00e3o usado", "example": null, "required": true }, "sms_servico": { "type": "integer", "description": "Servi\u00e7o de SMS (1 - TALKSMS, 2 - ZENVIA, 3 - LOCAL)", "example": 2, "required": true }, "sms_user": { "type": "string", "description": "Usu\u00e1rio de API do SMS", "example": "zenvia.lettel", "required": true } } } } } } } }, "\/Configuracao\/atualizarSenhaMaster": { "post": { "tags": [ "Sistema" ], "summary": "Atualizar configura\u00e7\u00e3o de sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atualizar configura\u00e7\u00e3o de sistema", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "old", "password" ], "properties": { "old": { "type": "string", "description": "Senha antiga do usu\u00e1rio master", "example": "430950", "required": true }, "password": { "type": "string", "description": "Senha nova", "example": "349680", "required": true } } } } } } } }, "\/Configuracao\/atualizarSenhaSMS": { "post": { "tags": [ "Sistema" ], "summary": "Atualizar configura\u00e7\u00e3o de sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atualizar configura\u00e7\u00e3o de sistema", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "description": "Senha nova", "example": "349680", "required": true } } } } } } } }, "\/UsuarioPortal\/all": { "get": { "tags": [ "Usu\u00e1rios" ], "summary": "Listar usu\u00e1rios e permiss\u00f5es", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortal\/delete": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Deletar usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true } } } } } } } }, "\/UsuarioPortal\/getUsuarioPortal": { "get": { "tags": [ "Usu\u00e1rios" ], "summary": "Buscar usu\u00e1rio por ID", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de UsuarioPortal", "required": true, "schema": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortal\/alterarSenhaUsuarioPortal": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Alterar a senha de um usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Alterar a senha de um usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "password" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true }, "password": { "type": "string", "description": "Senha nova", "example": "349680", "required": true } } } } } } } }, "\/UsuarioPortal\/atrelarModulo": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Atrelar m\u00f3dulo ao usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atrelar m\u00f3dulo ao usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "idUser" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true }, "idUser": { "type": "integer", "description": "ID do usu\u00e1rio", "example": 4, "required": true } } } } } } } }, "\/UsuarioPortal\/atrelarPagina": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Atrelar m\u00f3dulo ao usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atrelar m\u00f3dulo ao usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "idUser" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true }, "idUser": { "type": "integer", "description": "ID do usu\u00e1rio", "example": 13, "required": true } } } } } } } }, "\/UsuarioPortal\/desatrelarModulo": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Desatrelar m\u00f3dulo ao usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Desatrelar m\u00f3dulo ao usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "idUser" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true }, "idUser": { "type": "integer", "description": "ID do usu\u00e1rio", "example": 13, "required": true } } } } } } } }, "\/UsuarioPortal\/desatrelarPagina": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Desatrelar p\u00e1gina ao usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Desatrelar p\u00e1gina ao usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "idUser" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": true }, "idUser": { "type": "integer", "description": "ID do usu\u00e1rio", "example": 13, "required": true } } } } } } } }, "\/UsuarioPortal\/persist": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Cadastrar usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "login", "nome", "password" ], "properties": { "api_key": { "type": "string", "description": "Chave de API", "example": "43583490583409649", "required": false }, "email": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": false }, "id": { "type": "integer", "description": "ID do Registro de UsuarioPortal", "example": 1, "required": false }, "login": { "type": "string", "description": "Login do usu\u00e1rio", "example": "bruno.leite", "required": true }, "nome": { "type": "string", "description": "Nome do Usuario", "example": "Bruno Leite", "required": true }, "numero": { "type": "string", "description": "Ramal do usu\u00e1rio", "example": "7001", "required": false }, "password": { "type": "string", "description": "Senha do usu\u00e1rio", "example": "349680", "required": true } } } } } } } }, "\/Senha\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todas Senhas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Senha\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de Senha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Senha", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Senha", "example": 1, "required": true } } } } } } } }, "\/Senha\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de Senha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Senha", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Senha", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Senha\/atrelarCategoria": { "post": { "tags": [ "Assist" ], "summary": "Atrelar senha a categoria", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atrelar senha a categoria", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "checked", "idCategoria", "idSenha" ], "properties": { "checked": { "type": "boolean", "description": "Define se op\u00e7\u00e3o \u00e9 de vincular ou desvincular", "example": true, "required": true }, "idCategoria": { "type": "integer", "description": "ID da Categoria", "example": 4, "required": true }, "idSenha": { "type": "integer", "description": "ID da Senha", "example": 6, "required": true } } } } } } } }, "\/Senha\/gerarSenhaAleatoria": { "get": { "tags": [ "Assist" ], "summary": "Gera\u00e7\u00e3o de uma senha aleat\u00f3ria", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "digitos", "in": "query", "description": "N\u00famero de d\u00edgitos para gerar senha", "required": true, "schema": { "type": "integer", "description": "N\u00famero de d\u00edgitos para gerar senha", "example": 4, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Senha\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de Senha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Senha", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "numero" ], "properties": { "extra": { "type": "string", "description": "Informa\u00e7\u00e3o extra", "example": "Senha de Jos\u00e9 Silva", "required": false }, "id": { "type": "integer", "description": "ID do Registro de Senha", "example": 1, "required": false }, "numero": { "type": "string", "description": "N\u00famero da senha", "example": "3459", "required": true } } } } } } } }, "\/SenhaCategoria\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todas Categorias de Senhas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SenhaCategoria\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de SenhaCategoria", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de SenhaCategoria", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de SenhaCategoria", "example": 1, "required": true } } } } } } } }, "\/SenhaCategoria\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de SenhaCategoria", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de SenhaCategoria", "required": true, "schema": { "type": "integer", "description": "ID do Registro de SenhaCategoria", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SenhaCategoria\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de SenhaCategoria", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de SenhaCategoria", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "id_categoria", "id_senha" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de SenhaCategoria", "example": 1, "required": true }, "id_categoria": { "type": "integer", "description": "ID da Categoria", "example": 4, "required": true }, "id_senha": { "type": "integer", "description": "ID da Senha", "example": 7, "required": true } } } } } } } }, "\/SenhaCategoria\/cadastrarTodasCategorias": { "post": { "tags": [ "Assist" ], "summary": "Atrelar categorias a uma senha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atrelar categorias a uma senha", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_senha" ], "properties": { "id_senha": { "type": "integer", "description": "ID da Senha", "example": 4, "required": true } } } } } } } }, "\/SenhaCategoria\/deletarCategoriasPorSenha": { "post": { "tags": [ "Assist" ], "summary": "Desatrelar categorias de uma senha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Desatrelar categorias de uma senha", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_senha" ], "properties": { "id_senha": { "type": "integer", "description": "ID da Senha", "example": 2, "required": true } } } } } } } }, "\/SenhaUsuario\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos Usu\u00e1rios de Senhas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SenhaUsuario\/buscarHistorico": { "get": { "tags": [ "Assist" ], "summary": "Buscar hist\u00f3rico de senha de usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de SenhaUsuario", "required": true, "schema": { "type": "integer", "description": "ID do Registro de SenhaUsuario", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SenhaUsuario\/buscarHistoricoPorSenha": { "get": { "tags": [ "Assist" ], "summary": "Buscar hist\u00f3rico por senha de usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de SenhaUsuario", "required": true, "schema": { "type": "integer", "description": "ID do Registro de SenhaUsuario", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SenhaUsuario\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de SenhaUsuario", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de SenhaUsuario", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de SenhaUsuario", "example": 1, "required": true } } } } } } } }, "\/SenhaUsuario\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de SenhaUsuario", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de SenhaUsuario", "required": true, "schema": { "type": "integer", "description": "ID do Registro de SenhaUsuario", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SenhaUsuario\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de SenhaUsuario", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de SenhaUsuario", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "data_ini", "id", "id_senha", "id_usuario" ], "properties": { "data_fim": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false }, "data_ini": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true }, "id": { "type": "integer", "description": "ID do Registro de SenhaUsuario", "example": 1, "required": true }, "id_senha": { "type": "integer", "description": "ID da Senha", "example": 1, "required": true }, "id_usuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/SenhaUsuario\/buscarPorNumeroLike": { "get": { "tags": [ "Assist" ], "summary": "Buscar um senha por um peda\u00e7o de seu n\u00famero", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o da senha para pesquisa", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o da senha para pesquisa", "example": "34", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportURA\/graficoResumoMesURA": { "get": { "tags": [ "Relat\u00f3rios de URA" ], "summary": "Gr\u00e1fico de resumo m\u00eas URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "entrada", "in": "query", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "required": false, "schema": { "type": "string", "description": "Entrada pela qual a liga\u00e7\u00e3o chegou na URA", "example": "0800", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "opcao-ura", "in": "query", "description": "N\u00famero da op\u00e7\u00e3o discada", "required": false, "schema": { "type": "string", "description": "N\u00famero da op\u00e7\u00e3o discada", "example": "2", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Gr\u00e1fico de resumo m\u00eas URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false } } } } } } } }, "\/ReportAudit\/relatorioAuditoriaPortal": { "get": { "tags": [ "Auditoria - Portal" ], "summary": "Buscar relat\u00f3rio de auditoria do portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "api", "in": "query", "description": "API utilizada", "required": false, "schema": { "type": "string", "description": "API utilizada", "example": "AMI", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "opcao-api", "in": "query", "description": "Op\u00e7\u00e3o de API usada. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Op\u00e7\u00e3o de API usada. Aceita inLike", "example": "%relatorioAuditoriaAgenda%", "required": false } }, { "name": "status", "in": "query", "description": "C\u00f3digo de status recebido (aceita %)", "required": false, "schema": { "type": "string", "description": "C\u00f3digo de status recebido (aceita %)", "example": "200", "required": false } }, { "name": "user", "in": "query", "description": "Id do us\u00e1rio a pesquisar", "required": false, "schema": { "type": "string", "description": "Id do us\u00e1rio a pesquisar", "example": "14", "required": false } }, { "name": "tempo-min", "in": "query", "description": "Tempo m\u00ednimo que a request levou para execu\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo que a request levou para execu\u00e7\u00e3o", "example": "1", "required": false } }, { "name": "dados", "in": "query", "description": "Corpo da requisi\u00e7\u00e3o (aceita %)", "required": false, "schema": { "type": "string", "description": "Corpo da requisi\u00e7\u00e3o (aceita %)", "example": "%103%", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportAudit\/relatorioAuditoriaAgenda": { "get": { "tags": [ "Auditoria - Agenda" ], "summary": "Listar auditoria do assist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "opcao-api", "in": "query", "description": "Op\u00e7\u00e3o de API usada. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Op\u00e7\u00e3o de API usada. Aceita inLike", "example": "%relatorioAuditoriaAgenda%", "required": false } }, { "name": "status", "in": "query", "description": "C\u00f3digo de status recebido (aceita %)", "required": false, "schema": { "type": "string", "description": "C\u00f3digo de status recebido (aceita %)", "example": "200", "required": false } }, { "name": "user", "in": "query", "description": "Id do us\u00e1rio a pesquisar", "required": false, "schema": { "type": "string", "description": "Id do us\u00e1rio a pesquisar", "example": "14", "required": false } }, { "name": "tempo-min", "in": "query", "description": "Tempo m\u00ednimo que a request levou para execu\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo que a request levou para execu\u00e7\u00e3o", "example": "1", "required": false } }, { "name": "dados", "in": "query", "description": "Corpo da requisi\u00e7\u00e3o (aceita %)", "required": false, "schema": { "type": "string", "description": "Corpo da requisi\u00e7\u00e3o (aceita %)", "example": "%103%", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PerguntaURA\/all": { "get": { "tags": [ "Pesquisa - URA" ], "summary": "Buscar todas Perguntas de URAs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PerguntaURA\/delete": { "post": { "tags": [ "Pesquisa - URA" ], "summary": "Deletar um registro de PerguntaURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de PerguntaURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de PerguntaURA", "example": 1, "required": true } } } } } } } }, "\/PerguntaURA\/get": { "get": { "tags": [ "Pesquisa - URA" ], "summary": "Buscar um registro de PerguntaURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de PerguntaURA", "required": true, "schema": { "type": "integer", "description": "ID do Registro de PerguntaURA", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PerguntaURA\/buscarPorPesquisa": { "get": { "tags": [ "Pesquisa - URA" ], "summary": "Buscar um pergunta por pesquisa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id_ura_pesquisa", "in": "query", "description": "ID da Pesquisa URA", "required": true, "schema": { "type": "integer", "description": "ID da Pesquisa URA", "example": 3, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PerguntaURA\/persist": { "post": { "tags": [ "Pesquisa - URA" ], "summary": "Cadastrar ou Alterar um registro de PerguntaURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de PerguntaURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "descricao", "id", "id_ura_pesquisa" ], "properties": { "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "Qual a nota que voc\u00ea d\u00e1 ao atendimento?", "required": true }, "id": { "type": "integer", "description": "ID do Registro de PerguntaURA", "example": 1, "required": true }, "id_ura_pesquisa": { "type": "integer", "description": "ID da Pesquisa URA", "example": 3, "required": true } } } } } } } }, "\/PesquisaURA\/all": { "get": { "tags": [ "Pesquisa - URA" ], "summary": "Buscar todas Pesquisas de URAs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PesquisaURA\/delete": { "post": { "tags": [ "Pesquisa - URA" ], "summary": "Deletar um registro de PesquisaURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de PesquisaURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de PesquisaURA", "example": 1, "required": true } } } } } } } }, "\/PesquisaURA\/get": { "get": { "tags": [ "Pesquisa - URA" ], "summary": "Buscar um registro de PesquisaURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de PesquisaURA", "required": true, "schema": { "type": "integer", "description": "ID do Registro de PesquisaURA", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PesquisaURA\/persist": { "post": { "tags": [ "Pesquisa - URA" ], "summary": "Cadastrar ou Alterar um registro de PesquisaURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de PesquisaURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome" ], "properties": { "data_final": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false }, "data_inicial": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "Pesquisa de Satisfa\u00e7\u00e3o", "required": false }, "id": { "type": "integer", "description": "ID do Registro de PesquisaURA", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome da Pesquisa", "example": "Pesquisa de Testes", "required": true } } } } } } } }, "\/OpcaoURA\/all": { "get": { "tags": [ "Op\u00e7\u00f5es - URA" ], "summary": "Buscar todas Op\u00e7\u00f5es de URAs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/OpcaoURA\/delete": { "post": { "tags": [ "Op\u00e7\u00f5es - URA" ], "summary": "Deletar um registro de OpcaoURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de OpcaoURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de OpcaoURA", "example": 1, "required": true } } } } } } } }, "\/OpcaoURA\/get": { "get": { "tags": [ "Op\u00e7\u00f5es - URA" ], "summary": "Buscar um registro de OpcaoURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de OpcaoURA", "required": true, "schema": { "type": "integer", "description": "ID do Registro de OpcaoURA", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/OpcaoURA\/persist": { "post": { "tags": [ "Op\u00e7\u00f5es - URA" ], "summary": "Cadastrar ou Alterar um registro de OpcaoURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de OpcaoURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome" ], "properties": { "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "Atendimento", "required": false }, "id": { "type": "integer", "description": "ID do Registro de OpcaoURA", "example": 1, "required": false }, "identificacao": { "type": "string", "description": "Identifica\u00e7\u00e3o da URA", "example": "0800", "required": false }, "nome": { "type": "string", "description": "Nome da Op\u00e7\u00e3o", "example": "Financeiro", "required": true } } } } } } } }, "\/ReportFila\/relatorioDetalhadoFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Relat\u00f3rio detalhado de Fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "agent", "in": "query", "description": "String de Agente ou Nome", "required": false, "schema": { "type": "string", "description": "String de Agente ou Nome", "example": "SIP\/7003", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "example": "00:00:00", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "status", "in": "query", "description": "Status da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Status da liga\u00e7\u00e3o", "example": "ABANDON", "required": false } }, { "name": "transfer", "in": "query", "description": "Destino de transfer\u00eancia", "required": false, "schema": { "type": "string", "description": "Destino de transfer\u00eancia", "example": "7003", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de Origem. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Canal de Origem. Aceita o tipo inLike", "example": "SIP\/vivo%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de Destino. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Canal de Destino. Aceita o tipo inLike", "example": "SIP\/700%", "required": false } }, { "name": "id-integracao", "in": "query", "description": "Id de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Id de Integra\u00e7\u00e3o", "example": "teste", "required": false } }, { "name": "custom-field", "in": "query", "description": "Id de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Id de Integra\u00e7\u00e3o", "example": "teste", "required": false } }, { "name": "protocolo", "in": "query", "description": "Protocolo da Liga\u00e7\u00e3o (v\u00e1lido se novo protocolo)", "required": false, "schema": { "type": "string", "description": "Protocolo da Liga\u00e7\u00e3o (v\u00e1lido se novo protocolo)", "example": "45645654", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/fluxogramaFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Fluxograma de uma liga\u00e7\u00e3o do CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "uniqueid", "in": "query", "description": "Uniqueid da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Uniqueid da liga\u00e7\u00e3o", "example": "123345132.123", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/graficoChamadasPorHora": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gr\u00e1fico de chamadas por hora", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data", "in": "query", "description": "Data para gerar gr\u00e1fico", "required": false, "schema": { "type": "string", "description": "Data para gerar gr\u00e1fico", "example": "2020-01-01", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "status", "in": "query", "description": "Status da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Status da liga\u00e7\u00e3o", "example": "ABANDON", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportCallback\/detalheCallback": { "get": { "tags": [ "Callback" ], "summary": "Relat\u00f3rio detalhado de Callback", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "destino", "in": "query", "description": "Destino para filtro. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Destino para filtro. Aceita inLike", "example": "%0661", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "usuario", "in": "query", "description": "Nome do usu\u00e1rio. Aceita like", "required": false, "schema": { "type": "string", "description": "Nome do usu\u00e1rio. Aceita like", "example": "Bruno", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio detalhado de Callback", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false }, "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (E - Entrada, S - Sa\u00edda, I - Interna)", "example": "S", "required": false } } } } } } } }, "\/ReportFila\/resumoFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Relat\u00f3rio Resumido de CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "group", "in": "query", "description": "Agrupar status COMPLETECALLER e COMPLETEAGENT", "required": false, "schema": { "type": "boolean", "description": "Agrupar status COMPLETECALLER e COMPLETEAGENT", "example": true, "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/relatorioRankingFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Relat\u00f3rio de Ranking de Fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "example": "00:00:00", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "status", "in": "query", "description": "Status da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Status da liga\u00e7\u00e3o", "example": "ABANDON", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SMS\/envioLote": { "post": { "tags": [ "Envio de SMS" ], "summary": "Envio de um Lote de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Envio de um Lote de SMS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "file", "mensagem", "numero" ], "properties": { "campanha": { "type": "string", "description": "Campanha", "example": "Teste", "required": false }, "file": { "type": null, "description": "Arquivo CSV com os n\u00fameros", "example": "arquivo.csv", "required": true }, "mensagem": { "type": "string", "description": "Mensagem a ser enviada", "example": "Teste", "required": true }, "numero": { "type": "string", "description": "N\u00famero para envio", "example": "0054984080610", "required": true }, "origem": { "type": "string", "description": "Origem usada a partir de ZENVIA", "example": "LETTEL", "required": false } } } } } } } }, "\/ReportFila\/evolucaoMensalFilas": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Relat\u00f3rio de evolu\u00e7\u00e3o mensal da Fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de espera no padr\u00e3o hh:mm:ss", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "status", "in": "query", "description": "Status da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Status da liga\u00e7\u00e3o", "example": "COMPLETECALLER", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportPortabilidade\/detalhePortabilidade": { "get": { "tags": [ "Portabilidade" ], "summary": "Relat\u00f3rio detalhado de Portabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "operadora", "in": "query", "description": "C\u00f3digo da operadora", "required": false, "schema": { "type": "string", "description": "C\u00f3digo da operadora", "example": "5554", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "status", "in": "query", "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o", "example": "ANSWERED", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio detalhado de Portabilidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "tipo-consulta": { "type": null, "description": "Tipo da consulta (CACHE, LOCAL)", "example": "CACHE", "required": false } } } } } } } }, "\/ReportPortabilidade\/graficoPortabilidade": { "get": { "tags": [ "Portabilidade" ], "summary": "Gr\u00e1fico de portabilidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Gr\u00e1fico de portabilidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "tipo-consulta": { "type": null, "description": "Tipo da consulta (CACHE, LOCAL)", "example": "CACHE", "required": false } } } } } } } }, "\/Contato\/getOpcoesTiposContato": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTiposContato", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTiposContato", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/GrupoPresenca\/getOpcoesGruposSelect": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesGruposSelect", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesGruposSelect", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/LocalPresenca\/getOpcoesLocais": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesLocais", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesLocais", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportSMS\/getOpcoesTiposSMS": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTiposSMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTiposSMS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Portabilidade\/getOpcoesOperadoras": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesOperadoras", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesOperadoras", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Modulo\/getOpcoesModulos": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesModulos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesModulos", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportAudit\/getOpcoesAPIs": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesAPIs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesAPIs", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportAudit\/getOpcoesUsuariosAgenda": { "get": { "tags": [ "Sistema" ], "summary": "Buscar usuarios agenda", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar usuarios agenda", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportAudit\/getOpcoesUsuariosPortal": { "get": { "tags": [ "Sistema" ], "summary": "Buscar usuarios portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar usuarios portal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Situacao\/getOpcoesSituacao": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesSituacao", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesSituacao", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/TipoPagina\/getOpcoesTipoPagina": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTipoPagina", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTipoPagina", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportCDR\/getOpcoesDispositions": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesDispositions", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesDispositions", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportCDR\/getOpcoesTipos": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTipos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTipos", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/PesquisaURA\/getOpcoesPesquisasURA": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesPesquisasURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesPesquisasURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/OpcaoURA\/getOpcoesOpcoesURA": { "get": { "tags": [ "Op\u00e7\u00f5es - URA" ], "summary": "Buscar op\u00e7\u00f5es da URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar op\u00e7\u00f5es da URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportFila\/getOpcoesQueues": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesQueues", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesQueues", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Cidade\/getOpcoesPorNomeLike": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesPorNomeLike", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesPorNomeLike", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportFila\/getOpcoesStatusFilas": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesStatusFilas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesStatusFilas", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/CategoriaLigacao\/buscarCategoriasPorIdSenha": { "get": { "tags": [ "Assist" ], "summary": "Buscar categorias por senha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de CategoriaLigacao", "required": true, "schema": { "type": "integer", "description": "ID do Registro de CategoriaLigacao", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Modulo\/getMenu": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getMenu", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getMenu", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportFila\/graficoStatusFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gr\u00e1fico de status Fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "group", "in": "query", "description": "Agrupar status COMPLETECALLER e COMPLETEAGENT", "required": false, "schema": { "type": "boolean", "description": "Agrupar status COMPLETECALLER e COMPLETEAGENT", "example": true, "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Canal\/all": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar todos Canais", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Canal\/persist": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Cadastrar ou Alterar um registro de Canal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Canal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "codigo", "id", "id_conta" ], "properties": { "codigo": { "type": "string", "description": "C\u00f3digo do canal para identificar em liga\u00e7\u00f5es", "example": "Khomp\/B0C1", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Canal", "example": 1, "required": true }, "id_conta": { "type": "integer", "description": "ID da Conta", "example": 3, "required": true }, "numero": { "type": "string", "description": "N\u00famero vinculado ao Canal", "example": "54 9 8408 0610", "required": false } } } } } } } }, "\/Canal\/delete": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Deletar um registro de Canal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Canal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Canal", "example": 1, "required": true } } } } } } } }, "\/Canal\/get": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar um registro de Canal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Canal", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Canal", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Conta\/all": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar todas Contas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Conta\/delete": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Deletar um registro de Conta", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Conta", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Conta", "example": 1, "required": true } } } } } } } }, "\/Conta\/get": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar um registro de Conta", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Conta", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Conta", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Conta\/persist": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Cadastrar ou Alterar um registro de Conta", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Conta", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "id_operadora" ], "properties": { "cnpj": { "type": "string", "description": "CNPJ", "example": "66.667.621\/0001-31", "required": false }, "codigo_cliente": { "type": "string", "description": "C\u00f3digo do Cliente na Conta", "example": "23034950934", "required": false }, "data_final": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false }, "data_inicial": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false }, "data_vencimento": { "type": "integer", "description": "Dia de vencimento", "example": 7, "required": false }, "extra": { "type": "string", "description": "Informa\u00e7\u00e3o extra referente a conta", "example": "Conta da Matriz", "required": false }, "id": { "type": "integer", "description": "ID do Registro de Conta", "example": 1, "required": true }, "id_operadora": { "type": "integer", "description": "ID da Operadora", "example": 56, "required": true }, "nome_cliente": { "type": "string", "description": "Nome do Cliente na Conta", "example": "LETTEL DATA", "required": false }, "numero_chave": { "type": "string", "description": "N\u00famero chave referente a conta", "example": "54-3046-8100", "required": false } } } } } } } }, "\/Operadora\/all": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar todas Operadoras", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Operadora\/persist": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Cadastrar ou Alterar um registro de Operadora", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Operadora", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "codigo", "nome" ], "properties": { "codigo": { "type": "string", "description": "C\u00f3digo da operadora", "example": "230490", "required": true }, "discagem": { "type": "string", "description": "Regra de Discagem da Operadora", "example": "015", "required": false }, "id": { "type": "integer", "description": "ID do Registro de Operadora", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome da Operadora", "example": "Vivo", "required": true }, "numero": { "type": "string", "description": "N\u00famero usado pela operadora", "example": "015", "required": false } } } } } } } }, "\/Operadora\/delete": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Deletar um registro de Operadora", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Operadora", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Operadora", "example": 1, "required": true } } } } } } } }, "\/Operadora\/get": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar um registro de Operadora", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Operadora", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Operadora", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Tarifa\/all": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar todas Tarifas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Tarifa\/delete": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Deletar um registro de Tarifa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Tarifa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Tarifa", "example": 1, "required": true } } } } } } } }, "\/Tarifa\/get": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar um registro de Tarifa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Tarifa", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Tarifa", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Report\/buscarGravacao": { "get": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Buscar grava\u00e7\u00e3o de uma liga\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "uniqueid", "in": "query", "description": "Uniqueid da liga\u00e7\u00e3o", "required": true, "schema": { "type": "string", "description": "Uniqueid da liga\u00e7\u00e3o", "example": "123345132.123", "required": true } }, { "name": "now", "in": "query", "description": "Define se quer receber a grava\u00e7\u00e3o agora (now ou nonce)", "required": false, "schema": { "type": "string", "description": "Define se quer receber a grava\u00e7\u00e3o agora (now ou nonce)", "example": "now", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UF\/getOpcoesUFs": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesUFs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesUFs", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Area\/getOpcoesAreas": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesAreas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesAreas", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Dia\/get": { "get": { "tags": [ "Sistema" ], "summary": "Buscar dias \/ feriados por id", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Dia", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Dia", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Dia\/all": { "get": { "tags": [ "Sistema" ], "summary": "Listar dias \/ feriados", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Dia\/buscarMarcos": { "get": { "tags": [ "Sistema" ], "summary": "Buscar marcos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data", "in": "query", "description": "Data para buscar marco", "required": true, "schema": { "type": "string", "description": "Data para buscar marco", "example": "2010-01-01", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Dia\/buscarPorData": { "get": { "tags": [ "Sistema" ], "summary": "Buscar por data", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data", "in": "query", "description": "Data para buscar marco", "required": true, "schema": { "type": "string", "description": "Data para buscar marco", "example": "2010-01-01", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DiaSemana\/get": { "get": { "tags": [ "Sistema" ], "summary": "Buscar dia da semana (id)", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de DiaSemana", "required": true, "schema": { "type": "integer", "description": "ID do Registro de DiaSemana", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DiaSemana\/all": { "get": { "tags": [ "Sistema" ], "summary": "Buscar dias da semana", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Marco\/get": { "get": { "tags": [ "Sistema" ], "summary": "Buscar marco por id", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Marco", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Marco", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Marco\/all": { "get": { "tags": [ "Sistema" ], "summary": "Buscar todos marcos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Marco\/persist": { "post": { "tags": [ "Sistema" ], "summary": "Cadastrar um marco", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar um marco", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "descricao", "flexibilidade", "id", "nivel", "tipo" ], "properties": { "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "7 de Setembro", "required": true }, "flexibilidade": { "type": null, "description": "Tipo da flexibilidade (Fixo,M\u00f3vel,M\u00e9dio)", "example": "Fixo", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Marco", "example": 1, "required": true }, "id_locais_cidades": { "type": "integer", "description": "ID da Cidade", "example": 4166, "required": false }, "id_locais_ufs": { "type": "integer", "description": "ID da UF", "example": 20, "required": false }, "mes_dia": { "type": "string", "description": "M\u00eas dia do marco", "example": "25-01", "required": false }, "nivel": { "type": null, "description": "N\u00edvel do marco (Municipal,Estadual,Nacional)", "example": "Nacional", "required": true }, "tipo": { "type": null, "description": "Tipo do Marco (Feriado,Ponto Facultativo,Data Comemorativa)", "example": "Feriado", "required": true } } } } } } } }, "\/Marco\/delete": { "post": { "tags": [ "Sistema" ], "summary": "Deletar marco", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar marco", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Marco", "example": 1, "required": true } } } } } } } }, "\/Marco\/buscarMarcosMoveisPorId": { "get": { "tags": [ "Sistema" ], "summary": "Buscar marco m\u00f3vel por id", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Marco", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Marco", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Marco\/persistMarcoMovel": { "post": { "tags": [ "Sistema" ], "summary": "persistMarcoMovel", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "persistMarcoMovel", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "data", "id_datas_marcos" ], "properties": { "data": { "type": "string", "description": "Data para marco", "example": "2020-01-01", "required": true }, "id_datas_marcos": { "type": "integer", "description": "ID do marco", "example": 123, "required": true } } } } } } } }, "\/Marco\/deleteMarcoMovel": { "post": { "tags": [ "Sistema" ], "summary": "deleteMarcoMovel", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "deleteMarcoMovel", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Marco", "example": 1, "required": true } } } } } } } }, "\/Operadora\/getOpcoesPorNomeLike": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesPorNomeLike", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o de nome de operadora", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o de nome de operadora", "example": "Vivo", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Conta\/getOpcoesConta": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesConta", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesConta", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Tarifa\/buscarPorConta": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar por Tarifa por Conta", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "idConta", "in": "query", "description": "ID da Conta", "required": true, "schema": { "type": "integer", "description": "ID da Conta", "example": 5, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CategoriaLigacao\/buscarCategoriaLigacaoSelect": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - buscarCategoriaLigacaoSelect", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - buscarCategoriaLigacaoSelect", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Tarifa\/persist": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Cadastrar uma Tarifa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar uma Tarifa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "custo", "data_inicial", "id", "id_categoria_ligacao", "id_conta", "regra", "tipo" ], "properties": { "conexao": { "type": "integer", "description": "Tempo de conex\u00e3o", "example": 1, "required": false }, "custo": { "type": "integer", "description": "Custo da Tarifa", "example": null, "required": true }, "data_final": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false }, "data_inicial": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Tarifa", "example": 1, "required": true }, "id_categoria_ligacao": { "type": "integer", "description": "ID da Categoria da Liga\u00e7\u00e3o", "example": 4, "required": true }, "id_conta": { "type": "integer", "description": "ID da Conta", "example": 3, "required": true }, "id_operadora_destino": { "type": "integer", "description": "ID da Operadora de Destino", "example": 4, "required": false }, "minimo": { "type": "integer", "description": "Tempo m\u00ednimo em segundos para considerar", "example": 1, "required": false }, "regra": { "type": "integer", "description": "Tempo para primeira tarifa (0.5, 0.1, 1.0)", "example": null, "required": true }, "tipo": { "type": null, "description": "Tipo da tarifa (E, I ou S - s\u00f3 aceita S por hora)", "example": "S", "required": true } } } } } } } }, "\/GrupoPresenca\/buscarCC": { "get": { "tags": [ "Assist" ], "summary": "Buscar Usu\u00e1rios de um Centro de Custo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "active", "in": "query", "description": "Define se buscar CC ativo ou n\u00e3o", "required": false, "schema": { "type": "boolean", "description": "Define se buscar CC ativo ou n\u00e3o", "example": true, "required": false } }, { "name": "id", "in": "query", "description": "ID do Registro de GrupoPresenca", "required": true, "schema": { "type": "integer", "description": "ID do Registro de GrupoPresenca", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioCC\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos registros de UsuarioCC", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioCC\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de UsuarioCC", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de UsuarioCC", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de UsuarioCC", "example": 1, "required": true } } } } } } } }, "\/UsuarioCC\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de UsuarioCC", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de UsuarioCC", "required": true, "schema": { "type": "integer", "description": "ID do Registro de UsuarioCC", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioCC\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de UsuarioCC", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de UsuarioCC", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "data_final", "data_inicial", "id", "id_grupo", "id_usuario" ], "properties": { "data_final": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": true }, "data_inicial": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true }, "id": { "type": "integer", "description": "ID do Registro de UsuarioCC", "example": 1, "required": true }, "id_grupo": { "type": "integer", "description": "ID do CC do Usu\u00e1rio", "example": 4, "required": true }, "id_usuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/RamalUsuario\/buscarHistorico": { "get": { "tags": [ "Assist" ], "summary": "Buscar hist\u00f3rico de ramal de usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de RamalUsuario", "required": true, "schema": { "type": "integer", "description": "ID do Registro de RamalUsuario", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalUsuario\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos Usu\u00e1rios de Ramal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalUsuario\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de RamaUsuario", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de RamaUsuario", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de RamalUsuario", "example": 1, "required": true } } } } } } } }, "\/RamalUsuario\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de RamalUsuario", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de RamalUsuario", "required": true, "schema": { "type": "integer", "description": "ID do Registro de RamalUsuario", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalUsuario\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de RamalUsuario", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de RamalUsuario", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "data_inicial", "id", "id_usuario", "ramal" ], "properties": { "data_final": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false }, "data_inicial": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true }, "id": { "type": "integer", "description": "ID do Registro de RamalUsuario", "example": 1, "required": true }, "id_usuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true }, "ramal": { "type": "string", "description": "Ramal do usu\u00e1rio", "example": "100", "required": true } } } } } } } }, "\/UsuarioPortal\/montarArvorePermissoes": { "get": { "tags": [ "Sistema" ], "summary": "Montar a \u00e1rvore de permiss\u00f5es", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Usu\u00e1rio ou Role", "required": true, "schema": { "type": "integer", "description": "ID do Usu\u00e1rio ou Role", "example": 1, "required": true } }, { "name": "origin", "in": "query", "description": "Origem (user ou role)", "required": true, "schema": { "type": "string", "description": "Origem (user ou role)", "example": "role", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortal\/getOpcoesUsuarioSelect": { "get": { "tags": [ "Sistema" ], "summary": "Buscar usuarios para select", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar usuarios para select", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/API\/removerAPIUser": { "post": { "tags": [ "Sistema" ], "summary": "removerAPIUser", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "removerAPIUser", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_api", "id_user" ], "properties": { "id_api": { "type": "integer", "description": "ID do API", "example": 5, "required": true }, "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/API\/inserirAPIUser": { "post": { "tags": [ "Sistema" ], "summary": "inserirAPIUser", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "inserirAPIUser", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_api", "id_user" ], "properties": { "id_api": { "type": "integer", "description": "ID do API", "example": 5, "required": true }, "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/Pagina\/inserirPaginaUser": { "post": { "tags": [ "Sistema" ], "summary": "inserirPaginaUser", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "inserirPaginaUser", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_pagina", "id_user" ], "properties": { "id_pagina": { "type": "integer", "description": "ID da P\u00e1gina", "example": 68, "required": true }, "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/Pagina\/removerPaginaUser": { "post": { "tags": [ "Sistema" ], "summary": "removerPaginaUser", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "removerPaginaUser", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_pagina", "id_user" ], "properties": { "id_pagina": { "type": "integer", "description": "ID da P\u00e1gina", "example": 68, "required": true }, "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/Modulo\/removerModuloUser": { "post": { "tags": [ "Sistema" ], "summary": "removerModuloUser", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "removerModuloUser", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_modulo", "id_user" ], "properties": { "id_modulo": { "type": "integer", "description": "ID do M\u00f3dulo", "example": 3, "required": true }, "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/Modulo\/inserirModuloUser": { "post": { "tags": [ "Sistema" ], "summary": "inserirModuloUser", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "inserirModuloUser", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_modulo", "id_user" ], "properties": { "id_modulo": { "type": "integer", "description": "ID do M\u00f3dulo", "example": 3, "required": true }, "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } } } } } } }, "\/UsuarioPortal\/liberarPermissaoTotalUser": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Liberar permiss\u00e3o total", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Liberar permiss\u00e3o total", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_user", "tipo" ], "properties": { "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio ou Papel", "example": 11, "required": true }, "tipo": { "type": "string", "description": "Tipo da Altera\u00e7\u00e3o (user ou role)", "example": "user", "required": true } } } } } } } }, "\/UsuarioPortal\/revogarPermissaoTotalUser": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "Revogar permiss\u00e3o total", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Revogar permiss\u00e3o total", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_user", "tipo" ], "properties": { "id_user": { "type": "integer", "description": "ID do Usu\u00e1rio ou Papel", "example": 11, "required": true }, "tipo": { "type": "string", "description": "Tipo da Altera\u00e7\u00e3o (user ou role)", "example": "role", "required": true } } } } } } } }, "\/ReportTarifador\/relatorioDetalhadoTarifador": { "get": { "tags": [ "Relat\u00f3rios de Tarifa\u00e7\u00e3o" ], "summary": "Relat\u00f3rio Detalhado do Tarifador", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "categorias", "in": "query", "description": "Array de ids de categorias", "required": false, "schema": { "type": "array", "description": "Array de ids de categorias", "example": null, "required": false, "items": { "type": "string" } } }, { "name": "custom", "in": "query", "description": "Custo m\u00ednimo", "required": false, "schema": { "type": "integer", "description": "Custo m\u00ednimo", "example": null, "required": false } }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario_comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id_cc", "in": "query", "description": "ID do Callcenter", "required": false, "schema": { "type": "integer", "description": "ID do Callcenter", "example": 2, "required": false } }, { "name": "id_conta", "in": "query", "description": "ID da Conta", "required": false, "schema": { "type": "integer", "description": "ID da Conta", "example": 3, "required": false } }, { "name": "id_usuario", "in": "query", "description": "Array de IDs de usu\u00e1rios para buscar", "required": false, "schema": { "type": "array", "description": "Array de IDs de usu\u00e1rios para buscar", "example": null, "required": false, "items": { "type": "string" } } }, { "name": "localidade", "in": "query", "description": "Array de IDs de localidades para buscar", "required": false, "schema": { "type": "array", "description": "Array de IDs de localidades para buscar", "example": null, "required": false, "items": { "type": "string" } } }, { "name": "numero", "in": "query", "description": "Numero para pesquisa. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Numero para pesquisa. Aceita inLike", "example": "54984080610", "required": false } }, { "name": "ramal", "in": "query", "description": "N\u00famero do Ramal. Aceita inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero do Ramal. Aceita inLike", "example": "7001,7002", "required": false } }, { "name": "status", "in": "query", "description": "ID do Status da Liga\u00e7\u00e3o", "required": false, "schema": { "type": "integer", "description": "ID do Status da Liga\u00e7\u00e3o", "example": 2, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportTarifador\/rateioTarifacao": { "get": { "tags": [ "Relat\u00f3rios de Tarifa\u00e7\u00e3o" ], "summary": "Rateio de Liga\u00e7\u00f5es do Tarifador", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "categoria_ligacao", "in": "query", "description": "Array de ids de categorias", "required": false, "schema": { "type": "array", "description": "Array de ids de categorias", "example": null, "required": false, "items": { "type": "string" } } }, { "name": "custo", "in": "query", "description": "Custo total do Rateio", "required": true, "schema": { "type": "integer", "description": "Custo total do Rateio", "example": 3200, "required": true } }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": true, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": true } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": true, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true } }, { "name": "id_conta", "in": "query", "description": "ID da Conta", "required": true, "schema": { "type": "integer", "description": "ID da Conta", "example": 3, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Rateio de Liga\u00e7\u00f5es do Tarifador", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo" ], "properties": { "tipo": { "type": null, "description": "Tipo de registro (group ou user)", "example": "group", "required": true } } } } } } } }, "\/Ligacao\/retarifarLigacoesPorIds": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Realiza o posicionamento para retarifa\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Realiza o posicionamento para retarifa\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "string", "description": "IDs para retarifar separado por v\u00edrgula", "example": "1,3,4", "required": true } } } } } } } }, "\/Ligacao\/retarifarLigacoesPorErro": { "post": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Realiza a retarifa\u00e7\u00e3o por erro", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Realiza a retarifa\u00e7\u00e3o por erro", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "idErro" ], "properties": { "idErro": { "type": "integer", "description": "ID do Erro", "example": 5, "required": true } } } } } } } }, "\/ReportTarifador\/dadosLigacoes": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar dados das liga\u00e7\u00f5es tarifadas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar dados das liga\u00e7\u00f5es tarifadas", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/getStatusServer": { "get": { "tags": [ "Sistema" ], "summary": "Buscar status dos servi\u00e7os do servidor", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar status dos servi\u00e7os do servidor", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportSMS\/relatorioDetalhadoLocalSMS": { "get": { "tags": [ "Envio de SMS" ], "summary": "Relat\u00f3rio Detalhado de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "campanha", "in": "query", "description": "Id da Campanha", "required": false, "schema": { "type": "integer", "description": "Id da Campanha", "example": 45, "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "mensagem", "in": "query", "description": "Filtro pela mensagem, aceita inLike", "required": false, "schema": { "type": "string", "description": "Filtro pela mensagem, aceita inLike", "example": "%teste%", "required": false } }, { "name": "numero", "in": "query", "description": "Numero para pesquisa. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Numero para pesquisa. Aceita inLike", "example": "54984080610", "required": false } }, { "name": "status", "in": "query", "description": "Status do envio", "required": false, "schema": { "type": "integer", "description": "Status do envio", "example": 3, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportSMS\/getOpcoesCampanhasSMS": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesCampanhasSMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesCampanhasSMS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportSMS\/getOpcoesStatusSMS": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesStatusSMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesStatusSMS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/CampanhaSMS\/all": { "get": { "tags": [ "Envio de SMS" ], "summary": "Buscar todos registros de Campanha de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CampanhaSMS\/delete": { "post": { "tags": [ "Envio de SMS" ], "summary": "Deletar um registro de Campanha de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Campanha de SMS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de CampanhaSMS", "example": 1, "required": true } } } } } } } }, "\/CampanhaSMS\/get": { "get": { "tags": [ "Envio de SMS" ], "summary": "Buscar um registro de Campanha de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de CampanhaSMS", "required": true, "schema": { "type": "integer", "description": "ID do Registro de CampanhaSMS", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CampanhaSMS\/persist": { "post": { "tags": [ "Envio de SMS" ], "summary": "Cadastrar ou Alterar um registro de Campanha de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Campanha de SMS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "data_inicial", "nome" ], "properties": { "data_final": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false }, "data_inicial": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true }, "dias_aguardar": { "type": "integer", "description": "Dias para aguardar resposta", "example": 2, "required": false }, "id": { "type": "integer", "description": "ID do Registro de CampanhaSMS", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome da Campanha", "example": "Ativa\u00e7\u00e3o Junho", "required": true } } } } } } } }, "\/ReportCallback\/rankingCallback": { "get": { "tags": [ "Callback" ], "summary": "Relat\u00f3rio de Ranking de Callback", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "destino", "in": "query", "description": "Destino para filtro. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Destino para filtro. Aceita inLike", "example": "%0661", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportSMS\/relatorioRecebimentoSMS": { "get": { "tags": [ "Envio de SMS" ], "summary": "Relat\u00f3rio detalhado de Entrada de SMS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "canal", "in": "query", "description": "Canal pelo qual foi recebido SMS, Aceita like", "required": false, "schema": { "type": "string", "description": "Canal pelo qual foi recebido SMS, Aceita like", "example": "Khomp\/B0C0", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "numero", "in": "query", "description": "Numero para pesquisa. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Numero para pesquisa. Aceita inLike", "example": "%342%", "required": false } }, { "name": "texto", "in": "query", "description": "Texto do SMS recebido. Aceita like", "required": false, "schema": { "type": "string", "description": "Texto do SMS recebido. Aceita like", "example": "resposta de sms", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/relatorioDetalhadoIndicadores": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Relat\u00f3rio detalhado de Indicadores", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de Destino. Aceita like", "required": false, "schema": { "type": "string", "description": "Canal de Destino. Aceita like", "example": "SIP\/70%", "required": false } }, { "name": "extra", "in": "query", "description": "Campo extra para filtro", "required": false, "schema": { "type": "string", "description": "Campo extra para filtro", "example": "001-001", "required": false } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "id_integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "numero", "in": "query", "description": "Numero para pesquisa. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Numero para pesquisa. Aceita inLike", "example": "54984080610", "required": false } }, { "name": "ramal", "in": "query", "description": "N\u00famero do Ramal. Aceita inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero do Ramal. Aceita inLike", "example": "7001,7002", "required": false } }, { "name": "tempo_min", "in": "query", "description": "Tempo m\u00ednimo para considerar liga\u00e7\u00f5es (segundos)", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo para considerar liga\u00e7\u00f5es (segundos)", "example": -1, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/relatorioIndicadores": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Relat\u00f3rios de Indicadores de Ramais", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "ramais_excluir", "in": "query", "description": "Lista de ramais para remover do relat\u00f3rio, separados por v\u00edrgula", "required": false, "schema": { "type": "string", "description": "Lista de ramais para remover do relat\u00f3rio, separados por v\u00edrgula", "example": "7001,7002", "required": false } }, { "name": "ramais_manter", "in": "query", "description": "Lista de ramais para manter no relat\u00f3rio, separados por v\u00edrgula", "required": false, "schema": { "type": "string", "description": "Lista de ramais para manter no relat\u00f3rio, separados por v\u00edrgula", "example": "7003,7004", "required": false } }, { "name": "tempo_min", "in": "query", "description": "Tempo m\u00ednimo para considerar liga\u00e7\u00f5es (segundos)", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo para considerar liga\u00e7\u00f5es (segundos)", "example": -1, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rios de Indicadores de Ramais", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (entrada, saida ou em branco para tudo)", "example": "entrada", "required": false } } } } } } } }, "\/UsuarioPresenca\/validarIntegracao": { "get": { "tags": [ "Sistema" ], "summary": "Validar integra\u00e7\u00e3o com AD\/LDAP", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Validar integra\u00e7\u00e3o com AD\/LDAP", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportBlacklist\/detalheBlacklist": { "get": { "tags": [ "Blacklist" ], "summary": "Relat\u00f3rio detalhado de Blacklist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "nome", "in": "query", "description": "Nome do Registro", "required": false, "schema": { "type": "string", "description": "Nome do Registro", "example": "Bruno Leite", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Relat\u00f3rio detalhado de Blacklist", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "situacao": { "type": null, "description": "Situa\u00e7\u00e3o da liga\u00e7\u00e3o (Pode ser: ANSWERED, NO ANSWER, BUSY, FAILED, CHANUNAVAIL, CONGESTION, CANCEL, DONTCALL, TORTURE, INVALIDARGS, NOANSWER)", "example": "ANSWERED", "required": false }, "tipo": { "type": null, "description": "Tipo da liga\u00e7\u00e3o (E - Entrada, S - Sa\u00edda, I - Interna)", "example": "E", "required": false } } } } } } } }, "\/TecnologiaDiscagem\/getOpcoesTecnologiaDiscagem": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTecnologiaDiscagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTecnologiaDiscagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RotaDiscagem\/getOpcoesRotaDiscagem": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesRotaDiscagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesRotaDiscagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/TipoDiscagem\/getOpcoesTipoDiscagem": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTipoDiscagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTipoDiscagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioCC\/buscarCCsPorUser": { "get": { "tags": [ "Assist" ], "summary": "Buscar os Centros de Custo de um Usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id_usuario", "in": "query", "description": "ID do Usu\u00e1rio", "required": true, "schema": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/GrupoPresenca\/buscarPorNomeLike": { "get": { "tags": [ "Assist" ], "summary": "Buscar um Centro de Custo por Um Peda\u00e7o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o do nome do grupo para pesquisa", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o do nome do grupo para pesquisa", "example": "comer", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Conta\/buscarPorNomeLike": { "get": { "tags": [ "Tarifa\u00e7\u00e3o" ], "summary": "Buscar uma conta pelo extra", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o do nome da conta para pesquisa", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o do nome da conta para pesquisa", "example": "Viv", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/VariavelURA\/getOpcoesVariavelURA": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesVariavelURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesVariavelURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/CategoriaVariavelURA\/getOpcoesCategoriaVariavelURA": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesCategoriaVariavelURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesCategoriaVariavelURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/TipoValorURA\/getOpcoesTipoValorURA": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesTipoValorURA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesTipoValorURA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/CategoriaVariavelURA\/getOpcoesCategoriaSubMenu": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesCategoriaSubMenu", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesCategoriaSubMenu", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportURA\/relatorioDetalhadoPesquisaURAEntrada": { "get": { "tags": [ "Pesquisa - URA" ], "summary": "Relat\u00f3rio de Pesquisa da URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "numero", "in": "query", "description": "Numero para pesquisa. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Numero para pesquisa. Aceita inLike", "example": "%0610", "required": false } }, { "name": "pesquisa", "in": "query", "description": "ID da Pesquisa", "required": false, "schema": { "type": "integer", "description": "ID da Pesquisa", "example": 4, "required": false } }, { "name": "ramal", "in": "query", "description": "N\u00famero do Ramal. Aceita inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero do Ramal. Aceita inLike", "example": "7001,7002", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/SMS\/envioLoteCSV": { "post": { "tags": [ "Envio de SMS" ], "summary": "Envio de lote de CSV", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Envio de lote de CSV", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "mensagem", "numero" ], "properties": { "campanha": { "type": "string", "description": "Campanha", "example": "Teste", "required": false }, "file": { "type": null, "description": "Arquivo CSV com os n\u00fameros", "example": "arquivo.csv", "required": false }, "mensagem": { "type": "string", "description": "Mensagem para envio em lote, aceita vari\u00e1veis", "example": "Teste de envio", "required": true }, "numero": { "type": "string", "description": "N\u00famero para envio", "example": "0054984080610", "required": true }, "origem": { "type": "string", "description": "Origem para definir a mensagem (s\u00f3 Zenvia)", "example": "LETTEL", "required": false } } } } } } } }, "\/LigacaoAutomatica\/executarLigacaoAudio": { "post": { "tags": [ "Liga\u00e7\u00f5es" ], "summary": "Executar liga\u00e7\u00e3o com \u00e1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Executar liga\u00e7\u00e3o com \u00e1udio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "audio", "numero" ], "properties": { "audio": { "type": "string", "description": "Caminho do \u00e1udio para executar na hora da liga\u00e7\u00e3o. Sem extens\u00e3o", "example": "\/tmp\/watson-tts\/0f2db8dbe00b429b7243ba071f7b8520ed557623", "required": true }, "callerid": { "type": "string", "description": "Callerid do chamador", "example": "100", "required": false }, "contexto": { "type": "string", "description": "Contexto para executar liga\u00e7\u00e3o", "example": "interno-ramais", "required": false }, "id_integracao": { "type": "string", "description": "ID para armazenar como Integra\u00e7\u00e3o", "example": "34059", "required": false }, "numero": { "type": "string", "description": "N\u00famero para ligar", "example": "0054984080610", "required": true }, "origem_integracao": { "type": "string", "description": "Texto para armazenar como Integra\u00e7\u00e3o", "example": "Liga\u00e7\u00e3o de Teste", "required": false }, "texto_integracao": { "type": "string", "description": "Informa\u00e7\u00e3o gravada no report", "example": "Bruno Leite", "required": false } } } } } } } }, "\/LigacaoAutomatica\/executarLigacaoTTS": { "post": { "tags": [ "Liga\u00e7\u00f5es" ], "summary": "Executar liga\u00e7\u00e3o com TTS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Executar liga\u00e7\u00e3o com TTS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "numero", "texto" ], "properties": { "callerid": { "type": "string", "description": "Callerid do chamador", "example": "100", "required": false }, "contexto": { "type": "string", "description": "Contexto para executar liga\u00e7\u00e3o", "example": "interno-ramais", "required": false }, "id_integracao": { "type": "string", "description": "ID de Integra\u00e7\u00e3o para registro", "example": "34590", "required": false }, "numero": { "type": "string", "description": "N\u00famero para ligar", "example": "0054984080610", "required": true }, "origem_integracao": { "type": "string", "description": "Origem da Integra\u00e7\u00e3o", "example": "TESTE", "required": false }, "texto": { "type": "string", "description": "Texto a ser falado pelo TTS", "example": "Este \u00e9 um teste", "required": true }, "texto_integracao": { "type": "string", "description": "Informa\u00e7\u00e3o gravada no report", "example": "Bruno Leite", "required": false } } } } } } } }, "\/LigacaoAutomatica\/executarLigacaoNumero": { "post": { "tags": [ "Liga\u00e7\u00f5es" ], "summary": "Executar liga\u00e7\u00e3o autom\u00e1tica", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Executar liga\u00e7\u00e3o autom\u00e1tica", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "destino", "origem" ], "properties": { "agente_integracao": { "type": "string", "description": "Agente de Integra\u00e7\u00e3o", "example": "bruno.leite", "required": false }, "callerid": { "type": "string", "description": "Callerid do chamador", "example": "100", "required": false }, "contexto": { "type": "string", "description": "Contexto para executar liga\u00e7\u00e3o", "example": "interno-ramais", "required": false }, "destino": { "type": "string", "description": "N\u00famero de destino", "example": "0054984080610", "required": true }, "id_integracao": { "type": "string", "description": "ID para armazenar como Integra\u00e7\u00e3o", "example": "34059", "required": false }, "normalizar_numeros": { "type": "boolean", "description": "Define se n\u00fameros ser\u00e3o normalizados para caracteres especiais", "example": true, "required": false }, "normalizar_zero": { "type": "boolean", "description": "Define se n\u00fameros ser\u00e3o normalizados para caracteres zeros", "example": null, "required": false }, "origem": { "type": "string", "description": "Origem da Liga\u00e7\u00e3o", "example": "7003", "required": true }, "origem_integracao": { "type": "string", "description": "Origem da Integra\u00e7\u00e3o", "example": "TESTE", "required": false }, "texto_integracao": { "type": "string", "description": "Informa\u00e7\u00e3o gravada no report", "example": "Bruno Leite", "required": false }, "timeout": { "type": "integer", "description": "Tempo para timeout, em (ms). Padr\u00e3o 30000", "example": 30000, "required": false }, "async": { "type": "boolean", "description": "Define se liga\u00e7\u00e3o ser\u00e1 async ou sync", "example": true, "required": false }, "variable": { "type": "string", "description": "Define valor para variavel a ser adicionada", "example": "mesa=true", "required": false } } } } } } } }, "\/ReportCanais\/relatorioResumoDeCanais": { "get": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Relat\u00f3rio de Uso de Canais", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "canais", "in": "query", "description": "Canais separados por \",\". Para canais sequenciais, separe com \"-\".- SIP\/gvt<\/b>: Liga\u00e7\u00f5es da rota SIP\/gvt - Khomp\/B0C0,Khomp\/B0C1<\/b>: Liga\u00e7\u00f5es de 2 troncos Khomp - Khomp\/B0C0-Khomp\/B0C29<\/b>: Liga\u00e7\u00e3o de E1 Khomp", "required": true, "schema": { "type": "string", "description": "Canais separados por \",\". Para canais sequenciais, separe com \"-\".- SIP\/gvt<\/b>: Liga\u00e7\u00f5es da rota SIP\/gvt - Khomp\/B0C0,Khomp\/B0C1<\/b>: Liga\u00e7\u00f5es de 2 troncos Khomp - Khomp\/B0C0-Khomp\/B0C29<\/b>: Liga\u00e7\u00e3o de E1 Khomp", "example": "Khomp\/B0C0-Khomp\/B0C29", "required": true } }, { "name": "data-end", "in": "query", "description": "Data Final", "required": true, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": true } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": true, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true } }, { "name": "minimo", "in": "query", "description": "N\u00famero m\u00ednimo de canais", "required": false, "schema": { "type": "integer", "description": "N\u00famero m\u00ednimo de canais", "example": 1, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/AMI\/queueLogin": { "post": { "tags": [ "Sistema" ], "summary": "Adiciona um agente em uma fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Adiciona um agente em uma fila", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "member", "queue" ], "properties": { "member": { "type": "string", "description": "Membro para login", "example": "SIP\/7003", "required": true }, "name": { "type": "string", "description": "Nome do membro para login como Agent", "example": "bruno.leite", "required": false }, "penalty": { "type": "integer", "description": "Penalidade do membro. Quanto maior, menos chamadas recebe", "example": 10, "required": false }, "queue": { "type": "string", "description": "Fila para login", "example": "440", "required": true } } } } } } } }, "\/AMI\/queueLogoff": { "post": { "tags": [ "Sistema" ], "summary": "Remove um agente de uma fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Remove um agente de uma fila", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "member", "queue" ], "properties": { "member": { "type": "string", "description": "Membro para logoff", "example": "SIP\/7003", "required": true }, "queue": { "type": "string", "description": "Fila para logoff", "example": "440", "required": true } } } } } } } }, "\/AMI\/queuePause": { "post": { "tags": [ "Sistema" ], "summary": "Pausar um agente", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Pausar um agente", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "string", "description": "Membro para pause", "example": "SIP\/7003", "required": true } } } } } } } }, "\/AMI\/queueUnpause": { "post": { "tags": [ "Sistema" ], "summary": "Despausar um agente", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Despausar um agente", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "string", "description": "Membro para unpause", "example": "SIP\/7003", "required": true } } } } } } } }, "\/UsuarioPortal\/authenticateSessionUser": { "post": { "tags": [ "Sistema" ], "summary": "M\u00e9todo para autenticar usu\u00e1rio e gravar sess\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para autenticar usu\u00e1rio e gravar sess\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportIndicadores\/getStatusRamalCompleto": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Dados de um Ramal no dia Atual", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "ramal", "in": "query", "description": "N\u00famero do Ramal", "required": true, "schema": { "type": "string", "description": "N\u00famero do Ramal", "example": "7001", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/getStatusRamais": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Dados de todos os ramais", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Dados de todos os ramais", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/getStatusKhomp": { "get": { "tags": [ "Manager" ], "summary": "Buscar status de Khomp", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar status de Khomp", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportIndicadores\/getFacilidadesBusy": { "get": { "tags": [ "Sistema" ], "summary": "Buscar facilidades ativas de um ramal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "ramal", "in": "query", "description": "N\u00famero do Ramal", "required": true, "schema": { "type": "string", "description": "N\u00famero do Ramal", "example": "7001", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Contato\/cadastroSimples": { "post": { "tags": [ "Assist" ], "summary": "Cadastro de um Contato Simples", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastro de um Contato Simples", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "empresa", "nome", "telefone_comercial" ], "properties": { "cargo": { "type": "string", "description": "Cargo do contato", "example": "Gerente de TI", "required": false }, "cep": { "type": "string", "description": "CEP do Contato", "example": "99010-100", "required": false }, "cidade": { "type": "integer", "description": "Id da Cidade", "example": 4166, "required": false }, "data_nascimento": { "type": "string", "description": "Data", "example": "1990-01-01", "required": false }, "email1": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": false }, "email2": { "type": "string", "description": "E-mail do Contato", "example": "brunohl@teste.com.br", "required": false }, "empresa": { "type": "string", "description": "Empresa do Contato", "example": "Lettel Data", "required": true }, "endereco": { "type": "string", "description": "Endere\u00e7o do Contato", "example": "Rua Uruguai, 123, Sala 201", "required": false }, "extra": { "type": "string", "description": "Informa\u00e7\u00e3o Extra", "example": "#vendedores", "required": false }, "foto": { "type": "string", "description": "Arquivo de foto", "example": "123.jpg", "required": false }, "grupos": { "type": "array", "description": "Array de IDs de Grupos para vincular", "example": null, "required": false, "items": { "type": "string" } }, "id": { "type": "integer", "description": "ID do Registro de Contato", "example": 1, "required": false }, "id_tipo_contato": { "type": "integer", "description": "Tipo de contato (1 - Publico, 2 - Particular, 3 - Interno)", "example": 3, "required": false }, "nome": { "type": "string", "description": "Nome do Contato", "example": "Bruno", "required": true }, "sobrenome": { "type": "string", "description": "Sobrenome do Contato", "example": "Leite", "required": false }, "telefone_comercial": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "005421037000", "required": true }, "telefone_extra1": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "005421037000", "required": false }, "telefone_extra2": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "005421037000", "required": false }, "telefone_movel": { "type": "string", "description": "N\u00famero de telefone no padr\u00e3o de liga\u00e7\u00e3o", "example": "0054984080610", "required": false }, "consentimento": { "type": "string", "description": "Consentimento para tratamento de dados (S - Coletado, N - Pendente, X - N\u00e3o se aplica)", "example": "S", "required": false } } } } } } } }, "\/ReportSMS\/relatorioDetalhadoEnvioSMSZenvia": { "get": { "tags": [ "Envio de SMS" ], "summary": "Relat\u00f3rio detalhado de SMS do Zenvia", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "campanha", "in": "query", "description": "Id da Campanha", "required": false, "schema": { "type": "integer", "description": "Id da Campanha", "example": 45, "required": false } }, { "name": "data-fim-pos", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-fim-zen", "in": "query", "description": "Data Final Zenvia", "required": false, "schema": { "type": "string", "description": "Data Final Zenvia", "example": "2020-08-15", "required": false } }, { "name": "data-ini-pos", "in": "query", "description": "Data inicial Posicionado", "required": false, "schema": { "type": "string", "description": "Data inicial Posicionado", "example": "2020-08-01", "required": false } }, { "name": "data-ini-zen", "in": "query", "description": "Data inicial Zenvia", "required": false, "schema": { "type": "string", "description": "Data inicial Zenvia", "example": "2020-08-01", "required": false } }, { "name": "destino", "in": "query", "description": "Destino para filtro. Aceita inLike", "required": false, "schema": { "type": "string", "description": "Destino para filtro. Aceita inLike", "example": "%0661", "required": false } }, { "name": "hora-fim-pos", "in": "query", "description": "Hora final Posicionado", "required": false, "schema": { "type": "string", "description": "Hora final Posicionado", "example": "00:00:00", "required": false } }, { "name": "hora-fim-zen", "in": "query", "description": "Hora final Zenvia", "required": false, "schema": { "type": "string", "description": "Hora final Zenvia", "example": "00:00:00", "required": false } }, { "name": "hora-ini-pos", "in": "query", "description": "Hora inicial Posicionado", "required": false, "schema": { "type": "string", "description": "Hora inicial Posicionado", "example": "00:00:00", "required": false } }, { "name": "hora-ini-zen", "in": "query", "description": "Hora inicial Zenvia", "required": false, "schema": { "type": "string", "description": "Hora inicial Zenvia", "example": "00:00:00", "required": false } }, { "name": "msg", "in": "query", "description": "Filtro pela mensagem (aceita like)", "required": false, "schema": { "type": "string", "description": "Filtro pela mensagem (aceita like)", "example": "Teste", "required": false } }, { "name": "origem", "in": "query", "description": "Filtro por origem usada (ZENVIA) (aceita like)", "required": false, "schema": { "type": "string", "description": "Filtro por origem usada (ZENVIA) (aceita like)", "example": "LETTEL", "required": false } }, { "name": "resposta", "in": "query", "description": "Filtro por resposta (aceita like)", "required": false, "schema": { "type": "string", "description": "Filtro por resposta (aceita like)", "example": "Resposta de Teste", "required": false } }, { "name": "status-detail", "in": "query", "description": "Status detalhado", "required": false, "schema": { "type": "integer", "description": "Status detalhado", "example": 999, "required": false } }, { "name": "status-short", "in": "query", "description": "Status resumido", "required": false, "schema": { "type": "integer", "description": "Status resumido", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportSMS\/relatorioDetalhadoRespostaSMSZenvia": { "get": { "tags": [ "Envio de SMS" ], "summary": "Relat\u00f3rio detalhado de Resposta de SMS do Zenvia", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim-pos", "in": "query", "description": "Data Final Posicionado", "required": false, "schema": { "type": "string", "description": "Data Final Posicionado", "example": "2020-08-15", "required": false } }, { "name": "data-fim-res", "in": "query", "description": "Data Final Resposta", "required": false, "schema": { "type": "string", "description": "Data Final Resposta", "example": "2020-08-15", "required": false } }, { "name": "data-ini-pos", "in": "query", "description": "Data inicial Posicionado", "required": false, "schema": { "type": "string", "description": "Data inicial Posicionado", "example": "2020-08-01", "required": false } }, { "name": "data-ini-res", "in": "query", "description": "Data inicial Resposta", "required": false, "schema": { "type": "string", "description": "Data inicial Resposta", "example": "2020-08-01", "required": false } }, { "name": "hora-fim-pos", "in": "query", "description": "Hora final Posicionado", "required": false, "schema": { "type": "string", "description": "Hora final Posicionado", "example": "00:00:00", "required": false } }, { "name": "hora-fim-res", "in": "query", "description": "Hora final Resposta", "required": false, "schema": { "type": "string", "description": "Hora final Resposta", "example": "00:00:00", "required": false } }, { "name": "hora-ini-pos", "in": "query", "description": "Hora inicial Posicionado", "required": false, "schema": { "type": "string", "description": "Hora inicial Posicionado", "example": "00:00:00", "required": false } }, { "name": "hora-ini-res", "in": "query", "description": "Hora inicial Resposta", "required": false, "schema": { "type": "string", "description": "Hora inicial Resposta", "example": "00:00:00", "required": false } }, { "name": "msg", "in": "query", "description": "Filtro pela mensagem. Like", "required": false, "schema": { "type": "string", "description": "Filtro pela mensagem. Like", "example": "teste", "required": false } }, { "name": "mt_id", "in": "query", "description": "ID da Operadora de SMS", "required": false, "schema": { "type": "string", "description": "ID da Operadora de SMS", "example": "54", "required": false } }, { "name": "numero", "in": "query", "description": "N\u00famero para filtro. Aceita inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero para filtro. Aceita inLike", "example": "%7010%", "required": false } }, { "name": "resposta", "in": "query", "description": "Resposta recebida", "required": false, "schema": { "type": "string", "description": "Resposta recebida", "example": "resposta de sms", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalProvisionamento\/buscarRamais": { "get": { "tags": [ "Manager" ], "summary": "Buscar ramais auto-provisionamento", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar ramais auto-provisionamento", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalProvisionamento\/createRecord": { "post": { "tags": [ "Manager" ], "summary": "Cadastrar um auto-provisionamento", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar um auto-provisionamento", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "aparelho", "ip", "mac", "ramal", "senha" ], "properties": { "aparelho": { "type": "integer", "description": "ID do Aparelho cadastrado", "example": 3, "required": true }, "ip": { "type": "string", "description": "IP do Aparelho", "example": "192.168.20.10", "required": true }, "mac": { "type": "string", "description": "MAC do Aparelho", "example": "00:00:00:00:00:00", "required": true }, "ramal": { "type": "string", "description": "N\u00famero do Ramal", "example": "7001", "required": true }, "senha": { "type": "string", "description": "Senha do aparelho", "example": "1234", "required": true } } } } } } } }, "\/RamalProvisionamento\/deleteRecord": { "post": { "tags": [ "Manager" ], "summary": "Deletar um auto-provisionamento", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um auto-provisionamento", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "ramal" ], "properties": { "ramal": { "type": "string", "description": "N\u00famero do Ramal", "example": "7001", "required": true } } } } } } } }, "\/ReportFila\/relatorioSemAtendimentoCA": { "get": { "tags": [ "Relat\u00f3rio de Liga\u00e7\u00f5es sem Atendimento do CA" ], "summary": null, "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "espera_minima", "in": "query", "description": "Tempo m\u00ednimo de espera em segundos", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera em segundos", "example": -1, "required": false } }, { "name": "media_espera_minima", "in": "query", "description": "Considerar tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Considerar tempo m\u00ednimo de espera", "example": -1, "required": false } }, { "name": "queue", "in": "query", "description": "Filas separadas por v\u00edrgula", "required": false, "schema": { "type": "string", "description": "Filas separadas por v\u00edrgula", "example": "440,441", "required": false } }, { "name": "statuses_success", "in": "query", "description": "Status considerados sucesso, separados por v\u00edrgula", "required": false, "schema": { "type": "string", "description": "Status considerados sucesso, separados por v\u00edrgula", "example": "COMPLETECALLER,COMPLETEAGENT,TRANSFER,BLINDTRANSFER,ATTENDEDTRANSFER,CONNECT", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportCDR\/updateCDRField": { "post": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Atualiza\u00e7\u00e3o de informa\u00e7\u00e3o de liga\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atualiza\u00e7\u00e3o de informa\u00e7\u00e3o de liga\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "campo", "valor" ], "properties": { "campo": { "type": null, "description": "Campo a ser atualizado (outbound_cnam, outbound_cnum, json_data)", "example": "outbound_cnam", "required": true }, "id": { "type": "integer", "description": "ID do Registro de ReportCDR", "example": 1, "required": false }, "uniqueid": { "type": "string", "description": "Uniqueid da liga\u00e7\u00e3o", "example": "123345132.123", "required": false }, "valor": { "type": "string", "description": "Valor do campo a ser atualizado", "example": "teste", "required": true } } } } } } } }, "\/RamalConvert\/all": { "get": { "tags": [ "Ramais" ], "summary": "Busca todos os registros de RamalConvert", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/delete": { "post": { "tags": [ "Ramais" ], "summary": "Deletar um RamalConvert do sistema. Atualiza arquivos de conf. e d\u00e1 reload.", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um RamalConvert do sistema. Atualiza arquivos de conf. e d\u00e1 reload.", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de RamalConvert", "example": 1, "required": true } } } } } } } }, "\/RamalConvert\/get": { "get": { "tags": [ "Ramais" ], "summary": "Buscar um RamalConvert no sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de RamalConvert", "required": true, "schema": { "type": "integer", "description": "ID do Registro de RamalConvert", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/persist": { "post": { "tags": [ "Ramais" ], "summary": "Persiste um RamalConvert nos devices, atualiza os arquivos de configura\u00e7\u00e3o e d\u00e1 reload no sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Persiste um RamalConvert nos devices, atualiza os arquivos de configura\u00e7\u00e3o e d\u00e1 reload no sistema", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "description", "dial", "id", "props", "tech", "template", "user" ], "properties": { "criar_arquivo": { "type": null, "description": "Define se vai criar arquivo (A - criar, I - n\u00e3o criar)", "example": "A", "required": false }, "description": { "type": "string", "description": "Descri\u00e7\u00e3o do Ramal (nome)", "example": "Bruno Leite", "required": true }, "devicetype": { "type": "string", "description": "String padr\u00e3o fixed", "example": "fixed", "required": false }, "dial": { "type": "string", "description": "Regra de discagem. Tecnologia + Ramal ou Posi\u00e7\u00e3o F\u00edsica", "example": "SIP\/7003", "required": true }, "emergency_cid": { "type": "string", "description": "Par\u00e2metro Adicional", "example": "Teste", "required": false }, "extra1": { "type": "string", "description": "Informa\u00e7\u00e3o Extra 1 do Ramal", "example": "Usu\u00e1rios dividem", "required": false }, "extra2": { "type": "string", "description": "Informa\u00e7\u00e3o Extra 2 do Ramal", "example": "Ramal da Sala", "required": false }, "gravar_hint": { "type": null, "description": "Define se vai gravar hint (A - gravar, I - n\u00e3o gravar)", "example": "I", "required": false }, "grupo": { "type": "string", "description": "Grupo ao qual o ramal pertence", "example": "Comercial", "required": false }, "hint": { "type": "integer", "description": "Define se o ramal mostrar\u00e1 altera\u00e7\u00e3o de status (padr\u00e3o 1)", "example": 1, "required": false }, "id": { "type": "integer", "description": "ID do Registro de RamalConvert", "example": 1, "required": true }, "id_aparelho": { "type": "integer", "description": "ID do Aparelho cadastrado", "example": 1, "required": false }, "id_usuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": false }, "mac": { "type": "string", "description": "MAC do Aparelho", "example": "09:23:ae;12:ab:ce", "required": false }, "monitorar": { "type": null, "description": "Define se vai monitorar (A - monitorar, I - n\u00e3o monitorar)", "example": "I", "required": false }, "props": { "type": "string", "description": "Propriedades do ramal em formato JSON", "example": "{\"accountcode\":\"\",\"allow\":\"alaw,ulaw\",\"amaflags\":\"default\",\"callerid\":\"Bruno Leite\",\"callgroup\":\"1,2,3\",\"context\":\"interno-ramais\",\"disallow\":\"all\",\"dtmfmode\":\"rfc2833\",\"host\":\"dynamic\",\"mailbox\":\"\",\"pickupgroup\":\"11\",\"secret\":\"SENHA_RAMAL\",\"setvar\":\"\",\"type\":\"peer\"}", "required": true }, "recording": { "type": null, "description": "Flag que define se vai gravar (depende de conf. geral - A ou I)", "example": "A", "required": false }, "tech": { "type": null, "description": "Tipo de tecnologia (iax, khomp, sip, hints, sip-template, sip-tronco, iax-template, iax-tronco-saida, iax-tronco-entrada, pabx, teams)", "example": "sip", "required": true }, "template": { "type": "string", "description": "Template do ramal. Deve estar cadastrado para funcionar", "example": "padrao-sip", "required": true }, "usa_senha": { "type": null, "description": "Define se vai usa_senha (A - monitorar, I - n\u00e3o monitorar)", "example": "I", "required": false }, "user": { "type": "string", "description": "N\u00famero do ramal", "example": "7003", "required": true } } } } } } } }, "\/RamalConvert\/buscarPorNumero": { "get": { "tags": [ "Ramais" ], "summary": "Buscar um RamalConvert pelo seu n\u00famero", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "numero", "in": "query", "description": "N\u00famero do ramal", "required": false, "schema": { "type": "string", "description": "N\u00famero do ramal", "example": "7001", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/gerarArquivoTech": { "post": { "tags": [ "Ramais" ], "summary": "Remonta o arquivo de alguma tecnologia (atualiza hints e d\u00e1 reload)", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Remonta o arquivo de alguma tecnologia (atualiza hints e d\u00e1 reload)", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tech" ], "properties": { "tech": { "type": null, "description": "Tipo de tecnologia (iax, khomp, sip, hints, sip-template, sip-tronco, iax-template, iax-tronco-saida, iax-tronco-entrada, pabx, teams)", "example": "sip", "required": true } } } } } } } }, "\/RamalConvert\/gerarArquivoHints": { "post": { "tags": [ "Ramais" ], "summary": "Remonta arquivo de hints", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Remonta arquivo de hints", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalConvert\/reload": { "post": { "tags": [ "Ramais" ], "summary": "Executa reload em alguma tecnologia", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Executa reload em alguma tecnologia", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tech" ], "properties": { "tech": { "type": null, "description": "Tipo de tecnologia (iax, khomp, sip, hints, sip-template, sip-tronco, iax-template, iax-tronco-saida, iax-tronco-entrada, pabx, teams)", "example": "khomp", "required": true } } } } } } } }, "\/RamalConvert\/getTemplates": { "get": { "tags": [ "Ramais" ], "summary": "Busca os templates dispon\u00edveis", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Busca os templates dispon\u00edveis", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalConvert\/getAparelhos": { "get": { "tags": [ "Ramais" ], "summary": "Executa a busca de aparelhos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Executa a busca de aparelhos", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalConvertProp\/buscarTodasPropsPorTech": { "get": { "tags": [ "Ramais" ], "summary": "Buscar as propriedades dispon\u00edveis de uma tecnologia", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar as propriedades dispon\u00edveis de uma tecnologia", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tech" ], "properties": { "tech": { "type": null, "description": "Tipo de tecnologia (iax, khomp, sip, hints, sip-template, sip-tronco, iax-template, iax-tronco-saida, iax-tronco-entrada, pabx, teams)", "example": "iax", "required": true } } } } } } } }, "\/RamalConvertProp\/all": { "get": { "tags": [ "Ramais" ], "summary": "Busca todos os registros de RamalConvertProps", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/gerarFastConfig": { "post": { "tags": [ "Ramais" ], "summary": "Buscar par\u00e2metros de fast config", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar par\u00e2metros de fast config", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "ramal" ], "properties": { "ramal": { "type": "string", "description": "N\u00famero do ramal para gerar fastconfig", "example": "103", "required": true } } } } } } } }, "\/RamalConvert\/gerarPropsDeArquivo": { "post": { "tags": [ "Ramais" ], "summary": "Buscar propriedades de arquivo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar propriedades de arquivo", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tech" ], "properties": { "tech": { "type": null, "description": "Tipo de tecnologia (iax, khomp, sip, hints, sip-template, sip-tronco, iax-template, iax-tronco-saida, iax-tronco-entrada, pabx, teams)", "example": "sip-tronco", "required": true } } } } } } } }, "\/RamalConvert\/alterarNome": { "post": { "tags": [ "Ramais" ], "summary": "Alterar o nome de um Ramal no Banco de Dados", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Alterar o nome de um Ramal no Banco de Dados", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "chave", "nome" ], "properties": { "chave": { "type": "string", "description": "Id do Ramal", "example": "10", "required": true }, "nome": { "type": "string", "description": "Nome do Ramal", "example": "Silvio", "required": true } } } } } } } }, "\/RamalProvisionamento\/buscarIpDB": { "get": { "tags": [ "Manager" ], "summary": "Buscar o IP configurado via Chave", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar o IP configurado via Chave", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Pausa\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de Pausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Pausa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome" ], "properties": { "cor": { "type": "string", "description": "Cor aceit\u00e1vel por css", "example": "#ffffff", "required": false }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "Pausa Banheiro", "required": false }, "icone": { "type": "string", "description": "Icone da pausa. Trabalha com glyphicons", "example": "glyphicon-pause", "required": false }, "id": { "type": "integer", "description": "ID do Registro de Pausa", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome da Pausa", "example": "Pausa WhatsApp", "required": true }, "tipo": { "type": null, "description": "Produtiva ou Pessoal", "example": "Produtiva", "required": false }, "tempo": { "type": "integer", "description": "Tempo para alerta em dashboards", "example": null, "required": false } } } } } } } }, "\/Pausa\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de Pausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Pausa", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Pausa", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Pausa\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de Pausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Pausa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Pausa", "example": 1, "required": true } } } } } } } }, "\/Pausa\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos registros de Pausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Pausa\/getOpcoesPausas": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos os registros de pausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar todos os registros de pausa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioPresenca\/cloneInfoConfig": { "post": { "tags": [ "Assist" ], "summary": "M\u00e9todo para clonar config do Info", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para clonar config do Info", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_usuario", "id_usuario_clonado" ], "properties": { "id_usuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": true }, "id_usuario_clonado": { "type": "integer", "description": "ID do Usu\u00e1rio que deve ser clonado", "example": 11, "required": true } } } } } } } }, "\/CA\/persist": { "post": { "tags": [ "Filas \/ C\u00e9lulas" ], "summary": "Persiste um CA nos devices, atualiza os arquivos de configura\u00e7\u00e3o e d\u00e1 reload no sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Persiste um CA nos devices, atualiza os arquivos de configura\u00e7\u00e3o e d\u00e1 reload no sistema", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "descr", "extension", "id" ], "properties": { "descr": { "type": "string", "description": "Descri\u00e7\u00e3o do CA", "example": "Atendimento Geral", "required": true }, "extension": { "type": "string", "description": "N\u00famero do CA", "example": "440", "required": true }, "extra1": { "type": "string", "description": "Informa\u00e7\u00e3o Extra 1 do CA", "example": "CA est\u00e1tico", "required": false }, "extra2": { "type": "string", "description": "Informa\u00e7\u00e3o Extra 2 do CA", "example": "CA da Sala", "required": false }, "id": { "type": "integer", "description": "ID do Registro de CA", "example": 1, "required": true }, "members": { "type": "string", "description": "Membros, como array JSON. Obedece ordem passada", "example": "[\"SIP\/7003\",\"local\/7003@interno-ramais\"]", "required": false }, "nivel_abandono_alerta": { "type": "integer", "description": "N\u00edvel de abandono para alerta", "example": 5, "required": false }, "nivel_abandono_perigo": { "type": "integer", "description": "N\u00edvel de abandono para perigo", "example": 10, "required": false }, "nivel_espera_alerta": { "type": "integer", "description": "N\u00edvel de espera para alerta", "example": 30, "required": false }, "nivel_espera_perigo": { "type": "integer", "description": "N\u00edvel de espera para perigo", "example": 60, "required": false }, "prioridade": { "type": "integer", "description": "Prioridade da Fila", "example": null, "required": false }, "props": { "type": "string", "description": "Json com propriedades da Fila", "example": "{\"maxlen\":\"0\",\"joinempty\":\"loose\",\"leavewhenempty\":\"loose\",\"announce-position\":\"yes\",\"announce-holdtime\":\"no\",\"periodic-announce-frequency\":\"30\",\"wrapuptime\":\"0\",\"strategy\":\"rrordered\",\"timeout\":\"30\",\"retry\":\"0\",\"servicelevel\":\"0\",\"weight\":\"0\",\"membergosub\":\"buscar-contato-e-report-callinfo\"}", "required": false }, "recording": { "type": null, "description": "Define se fila ir\u00e1 gravar (depende de configura\u00e7\u00e3o geral) A ou I", "example": "A", "required": false }, "template": { "type": "string", "description": "Template do CA", "example": "queue-template", "required": false }, "tempo_minimo_abandono": { "type": "integer", "description": "Tempo m\u00ednimo abandono no Dashboard", "example": null, "required": false }, "sem_contato_internas": { "type": "integer", "description": "Define se ir\u00e1 contar internas no sem contato (0 ou 1)", "example": null, "required": false }, "members_report": { "type": "string", "description": "Membros para report, como array JSON", "example": "[\"7003\"]", "required": false } } } } } } } }, "\/CA\/get": { "get": { "tags": [ "Filas \/ C\u00e9lulas" ], "summary": "Buscar um CA no sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de CA", "required": true, "schema": { "type": "integer", "description": "ID do Registro de CA", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CA\/delete": { "post": { "tags": [ "Filas \/ C\u00e9lulas" ], "summary": "Deletar um CA do sistema. Atualiza arquivos de conf. e d\u00e1 reload.", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um CA do sistema. Atualiza arquivos de conf. e d\u00e1 reload.", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de CA", "example": 1, "required": true } } } } } } } }, "\/CA\/all": { "get": { "tags": [ "Filas \/ C\u00e9lulas" ], "summary": "Busca todos os registros de CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CA\/getTemplates": { "get": { "tags": [ "Manager" ], "summary": "M\u00e9todo para trazer templates de CAs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para trazer templates de CAs", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalConvert\/getOpcoesRamais": { "get": { "tags": [ "Manager" ], "summary": "Buscar op\u00e7\u00f5es dos ramais", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Pesquisar diversos campos em ramais", "required": false, "schema": { "type": "string", "description": "Pesquisar diversos campos em ramais", "example": "Bruno", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/LogReader\/searchLog": { "get": { "tags": [ "Manager" ], "summary": "M\u00e9todo de buscar em um log", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "limit", "in": "query", "description": "Limite de linhas", "required": false, "schema": { "type": "integer", "description": "Limite de linhas", "example": 500, "required": false } }, { "name": "not", "in": "query", "description": "String para ignorar", "required": false, "schema": { "type": "string", "description": "String para ignorar", "example": "excluirisso", "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo de buscar em um log", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo" ], "properties": { "caseSensitive": { "type": null, "description": "Define se case sensitive (Y ou N)", "example": "Y", "required": false }, "file": { "type": null, "description": "Nome do arquivo espec\u00edfico se sabido", "example": "\/var\/log\/asterisk\/full-20200810", "required": false }, "tipo": { "type": null, "description": "Arquivo de log para pesquisa. Op\u00e7\u00f5es: asterisk, http, https, messages, khomp-channel, khomp-messages, khomp-sysinfo", "example": "https", "required": true } } } } } } } }, "\/LogReader\/getLogsAvailable": { "get": { "tags": [ "Manager" ], "summary": "M\u00e9todo para buscar logs disponiveis", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para buscar logs disponiveis", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "tipo": { "type": null, "description": "Tipo do log para buscar (asterisk, http, https, messages, khomp-channel, khomp-messages, khomp-sysinfo)", "example": "asterisk", "required": false }, "v": { "type": null, "description": "Tipo de retorno do log (SIMPLE, COMPLEX)", "example": "COMPLEX", "required": false } } } } } } } }, "\/Actions\/coreShowChannels": { "get": { "tags": [ "Manager" ], "summary": "M\u00e9todo para visualizar os canais ativos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para visualizar os canais ativos", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Actions\/managerAction": { "post": { "tags": [ "Manager" ], "summary": "M\u00e9todo para executar comandos do Manager", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para executar comandos do Manager", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "action": { "type": null, "description": "A\u00e7\u00e3o a executar do manager (CORESHOWCHANNELS, GETVAR, HANGUP, SIPSHOWPEER, CORESTATUS, RELOAD, DBGET, DBPUT, DBDEL, DBDELTREE)", "example": "CORESHOWCHANNELS", "required": false } } } } } } } }, "\/AMI\/databaseShow": { "get": { "tags": [ "Sistema" ], "summary": "M\u00e9todo para visualizar Database", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para visualizar Database", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ConfiguracaoChaveValor\/persist": { "post": { "tags": [ "Manager" ], "summary": "Cadastrar ou Alterar um registro de Configura\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Configura\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "props" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de ConfiguracaoChaveValor", "example": 1, "required": false }, "id_usuario": { "type": "integer", "description": "ID do Usu\u00e1rio", "example": 11, "required": false }, "props": { "type": "string", "description": "Propriedades JSON", "example": "{\"DYNAMIC_FEATURES\":\"gravacaoondemand#transferenciapesquisa\",\"TRANSFER_CONTEXT\":\"interno-ramais-xfer\",\"transf_noanswer\":0,\"ativarrechamada\":1,\"ipserver\":\"192.168.20.6\",\"nome_cliente\":\"\",\"num_vpn\":\"\",\"numero_chave\":\"5430468151\",\"ramal_operadora\":\"\",\"filatelefonista\":\"\",\"destinonoturno\":\"\",\"modulopresenca\":\"1\",\"ativartoquepersonalizado\":\"0\",\"atrmixmonitor\":\"ab\",\"gravartotal\":1,\"gravsaidaext\":1,\"graventradaext\":1,\"gravinterno\":\"1\",\"repcontsaidaext\":\"0\",\"repcontentradaext\":\"0\",\"inssenha\":\"0\",\"senharamalsistema\":\"1\",\"digitossenha\":4,\"tentativassenha\":2,\"atributos_saida_ext\":\"TXKHf()\",\"atributos\":\"tThHkKxX\",\"classemusica\":\"espera\",\"tempotq\":\"120\",\"avisotransbordo\":\"0\"}", "required": true }, "reason": { "type": "string", "description": "Coment\u00e1rio sobre a edi\u00e7\u00e3o", "example": "Ajustes", "required": false }, "separador": { "type": "string", "description": "Separador", "example": ";", "required": false }, "tipo": { "type": null, "description": "Tipo do arquivo (varglobal, saidaexterna, featuremap, featuregeneral, extensions_cliente, extensions_saidaexterna, extensions_facilidades, sip_registros, khomp_rotas, res_parking_custom)", "example": "varglobal", "required": false } } } } } } } }, "\/ConfiguracaoChaveValor\/get": { "get": { "tags": [ "Manager" ], "summary": "Buscar um registro de Configura\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de ConfiguracaoChaveValor", "required": true, "schema": { "type": "integer", "description": "ID do Registro de ConfiguracaoChaveValor", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ConfiguracaoChaveValor\/buscarConfiguracaoAtual": { "get": { "tags": [ "Manager" ], "summary": "Buscar um registro de Configura\u00e7\u00e3o atual", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar um registro de Configura\u00e7\u00e3o atual", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo" ], "properties": { "tipo": { "type": null, "description": "Tipo do arquivo (varglobal, saidaexterna, featuremap, featuregeneral, extensions_cliente, extensions_saidaexterna, extensions_facilidades, sip_registros, khomp_rotas, res_parking_custom)", "example": "varglobal", "required": true } } } } } } } }, "\/ConfiguracaoChaveValor\/all": { "get": { "tags": [ "Manager" ], "summary": "Buscar todos registros de Configura\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ConfiguracaoChaveValor\/ajustarConfiguracaoAsterisk": { "post": { "tags": [ "Manager" ], "summary": "M\u00e9todo de persist\u00eancia de configura\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo de persist\u00eancia de configura\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "props" ], "properties": { "props": { "type": "string", "description": "Op\u00e7\u00f5es do Tipo. JSON", "example": "{\"DYNAMIC_FEATURES\":\"gravacaoondemand#transferenciapesquisa\",\"TRANSFER_CONTEXT\":\"interno-ramais-xfer\",\"transf_noanswer\":0,\"ativarrechamada\":1,\"ipserver\":\"192.168.20.6\",\"nome_cliente\":\"\",\"num_vpn\":\"\",\"numero_chave\":\"5430468151\",\"ramal_operadora\":\"\",\"filatelefonista\":\"\",\"destinonoturno\":\"\",\"modulopresenca\":\"1\",\"ativartoquepersonalizado\":\"0\",\"atrmixmonitor\":\"ab\",\"gravartotal\":1,\"gravsaidaext\":1,\"graventradaext\":1,\"gravinterno\":\"1\",\"repcontsaidaext\":\"0\",\"repcontentradaext\":\"0\",\"inssenha\":\"0\",\"senharamalsistema\":\"1\",\"digitossenha\":4,\"tentativassenha\":2,\"atributos_saida_ext\":\"TXKHf()\",\"atributos\":\"tThHkKxX\",\"classemusica\":\"espera\",\"tempotq\":\"120\",\"avisotransbordo\":\"0\"}", "required": true }, "tipo": { "type": null, "description": "Tipo do arquivo (varglobal, saidaexterna, featuremap, featuregeneral, extensions_cliente, extensions_saidaexterna, extensions_facilidades, sip_registros, khomp_rotas, res_parking_custom)", "example": "varglobal", "required": false } } } } } } } }, "\/ConfiguracaoChaveValor\/buscarTodasConfiguracoesPorTipo": { "get": { "tags": [ "Manager" ], "summary": "M\u00e9todo para buscar informa\u00e7\u00e3o de um tipo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "level", "in": "query", "description": "N\u00edvel de configura\u00e7\u00e3o para buscar", "required": false, "schema": { "type": "string", "description": "N\u00edvel de configura\u00e7\u00e3o para buscar", "example": "error", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para buscar informa\u00e7\u00e3o de um tipo", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo" ], "properties": { "tipo": { "type": null, "description": "Tipo do arquivo (varglobal, saidaexterna, featuremap, featuregeneral, extensions_cliente, extensions_saidaexterna, extensions_facilidades, sip_registros, khomp_rotas, res_parking_custom)", "example": "varglobal", "required": true }, "todas": { "type": null, "description": "Define se vai mostrar todas as intera\u00e7\u00f5es (I ou A)", "example": "I", "required": false } } } } } } } }, "\/AudioClasse\/persist": { "post": { "tags": [ "\u00c1udio" ], "summary": "Cadastrar ou Alterar uma Classe de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar uma Classe de \u00c1udio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "data", "descricao", "nome", "announcement" ], "properties": { "data": { "type": "string", "description": "Data do upload", "example": "2020-08-10", "required": true }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o textual", "example": "\u00c1udio Natal", "required": true }, "id": { "type": "integer", "description": "ID do Registro de AudioClasse", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome da Classe de Audio", "example": "Natal", "required": true }, "sort": { "type": "string", "description": "Ordem (random, alpha)", "example": "random", "required": false }, "announcement": { "type": "string", "description": "An\u00fancio", "example": "custom\/teste", "required": true } } } } } } } }, "\/AudioClasse\/get": { "get": { "tags": [ "\u00c1udio" ], "summary": "Buscar um registro de Classe de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de AudioClasse", "required": true, "schema": { "type": "integer", "description": "ID do Registro de AudioClasse", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/AudioClasse\/delete": { "post": { "tags": [ "\u00c1udio" ], "summary": "Cadastrar ou Alterar um registro de Classe de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Classe de \u00c1udio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de AudioClasse", "example": 1, "required": true } } } } } } } }, "\/AudioClasse\/all": { "get": { "tags": [ "\u00c1udio" ], "summary": "Buscar todos os registros de Classe de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/AudioClasse\/atualizarMOH": { "post": { "tags": [ "\u00c1udio" ], "summary": "Atualizar arquivo conf do Music on Hold", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atualizar arquivo conf do Music on Hold", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Audio\/persist": { "post": { "tags": [ "\u00c1udio" ], "summary": "Cadastrar ou Alterar um registro de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de \u00c1udio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "convert_audio_classe_id", "data", "id", "nome" ], "properties": { "convert_audio_classe_id": { "type": "integer", "description": "ID da Classe de Audio", "example": 5, "required": true }, "data": { "type": "string", "description": "Data do upload", "example": "2020-08-10", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Audio", "example": 1, "required": true }, "nome": { "type": "string", "description": "Nome do \u00c1udio", "example": "natal01", "required": true } } } } } } } }, "\/Audio\/get": { "get": { "tags": [ "\u00c1udio" ], "summary": "Buscar um registro de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Audio", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Audio", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Audio\/delete": { "post": { "tags": [ "\u00c1udio" ], "summary": "Cadastrar ou Alterar um registro de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de \u00c1udio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Audio", "example": 1, "required": true } } } } } } } }, "\/Audio\/all": { "get": { "tags": [ "\u00c1udio" ], "summary": "Buscar todos os registro de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Audio\/uploadAudio": { "post": { "tags": [ "\u00c1udio" ], "summary": "Upload de \u00c1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Upload de \u00c1udio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "file": { "type": null, "description": "Arquivo wav 16bit 8khz", "example": "teste.wav", "required": false }, "id_classe": { "type": "integer", "description": "ID da Classe de Audio", "example": 5, "required": false } } } } } } } }, "\/Audio\/downloadAudioConvert": { "get": { "tags": [ "\u00c1udio" ], "summary": "Baixar \u00e1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Audio", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Audio", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/EditorSnippets\/buscarTodosSnippets": { "get": { "tags": [ "Manager" ], "summary": "Buscar todos snippets", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar todos snippets", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/EditorSnippets\/get": { "get": { "tags": [ "Manager" ], "summary": "Buscar um registro de Snippet", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de EditorSnippets", "required": true, "schema": { "type": "integer", "description": "ID do Registro de EditorSnippets", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ConfiguracaoChaveValor\/cadastrarNovaConfiguracaoArquivo": { "post": { "tags": [ "Manager" ], "summary": "Cadastrar uma Configura\u00e7\u00e3o de Arquivo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar uma Configura\u00e7\u00e3o de Arquivo", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "props", "tipo" ], "properties": { "props": { "type": "string", "description": "Texto do arquivo", "example": ";Vers\u00e3o 2.0.9\n;2.0.0 - Versao Original\n;2.0.1 - Criado vari\u00e1vel de identifica\u00e7\u00e3o para entrada de liga\u00e7\u00f5es na Lettel via VPN\n;2.0.2 - Removido Contexto entrada-presenca\n;2.0.3 - Criado exemplo para pesquisa de satisfa\u00e7\u00e3o e contextos", "required": true }, "reason": { "type": "integer", "description": "Coment\u00e1rio sobre a edi\u00e7\u00e3o", "example": null, "required": false }, "tipo": { "type": null, "description": "Tipo do arquivo (varglobal, saidaexterna, featuremap, featuregeneral, extensions_cliente, extensions_saidaexterna, extensions_facilidades, sip_registros, khomp_rotas, res_parking_custom)", "example": "varglobal", "required": true } } } } } } } }, "\/ConfiguracaoChaveValor\/reloadParaArquivo": { "post": { "tags": [ "Manager" ], "summary": "Realizar um reload de um tipo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Realizar um reload de um tipo", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo" ], "properties": { "tipo": { "type": null, "description": "Tipo do arquivo (varglobal, saidaexterna, featuremap, featuregeneral, extensions_cliente, extensions_saidaexterna, extensions_facilidades, sip_registros, khomp_rotas, res_parking_custom)", "example": "varglobal", "required": true } } } } } } } }, "\/Actions\/ifconfig": { "get": { "tags": [ "Manager" ], "summary": "Ipconfig", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Ipconfig", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Senha\/cadastrarSenhaComCategorias": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar uma Senha com Categorias", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar uma Senha com Categorias", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "categorias", "senha" ], "properties": { "categorias": { "type": "array", "description": "Array de ids de categorias", "example": null, "required": true, "items": { "type": "string" } }, "senha": { "type": "string", "description": "N\u00famero da senha", "example": "1234", "required": true } } } } } } } }, "\/ReportIndicadores\/gerarReportANEEL": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Gerar report por hor\u00e1rios no padr\u00e3o ANEEL", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": true, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": true } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": true, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "opcoes", "in": "query", "description": "Op\u00e7oes para filtro em extra+ Aceita regex", "required": false, "schema": { "type": "string", "description": "Op\u00e7oes para filtro em extra+ Aceita regex", "example": "%.*%", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/getOpcoesPausasFila": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesPausasFila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesPausasFila", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportFila\/relatorioDetalhadoPausaFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Relat\u00f3rio detalhado de pausa Fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "agente", "in": "query", "description": "String de Agente ou Nome", "required": false, "schema": { "type": "string", "description": "String de Agente ou Nome", "example": "SIP\/7003", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "duracao-min", "in": "query", "description": "Dura\u00e7\u00e3o m\u00ednima de pausa", "required": false, "schema": { "type": "string", "description": "Dura\u00e7\u00e3o m\u00ednima de pausa", "example": "00:05:00", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "tipo", "in": "query", "description": "ID da Pausa Solicitada", "required": false, "schema": { "type": "integer", "description": "ID da Pausa Solicitada", "example": 3, "required": false } }, { "name": "evento", "in": "query", "description": "Tipo do evento, PAUSE, LOGIN ou em branco para ambos", "required": false, "schema": { "type": "string", "description": "Tipo do evento, PAUSE, LOGIN ou em branco para ambos", "example": "PAUSE", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/getOpcoesQueuesPausa": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesQueuesPausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesQueuesPausa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportFila\/relatorioDetalhadoPausaTipoFila": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Relat\u00f3rio detalhado de pausa por Tipo Fila", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "agente", "in": "query", "description": "String de Agente ou Nome", "required": false, "schema": { "type": "string", "description": "String de Agente ou Nome", "example": "SIP\/7003", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "duracao-min", "in": "query", "description": "Dura\u00e7\u00e3o m\u00ednima de pausa", "required": false, "schema": { "type": "string", "description": "Dura\u00e7\u00e3o m\u00ednima de pausa", "example": "00:05:00", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": false, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "tipo", "in": "query", "description": "ID da Pausa Solicitada", "required": false, "schema": { "type": "integer", "description": "ID da Pausa Solicitada", "example": 3, "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/getOpcoesAgentesPausa": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesAgentesPausa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getOpcoesAgentesPausa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportURA\/getEntradasURA": { "get": { "tags": [ "Relat\u00f3rios de URA" ], "summary": "Buscar entradas de URA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar entradas de URA", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportSZ\/getCampanhasSZ": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getCampanhasSZ", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getCampanhasSZ", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportSZ\/getAgentesSZ": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getAgentesSZ", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getAgentesSZ", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/SzAtendimentosFinalizados\/getConversasSZ": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getConversasSZ", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "data_final", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data_inicial", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "number", "in": "query", "description": "N\u00famero para filtro. Aceita inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero para filtro. Aceita inLike", "example": "%7010%", "required": false } }, { "name": "versao", "in": "query", "description": "Vers\u00e3o do chat", "required": false, "schema": { "type": "integer", "description": "Vers\u00e3o do chat", "example": 3, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Util\/ajustarNumero": { "get": { "tags": [ "Utils" ], "summary": "Ajustar um n\u00famero", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "normalizar_local", "in": "query", "description": "Define se vai normalizar local (005421037000 para 021037000)", "required": false, "schema": { "type": "boolean", "description": "Define se vai normalizar local (005421037000 para 021037000)", "example": true, "required": false } }, { "name": "normalizar_numeros", "in": "query", "description": "Define se vai normalizar n\u00fameros (remove caracteres especiais)", "required": false, "schema": { "type": "boolean", "description": "Define se vai normalizar n\u00fameros (remove caracteres especiais)", "example": true, "required": false } }, { "name": "normalizar_zero", "in": "query", "description": "Define se vai normalizar zeros", "required": false, "schema": { "type": "boolean", "description": "Define se vai normalizar zeros", "example": null, "required": false } }, { "name": "numero", "in": "query", "description": "N\u00famero para ser ajustado", "required": true, "schema": { "type": "string", "description": "N\u00famero para ser ajustado", "example": "+55 54 9 8408 0610", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/gerarReportPorHoraANEEL": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Gerar report por hor\u00e1rios no padr\u00e3o ANEEL por Hora", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": true, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": true } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": true, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "opcoes", "in": "query", "description": "Op\u00e7oes para filtro em extra+ Aceita regex", "required": false, "schema": { "type": "string", "description": "Op\u00e7oes para filtro em extra+ Aceita regex", "example": "%.*%", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/gerarReportPorDiaANEEL": { "get": { "tags": [ "Relat\u00f3rio de Ramais" ], "summary": "Gerar report por hor\u00e1rios no padr\u00e3o ANEEL por Dia", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data_fim", "in": "query", "description": "Data Final", "required": true, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": true } }, { "name": "data_ini", "in": "query", "description": "Data inicial", "required": true, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": true } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "hora_fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora_ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "opcoes", "in": "query", "description": "Op\u00e7oes para filtro em extra+ Aceita regex", "required": false, "schema": { "type": "string", "description": "Op\u00e7oes para filtro em extra+ Aceita regex", "example": "%.*%", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/AMI\/desvio": { "post": { "tags": [ "Sistema" ], "summary": "Realizar desvio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Realizar desvio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "destino", "ramal" ], "properties": { "destino": { "type": "string", "description": "Destino do desvio. Interno ou Externo (103, 0054984081001)", "example": "103", "required": true }, "ramal": { "type": "string", "description": "Ramal a ser desviado", "example": "123", "required": true } } } } } } } }, "\/AMI\/removerDesvio": { "post": { "tags": [ "Sistema" ], "summary": "Remover desvio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Remover desvio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "ramal" ], "properties": { "ramal": { "type": "string", "description": "Ramal a ter o desvio removido", "example": "123", "required": true } } } } } } } }, "\/API\/buscarDocumentacaoAPI": { "get": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "M\u00e9todo para buscar documenta\u00e7\u00e3o da API", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro de APIs", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro de APIs", "example": "sms", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortal\/getAcl": { "get": { "tags": [ "Usu\u00e1rios" ], "summary": "M\u00e9todo para buscar a ACL do usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do usu\u00e1rio para buscar ACL", "required": true, "schema": { "type": "integer", "description": "ID do usu\u00e1rio para buscar ACL", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortal\/setAcl": { "post": { "tags": [ "Usu\u00e1rios" ], "summary": "M\u00e9todo para setar a ACL do usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para setar a ACL do usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "acl" ], "properties": { "id": { "type": "integer", "description": "ID do usu\u00e1rio para definir ACL", "example": 1, "required": true }, "acl": { "type": "string", "description": "String JSON de nova ACL", "example": "{\"ramais\":\"7020,700%\",\"filas\":\"440\",\"campanhas\":\"\",\"ccs\":\"\",\"usuarios\":\"\"}", "required": true } } } } } } } }, "\/ReportUseall\/relatorioDetalhadoUseall": { "get": { "tags": [ "Relat\u00f3rios da Useall" ], "summary": "Relat\u00f3rio detalhado de Useall", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-15", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora Final", "required": false, "schema": { "type": "string", "description": "Hora Final", "example": "23:59:59", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "uc", "in": "query", "description": "C\u00f3digo da Unidade Consumidora", "required": false, "schema": { "type": "integer", "description": "C\u00f3digo da Unidade Consumidora", "example": 1234, "required": false } }, { "name": "ura", "in": "query", "description": "C\u00f3digo do Atendimento da URA", "required": false, "schema": { "type": "integer", "description": "C\u00f3digo do Atendimento da URA", "example": 134, "required": false } }, { "name": "numero", "in": "query", "description": "N\u00famero ligado", "required": false, "schema": { "type": "string", "description": "N\u00famero ligado", "example": "54984080612", "required": false } }, { "name": "protocolo", "in": "query", "description": "C\u00f3digo do protocolo gerado", "required": false, "schema": { "type": "string", "description": "C\u00f3digo do protocolo gerado", "example": "120390", "required": false } }, { "name": "metodo", "in": "query", "description": "M\u00e9todo utilizado", "required": false, "schema": { "type": "string", "description": "M\u00e9todo utilizado", "example": "REPORT_QUEDA", "required": false } }, { "name": "motivo", "in": "query", "description": "Motivo da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Motivo da liga\u00e7\u00e3o", "example": "ATENDENTE", "required": false } }, { "name": "atendente", "in": "query", "description": "Se foi passado para atendente", "required": false, "schema": { "type": "integer", "description": "Se foi passado para atendente", "example": 1, "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportUseall\/fluxogramaUseall": { "get": { "tags": [ "Relat\u00f3rios da Useall" ], "summary": "Fluxograma de Useall", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "ura", "in": "query", "description": "C\u00f3digo do Atendimento da URA", "required": true, "schema": { "type": "integer", "description": "C\u00f3digo do Atendimento da URA", "example": 134, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportUseall\/getStatusUseall": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getStatusUseall", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Select - getStatusUseall", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ReportUseall\/metricasUseall": { "get": { "tags": [ "Relat\u00f3rios da Useall" ], "summary": "M\u00e9tricas Useall", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "atendente", "in": "query", "description": "Se foi passado para atendente", "required": false, "schema": { "type": "integer", "description": "Se foi passado para atendente", "example": 1, "required": false } }, { "name": "motivo", "in": "query", "description": "Motivo da liga\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "Motivo da liga\u00e7\u00e3o", "example": "ATENDENTE", "required": false } }, { "name": "metodo", "in": "query", "description": "M\u00e9todo utilizado", "required": false, "schema": { "type": "string", "description": "M\u00e9todo utilizado", "example": "REPORT_QUEDA", "required": false } }, { "name": "protocolo", "in": "query", "description": "C\u00f3digo do protocolo gerado", "required": false, "schema": { "type": "string", "description": "C\u00f3digo do protocolo gerado", "example": "120390", "required": false } }, { "name": "numero", "in": "query", "description": "N\u00famero ligado", "required": false, "schema": { "type": "string", "description": "N\u00famero ligado", "example": "54984080612", "required": false } }, { "name": "ura", "in": "query", "description": "C\u00f3digo do Atendimento da URA", "required": false, "schema": { "type": "integer", "description": "C\u00f3digo do Atendimento da URA", "example": 134, "required": false } }, { "name": "uc", "in": "query", "description": "C\u00f3digo da Unidade Consumidora", "required": false, "schema": { "type": "integer", "description": "C\u00f3digo da Unidade Consumidora", "example": 1234, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora Final", "required": false, "schema": { "type": "string", "description": "Hora Final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-15", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Audio\/criarRegistroTTS": { "post": { "tags": [ "\u00c1udio" ], "summary": "Criar registro TTS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Criar registro TTS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "texto", "id_classe" ], "properties": { "texto": { "type": "string", "description": "Texto para converter em \u00e1udio", "example": "Bem-vindo a Lettel Data, por favor aguarde atendimento", "required": true }, "id_classe": { "type": "string", "description": "ID da Classe de \u00e1udio", "example": "1", "required": true }, "nome": { "type": "string", "description": "Nome do \u00e1udio com extens\u00e3o", "example": "audio-novo.sln", "required": false }, "id_audio": { "type": "string", "description": "ID do \u00e1udio para edi\u00e7\u00e3o", "example": "5", "required": false } } } } } } } }, "\/ReportCDR\/reposicionarLigacoesContato": { "post": { "tags": [ "Relat\u00f3rios Gerais" ], "summary": "Reposicionar liga\u00e7\u00f5es de contatos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Reposicionar liga\u00e7\u00f5es de contatos", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "numero": { "type": "string", "description": "N\u00famero ou parte dele. Aceita %", "example": "%54984081010%", "required": false }, "contato": { "type": "string", "description": "ID do Contato, ou para liga\u00e7\u00f5es sem contato, -1", "example": "3", "required": false } } } } } } } }, "\/Contato\/deletarContatosQuarentena": { "post": { "tags": [ "Assist" ], "summary": "Deletar contatos que est\u00e3o em quarentena", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar contatos que est\u00e3o em quarentena", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/buscarEstatisticasLigacoes": { "get": { "tags": [ "Sistema" ], "summary": "Buscar estat\u00edsticas de liga\u00e7\u00f5es", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar estat\u00edsticas de liga\u00e7\u00f5es", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioPresenca\/solicitarResetSenha": { "post": { "tags": [ "Assist" ], "summary": "Solicitar reset de senha do Assist", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Solicitar reset de senha do Assist", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "email", "login" ], "properties": { "email": { "type": "string", "description": "E-mail para recuperar senha", "example": "jose@123.com", "required": true }, "login": { "type": "string", "description": "Login", "example": "jose", "required": true } } } } } } } }, "\/UsuarioPresenca\/resetarSenhaAtravesDeLink": { "post": { "tags": [ "Assist" ], "summary": "Validar link recebido por e-mail", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Validar link recebido por e-mail", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "hash", "password" ], "properties": { "hash": { "type": "string", "description": "Hash Recebido no E-mail", "example": "2304935-6904", "required": true }, "password": { "type": "string", "description": "Nova senha", "example": "4950340jfdfj!!", "required": true } } } } } } } }, "\/ReportAudit\/listarUsuariosBloqueados": { "get": { "tags": [ "Auditoria - Portal" ], "summary": "M\u00e9todo para listar usu\u00e1rios bloqueados", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "tipo", "in": "query", "description": "Tipo da autentica\u00e7\u00e3o para liberar (portal ou assist)", "required": true, "schema": { "type": "string", "description": "Tipo da autentica\u00e7\u00e3o para liberar (portal ou assist)", "example": "portal", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportAudit\/liberarUsuarioBloqueado": { "post": { "tags": [ "Auditoria - Portal" ], "summary": "M\u00e9todo para desbloquear um IP", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para desbloquear um IP", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo", "ip" ], "properties": { "tipo": { "type": "string", "description": "Tipo da autentica\u00e7\u00e3o para liberar (portal ou assist)", "example": "assist", "required": true }, "ip": { "type": "string", "description": "IP para desbloquear", "example": "192.168.20.20", "required": true } } } } } } } }, "\/RamalConvertProp\/buscarTodasPropsConfig": { "get": { "tags": [ "Ramais" ], "summary": "Buscar as propriedade de configura\u00e7\u00f5es", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar as propriedade de configura\u00e7\u00f5es", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/fetchAllConfig": { "get": { "tags": [ "Sistema" ], "summary": "Buscar configura\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar configura\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/updateConfig": { "post": { "tags": [ "Sistema" ], "summary": "Atualizar configura\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Atualizar configura\u00e7\u00e3o", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "config" ], "properties": { "config": { "type": null, "description": "Configura\u00e7\u00e3o no padr\u00e3o JSON (algumas chaves est\u00e3o omitidas)", "example": "{\r\n \"SISTEMA-AUTH\": {\r\n \"ad_validar_telefone\": \"0\",\r\n \"ad_domain_controllers\": \"dc1.suaempresa.com.br\",\r\n \"ad_base_dn\": \"dc=suaempresa,dc=com,dc=br\",\r\n \"ad_account_suffix\": \"@suaempresa.com.br\",\r\n \"auth\": \"LOCAL\"\r\n },\r\n \"SISTEMA-GERAL\": {\r\n \"senha_ligacao\": \"0\",\r\n \"id_locais_cidades\": \"4166\"\r\n },\r\n \"CONFIG-CONTATOS\": {\r\n \"Limit\": \"1000\",\r\n \"Dupes\": \"true\",\r\n \"TempoTarifacao\": \"30000\"\r\n }\r\n}", "required": true } } } } } } } }, "\/ReportAudit\/relatorioListaUsuarios": { "get": { "tags": [ "Sistema" ], "summary": "Listar usu\u00e1rios e permiss\u00f5es", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Listar usu\u00e1rios e permiss\u00f5es", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioPortal\/gerarTokenPortal": { "post": { "tags": [ "Sistema" ], "summary": "M\u00e9todo para gerar token de API para um Usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para gerar token de API para um Usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o do Token", "example": "Token para API Sistema X", "required": false }, "id": { "type": "integer", "description": "ID do Usu\u00e1rio para gerar token (s\u00f3 valido se token for gerado por lettel ou convertmaster)", "example": 2, "required": false } } } } } } } }, "\/APIToken\/buscarTokensPorIdUsuarioPortal": { "get": { "tags": [ "Usu\u00e1rios" ], "summary": "M\u00e9todo para buscar tokens por id de usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Usu\u00e1rio para buscar os tokens", "required": true, "schema": { "type": "integer", "description": "ID do Usu\u00e1rio para buscar os tokens", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/APIToken\/buscarTokensDeUsuario": { "get": { "tags": [ "Sistema" ], "summary": "M\u00e9todo para buscar os tokens do pr\u00f3prio usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "M\u00e9todo para buscar os tokens do pr\u00f3prio usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/APIToken\/revogarToken": { "post": { "tags": [ "Sistema" ], "summary": "Revogar um token", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Revogar um token", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_token" ], "properties": { "id_token": { "type": "integer", "description": "ID do Token para revogar", "example": 1, "required": true } } } } } } } }, "\/ConfiguracaoChaveValor\/pingConfiguracaoAtual": { "get": { "tags": [ "Manager" ], "summary": "Busca dados da configura\u00e7\u00e3o atual", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "tipo", "in": "query", "description": "Tipo do arquivo", "required": true, "schema": { "type": "string", "description": "Tipo do arquivo", "example": "extensions_cliente", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Actions\/networkPing": { "get": { "tags": [ "Manager" ], "summary": "Realizar o ping a um endere\u00e7o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "destino", "in": "query", "description": "Destino, pode ser ip ou nome", "required": true, "schema": { "type": "string", "description": "Destino, pode ser ip ou nome", "example": "8.8.8.8", "required": true } }, { "name": "timeout", "in": "query", "description": "Timeout, em segundos", "required": false, "schema": { "type": "integer", "description": "Timeout, em segundos", "example": 10, "required": false } }, { "name": "count", "in": "query", "description": "Qtde. de Pacotes", "required": false, "schema": { "type": "integer", "description": "Qtde. de Pacotes", "example": 3, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Actions\/traceroute": { "get": { "tags": [ "Manager" ], "summary": "Realizar o traceroute", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "destino", "in": "query", "description": "Destino, pode ser ip ou nome", "required": true, "schema": { "type": "string", "description": "Destino, pode ser ip ou nome", "example": "8.8.8.8", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CA\/getMemberFilas": { "get": { "tags": [ "Manager" ], "summary": "M\u00e9todo proxy para buscar membro", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "member", "in": "query", "description": "Membro para pesquisa", "required": true, "schema": { "type": "string", "description": "Membro para pesquisa", "example": "gabriel", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/getVar": { "get": { "tags": [ "Manager" ], "summary": "Buscar uma vari\u00e1vel para liga\u00e7\u00e3o ativa de um ramal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "ramal", "in": "query", "description": "Ramal para buscar vari\u00e1vel", "required": true, "schema": { "type": "string", "description": "Ramal para buscar vari\u00e1vel", "example": "7003", "required": true } }, { "name": "key", "in": "query", "description": "Key para buscar (CDR(outbound_cnum) ou CDR(outbound_cnam)", "required": true, "schema": { "type": "string", "description": "Key para buscar (CDR(outbound_cnum) ou CDR(outbound_cnam)", "example": "CDR(outbound_cnam)", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/setVar": { "post": { "tags": [ "Manager" ], "summary": "Definir uma vari\u00e1vel para liga\u00e7\u00e3o ativa de um ramal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Definir uma vari\u00e1vel para liga\u00e7\u00e3o ativa de um ramal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "ramal", "key", "val" ], "properties": { "ramal": { "type": "string", "description": "Ramal para definir vari\u00e1vel", "example": "7003", "required": true }, "key": { "type": "string", "description": "Vari\u00e1vel a ser definida (CDR(outbound_cnum), CDR(outbound_cnam) ou APP_CONVERT_*)", "example": "CDR(outbound_cnam)", "required": true }, "val": { "type": "string", "description": "Valor da vari\u00e1vel", "example": "3", "required": true } } } } } } } }, "\/MensagemFavorita\/persist": { "post": { "tags": [ "Omnichannel" ], "summary": "Cadastrar ou Alterar um registro de Mensagem Favorita", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Mensagem Favorita", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "mensagem", "titulo", "grupo" ], "properties": { "mensagem": { "type": "string", "description": "Mensagem", "example": "Preparo do exame....", "required": true }, "titulo": { "type": "string", "description": "T\u00edtulo da mensagem", "example": "Preparo Endoscopia", "required": true }, "grupo": { "type": "string", "description": "Grupo da Mensagem", "example": "Preparos", "required": true }, "id": { "type": "integer", "description": "ID do Registro de Mensagem Favorita", "example": 1, "required": false }, "setor": { "type": "string", "description": "Setor", "example": "Comercial", "required": false } } } } } } } }, "\/MensagemFavorita\/get": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar um registro de Mensagem Favorita", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Mensagem Favorita", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Mensagem Favorita", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemFavorita\/delete": { "post": { "tags": [ "Omnichannel" ], "summary": "Deletar um registro de Mensagem Favorita", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Mensagem Favorita", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Mensagem Favorita", "example": 1, "required": true } } } } } } } }, "\/MensagemFavorita\/all": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar todos registros de Mensagem Favorita", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemFavorita\/buscarPorNomeLike": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar mensagem favorita por peda\u00e7o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o do nome da mensagem para pesquisa. Prefixado pelo nome do servidor", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o do nome da mensagem para pesquisa. Prefixado pelo nome do servidor", "example": "chat.letteldata.com.br|endosc", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Contato\/importarContatosEmLote": { "post": { "tags": [ "Assist" ], "summary": "Cadastro de lote de arquivo. Arquivo deve ser passado com o par\u00e2metro agenda", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastro de lote de arquivo. Arquivo deve ser passado com o par\u00e2metro agenda", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "agenda" ], "properties": { "origem": { "type": "string", "description": "Origem definida. \u00c9 limpo antes do novo upload, ideal para identificar fontes de dados. Padr\u00e3o UPLOAD", "example": "UPLOAD", "required": false }, "delimiter": { "type": "string", "description": "Delimitador do arquivo CSV.", "example": ",", "required": false }, "encapsulator": { "type": "string", "description": "Campo que encapsula", "example": "\"", "required": false }, "agenda": { "type": null, "description": "Arquivo em CSV no formato esperado. Para exemplo, consulte Assist >> Adm Agenda.", "example": "arquivo.csv", "required": true } } } } } } } }, "\/MensagemTemplate\/buscarPorNomeLike": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar template por peda\u00e7o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o do nome da mensagem para pesquisa. Prefixado pelo nome do servidor", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o do nome da mensagem para pesquisa. Prefixado pelo nome do servidor", "example": "chat.letteldata.com.br|endosc", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemTemplate\/all": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar todos registros de Template", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemTemplate\/delete": { "post": { "tags": [ "Omnichannel" ], "summary": "Deletar um registro de Template", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Template", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Mensagem Template", "example": 1, "required": true } } } } } } } }, "\/MensagemTemplate\/get": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar um registro de Template", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Mensagem Template", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Mensagem Template", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemTemplate\/persist": { "post": { "tags": [ "Omnichannel" ], "summary": "Cadastrar ou Alterar um registro de Template", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Template", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "numero", "cliente", "titulo", "categoria", "mensagem", "comportamento" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Mensagem Template", "example": 1, "required": false }, "numero": { "type": "string", "description": "N\u00famero vinculado ao template", "example": "5554984087777", "required": true }, "cliente": { "type": "string", "description": "Endere\u00e7o de chat do cliente", "example": "chat.letteldata.com.br", "required": true }, "titulo": { "type": "string", "description": "T\u00edtulo do Template, como cadastrado no broker", "example": "Redeem de Pontos", "required": true }, "categoria": { "type": "string", "description": "Categoria do Template, como cadastrado no broker", "example": "ACCOUNT_UPDATE", "required": true }, "mensagem": { "type": "string", "description": "Mensagem de Template, como cadastrado no broker", "example": "You have redeemed {{1}} points on {{2}}.", "required": true }, "comportamento": { "type": null, "description": "S ou N (S para criar sala ou N para n\u00e3o criar sala)", "example": "S", "required": true }, "setor": { "type": "string", "description": "Setor", "example": "Comercial", "required": false } } } } } } } }, "\/ReportFila\/gerarIndicadoresCelula": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar indicadores completos do CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarIndicadoresPorHora": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar indicadores de hora do CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaEspera": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar indicadores de espera do CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaGeral": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta geral do CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaPorAgente": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta de agentes do CA", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortal\/alterarSenhaUsuarioPortalFromUser": { "post": { "tags": [ "Sistema" ], "summary": "Alterar a senha de um usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Alterar a senha de um usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "description": "Nova senha", "example": "123456", "required": true } } } } } } } }, "\/ConfiguracaoChaveValor\/getOpcoesTecnologias": { "get": { "tags": [ "Manager" ], "summary": "Buscar op\u00e7\u00f5es de tecnologias de discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar op\u00e7\u00f5es de tecnologias de discagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ConfiguracaoChaveValor\/getOpcoesRotas": { "get": { "tags": [ "Manager" ], "summary": "Buscar op\u00e7\u00f5es de rotas de discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar op\u00e7\u00f5es de rotas de discagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioPortalRole\/getOpcoesRoles": { "get": { "tags": [ "Sistema" ], "summary": "Buscar op\u00e7\u00f5es de roles de usu\u00e1rio portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "vars", "in": "query", "description": "Objeto de vari\u00e1veis", "required": true, "schema": { "type": "array", "description": "Objeto de vari\u00e1veis", "example": null, "required": true, "items": { "type": "string" } } }, { "name": "ramal", "in": "query", "description": "Ramal para definir vari\u00e1vel", "required": true, "schema": { "type": "string", "description": "Ramal para definir vari\u00e1vel", "example": "7003", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortalRole\/persist": { "post": { "tags": [ "Sistema" ], "summary": "Cadastrar ou Alterar um registro de Papel", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Papel", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome", "descricao" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Papel", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome do Papel", "example": "Relatorios", "required": true }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o do Papel", "example": "Relatorios", "required": true } } } } } } } }, "\/UsuarioPortalRole\/get": { "get": { "tags": [ "Sistema" ], "summary": "Buscar um registro de Papel", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Papel", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Papel", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortalRole\/delete": { "post": { "tags": [ "Sistema" ], "summary": "Deletar um registro de Papel", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Papel", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Papel", "example": 1, "required": true } } } } } } } }, "\/UsuarioPortalRole\/all": { "get": { "tags": [ "Sistema" ], "summary": "Buscar todos registros de Papel", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/UsuarioPortalRole\/getOpcoesRolesAndUsers": { "get": { "tags": [ "Sistema" ], "summary": "Buscar op\u00e7\u00f5es de roles e usu\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar op\u00e7\u00f5es de roles e usu\u00e1rios", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioPortalRole\/buscarInformacaoRole": { "get": { "tags": [ "Sistema" ], "summary": "Buscar informa\u00e7\u00f5es de Role", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Role", "required": true, "schema": { "type": "integer", "description": "ID do Role", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ListaFacilidades\/all": { "get": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "Buscar todos registros de Lista Facilidades", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ListaFacilidades\/delete": { "post": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "Deletar um registro de Lista Facilidades", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Lista Facilidades", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Lista", "example": 1, "required": true } } } } } } } }, "\/ListaFacilidades\/get": { "get": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "Buscar um registro de Lista Facilidades", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Lista", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Lista", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ListaFacilidades\/persist": { "post": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "Cadastrar ou Alterar um registro de Lista Facilidades", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Lista Facilidades", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome", "data", "options", "lista" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Lista", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome da Lista", "example": "Lista B\u00e1sica", "required": true }, "data": { "type": "string", "description": "Timestamp de Atualiza\u00e7\u00e3o da Lista", "example": "2021-05-29 11:04:00", "required": true }, "options": { "type": null, "description": "Op\u00e7\u00f5es no Formato JSON", "example": "{\"number\":6,\"titulo\":\"Facilidades Convert\",\"largura\":5.5,\"fonte\":12}", "required": true }, "lista": { "type": null, "description": "Lista no Formato JSON", "example": "[]", "required": true }, "public": { "type": "integer", "description": "Define se a lista \u00e9 p\u00fablica", "example": 1, "required": false } } } } } } } }, "\/ListaFacilidades\/buscarListaSistema": { "get": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "Buscar a Lista atual de Facilidades", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar a Lista atual de Facilidades", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/ListaFacilidades\/buscarListaPublica": { "get": { "tags": [ "Documenta\u00e7\u00e3o" ], "summary": "Buscar lista p\u00fablica de facilidades", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "name": "id", "in": "query", "description": "ID do Registro de Lista", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Lista", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/definirPadroesTouch": { "post": { "tags": [ "Manager" ], "summary": "Definir padr\u00f5es touch", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Definir padr\u00f5es touch", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "padroes" ], "properties": { "padroes": { "type": null, "description": "JSON em formato String", "example": "{}", "required": true } } } } } } } }, "\/RamalConvert\/buscarPadroesTouch": { "get": { "tags": [ "Manager" ], "summary": "Buscar padr\u00f5es touch", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar padr\u00f5es touch", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Autocomplete\/persist": { "post": { "tags": [ "Autocomplete" ], "summary": "Cadastrar ou Alterar um registro de Autocomplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Autocomplete", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "tipo", "nome", "prioridade" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Autocomplete", "example": 1, "required": false }, "tipo": { "type": "string", "description": "Tipo de Autocomplete", "example": "CONTEXTO", "required": true }, "nome": { "type": "string", "description": "Nome do Autocomplete", "example": "interno-ramais", "required": true }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o do Autocomplete", "example": "Contexto interno ramais", "required": false }, "prioridade": { "type": "integer", "description": "Prioridade", "example": null, "required": true } } } } } } } }, "\/Autocomplete\/get": { "get": { "tags": [ "Autocomplete" ], "summary": "Buscar um registro de Autocomplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Registro de Autocomplete", "required": true, "schema": { "type": "integer", "description": "ID do Registro de Autocomplete", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Autocomplete\/delete": { "post": { "tags": [ "Autocomplete" ], "summary": "Deletar um registro de Autocomplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Autocomplete", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Registro de Autocomplete", "example": 1, "required": true } } } } } } } }, "\/Autocomplete\/all": { "get": { "tags": [ "Autocomplete" ], "summary": "Buscar todos registros de Autocomplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Autocomplete\/getOpcoesAutocomplete": { "get": { "tags": [ "Sistema" ], "summary": "Buscar autocomplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "tipo", "in": "query", "description": "Tipo do autocomplete", "required": true, "schema": { "type": "string", "description": "Tipo do autocomplete", "example": "CONTEXTO", "required": true } }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o a ser buscado", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o a ser buscado", "example": "interno", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemFavorita\/buscarMensagemFavoritaLike": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar mensagens favoritas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "setor", "in": "query", "description": "Setor", "required": false, "schema": { "type": "string", "description": "Setor", "example": "Comercial", "required": false } }, { "name": "cliente", "in": "query", "description": "Endere\u00e7o de chat do cliente", "required": true, "schema": { "type": "string", "description": "Endere\u00e7o de chat do cliente", "example": "chat.letteldata.com.br", "required": true } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemTemplate\/buscarMensagemTemplateLike": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar mensagem template like", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "setor", "in": "query", "description": "Setor", "required": false, "schema": { "type": "string", "description": "Setor", "example": "Comercial", "required": false } }, { "name": "cliente", "in": "query", "description": "Endere\u00e7o de chat do cliente", "required": false, "schema": { "type": "string", "description": "Endere\u00e7o de chat do cliente", "example": "chat.letteldata.com.br", "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/MensagemTemplate\/buscarLinhasCliente": { "get": { "tags": [ "Omnichannel" ], "summary": "Buscar numeros do cliente", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "cliente", "in": "query", "description": "Endere\u00e7o de chat do cliente", "required": true, "schema": { "type": "string", "description": "Endere\u00e7o de chat do cliente", "example": "chat.letteldata.com.br", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/buscarInformacaoRamal": { "get": { "tags": [ "Ramais" ], "summary": "Buscar informa\u00e7\u00e3o de um ramal no momento", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "ramal", "in": "query", "description": "Ramal para consulta", "required": true, "schema": { "type": "string", "description": "Ramal para consulta", "example": "7003", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/getRamalPorDial": { "get": { "tags": [ "Manager" ], "summary": "Buscar ramal por dial", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "dial", "in": "query", "description": "Dial", "required": true, "schema": { "type": "string", "description": "Dial", "example": "SIP\/7003", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Integracao\/executarLigacaoPipeRun": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Executar Ligacao Automaticamente via PipeRun", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Executar Ligacao Automaticamente via PipeRun", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Integracao\/getGravacaoPipeRun": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar grava\u00e7\u00e3o Pipe.Run", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar grava\u00e7\u00e3o Pipe.Run", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Report\/buscarGravacaoPorNonce": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar grava\u00e7\u00e3o por nonce", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar grava\u00e7\u00e3o por nonce", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/PesquisaContato\/pesquisaFull": { "get": { "tags": [ "LGPD \/ Privacidade" ], "summary": "Pesquisar contato", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Pesquisar contato", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Report\/getStatusMonitoramento": { "get": { "tags": [ "Utils" ], "summary": "Buscar status do Server", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar status do Server", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalConvert\/setVars": { "post": { "tags": [ "Manager" ], "summary": "Definir m\u00faltiplas vari\u00e1veis para liga\u00e7\u00e3o ativa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Definir m\u00faltiplas vari\u00e1veis para liga\u00e7\u00e3o ativa", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Audio\/previewAudioTTS": { "post": { "tags": [ "\u00c1udio" ], "summary": "Preview de \u00c1udio TTS", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Preview de \u00c1udio TTS", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "texto" ], "properties": { "texto": { "type": "string", "description": "Texto para Convers\u00e3o", "example": "Ol\u00e1 TTS", "required": true }, "voz": { "type": "string", "description": "Voz para o \u00e1udio", "example": "Antonio", "required": false } } } } } } } }, "\/Popup\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um Popup", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um Popup", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome" ], "properties": { "id": { "type": "integer", "description": "ID do Popup", "example": 1, "required": false }, "nome": { "type": "string", "description": "Nome do Popup", "example": "Teste Popup", "required": true }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o do Popup", "example": "Popup de Teste", "required": false }, "custom": { "type": "string", "description": "Custom Script do Popup", "example": "teste-custom", "required": false }, "objeto": { "type": null, "description": "Objeto JSON", "example": "{}", "required": false } } } } } } } }, "\/Popup\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um Popup", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Popup", "required": true, "schema": { "type": "integer", "description": "ID do Popup", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Popup\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um Popup", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um Popup", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Popup", "example": 1, "required": true } } } } } } } }, "\/Popup\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos registros de Popup", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaTotais": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar totalizadores", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaContatos": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar contatos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaAgentes": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar indicadores de agentes", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorStatus": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por status", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorDia": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por dia", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorDiaSemana": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por dia da semana", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorHora": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por hor\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorArea": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por DDD (regi\u00e3o)", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorNumero": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por n\u00famero", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/getQueueMembersActive": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getQueueMembersActive", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Fila para consulta", "required": false, "schema": { "type": "string", "description": "Fila para consulta", "example": "440", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportIndicadores\/kpiSaidaPorTabulacao": { "get": { "tags": [ "Relat\u00f3rio de Filas - Sa\u00edda" ], "summary": "Buscar liga\u00e7\u00f5es por tabula\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "channel", "in": "query", "description": "Canal ou peda\u00e7o de Canal", "required": false, "schema": { "type": "string", "description": "Canal ou peda\u00e7o de Canal", "example": "Khomp\/B0C%", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo customizado", "required": false, "schema": { "type": "string", "description": "Campo customizado", "example": "12309", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-15", "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "dst", "in": "query", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "required": false, "schema": { "type": "string", "description": "N\u00famero de destino. Obedece padr\u00f5es inLike", "example": "0054984080610", "required": false } }, { "name": "dstchannel", "in": "query", "description": "Canal de destino, aceita inLike", "required": false, "schema": { "type": "string", "description": "Canal de destino, aceita inLike", "example": "SIP%", "required": false } }, { "name": "hora-fim", "in": "query", "description": "Hora final", "required": false, "schema": { "type": "string", "description": "Hora final", "example": "23:59:59", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": "00:00:00", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "boolean", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": true, "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "required": false, "schema": { "type": "string", "description": "ID da Integra\u00e7\u00e3o para Filtro. Aceita like", "example": "%30490%", "required": false } }, { "name": "min-time", "in": "query", "description": "Tempo m\u00ednimo de chamada", "required": false, "schema": { "type": "string", "description": "Tempo m\u00ednimo de chamada", "example": "00:00:00", "required": false } }, { "name": "ramais", "in": "query", "description": "Ramais Separados por V\u00edrgula", "required": false, "schema": { "type": "string", "description": "Ramais Separados por V\u00edrgula", "example": "7001,7002,7003", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/getOpcoesStatusFilasComplete": { "get": { "tags": [ "Autocomplete" ], "summary": "Select - getOpcoesStatusFilasComplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o a ser buscado", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o a ser buscado", "example": "COMPLETE", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaTabulacao": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta por Tabula\u00e7\u00e3o", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CampanhaDiscagem\/persist": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar ou Alterar um registro de Campanha Discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um registro de Campanha Discagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome", "data_inicial", "data_final", "hora_ini", "hora_fim", "tipo", "fila", "contexto", "retries", "wrapup", "status", "contexto_saida" ], "properties": { "id": { "type": "integer", "description": "Id da Campanha", "example": 10, "required": false }, "nome": { "type": "string", "description": "Nome da Campanha", "example": "Campanha 01", "required": true }, "data_inicial": { "type": "string", "description": "Data Inicial", "example": "2022-04-01", "required": true }, "data_final": { "type": "string", "description": "Data Final", "example": "2022-04-30", "required": true }, "hora_ini": { "type": "string", "description": "Hora Inicial", "example": "08:00:00", "required": true }, "hora_fim": { "type": "string", "description": "Hora Final", "example": "18:00:00", "required": true }, "tipo": { "type": "string", "description": "Tipo da Campanha", "example": "HUMAN", "required": true }, "fila": { "type": "string", "description": "Fila para Usar", "example": "450", "required": true }, "contexto": { "type": "string", "description": "Contexto da Campanha", "example": "interno-ramais", "required": true }, "retries": { "type": "integer", "description": "Quantidade de Vezes para Tentar", "example": 10, "required": true }, "wrapup": { "type": "integer", "description": "Tempo de Wrapup (em segundos)", "example": 10, "required": true }, "status": { "type": "string", "description": "Status da Campanha", "example": "10", "required": true }, "contexto_saida": { "type": "string", "description": "Contexto de saida da Campanha", "example": "saida-discador", "required": true } } } } } } } }, "\/CampanhaDiscagem\/get": { "get": { "tags": [ "Assist" ], "summary": "Buscar um registro de Campanha Discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID da Campanha", "required": true, "schema": { "type": "integer", "description": "ID da Campanha", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CampanhaDiscagem\/delete": { "post": { "tags": [ "Assist" ], "summary": "Deletar um registro de Campanha Discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um registro de Campanha Discagem", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID da Campanha", "example": 1, "required": true } } } } } } } }, "\/CampanhaDiscagem\/all": { "get": { "tags": [ "Assist" ], "summary": "Buscar todos registros de Campanha Discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CampanhaDiscagem\/encerrarListaCampanha": { "post": { "tags": [ "Assist" ], "summary": "Encerrar a lista de uma campanha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Encerrar a lista de uma campanha", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID da Campanha para Encerrar", "example": 5, "required": true } } } } } } } }, "\/Actions\/reloadMonitoramento": { "post": { "tags": [ "Manager" ], "summary": "Reload do Monitoramento de Ramais e CAs", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Reload do Monitoramento de Ramais e CAs", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/CampanhaDiscagem\/getPendentes": { "get": { "tags": [ "Assist" ], "summary": "Buscar contatos pendentes de uma campanha", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID da Campanha para pegar Pendentes", "required": true, "schema": { "type": "integer", "description": "ID da Campanha para pegar Pendentes", "example": 5, "required": true } }, { "name": "limit", "in": "query", "description": "Limit de Pendentes", "required": true, "schema": { "type": "integer", "description": "Limit de Pendentes", "example": 100, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/CampanhaDiscagem\/importarListaContatos": { "post": { "tags": [ "Assist" ], "summary": "Importar lista de contatos", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Importar lista de contatos", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "lista" ], "properties": { "id": { "type": "integer", "description": "ID da Campanha para Importa\u00e7\u00e3o", "example": 5, "required": true }, "lista": { "type": null, "description": "Lista no Formato JSON", "example": "[]", "required": true } } } } } } } }, "\/CampanhaDiscagem\/removerRegistrosPendentesSelecionados": { "post": { "tags": [ "Assist" ], "summary": "Remover contatos em lista", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Remover contatos em lista", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id", "lista" ], "properties": { "id": { "type": "integer", "description": "ID da Campanha para Importa\u00e7\u00e3o", "example": 5, "required": true }, "lista": { "type": null, "description": "Lista no Formato JSON", "example": "[]", "required": true } } } } } } } }, "\/CampanhaDiscagem\/getStatsCampanha": { "get": { "tags": [ "Assist" ], "summary": "Buscar estat\u00edsticas de uma Campanha de Discagem", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID da Campanha para pegar Status", "required": true, "schema": { "type": "integer", "description": "ID da Campanha para pegar Status", "example": 5, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Popup\/buscarPorNomeLike": { "get": { "tags": [ "Assist" ], "summary": "Buscar popups para autocomplete", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "pedaco", "in": "query", "description": "Peda\u00e7o a ser buscado", "required": true, "schema": { "type": "string", "description": "Peda\u00e7o a ser buscado", "example": "Teste", "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaPorDiaSemana": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta por dia da semana", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaPorDiaMes": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta por dia do m\u00eas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/RamalConvert\/definirPadroesClickToCall": { "post": { "tags": [ "Manager" ], "summary": "Definir padr\u00f5es click-to-call", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Definir padr\u00f5es click-to-call", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "padroes" ], "properties": { "padroes": { "type": null, "description": "JSON em formato String", "example": "{}", "required": true } } } } } } } }, "\/RamalConvert\/buscarPadroesClickToCall": { "get": { "tags": [ "Manager" ], "summary": "Buscar padr\u00f5es click-to-call", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar padr\u00f5es click-to-call", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/RamalConvert\/isReloadPending": { "get": { "tags": [ "Ramais" ], "summary": "Verificar se tem reload pending", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Verificar se tem reload pending", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/getAuthInfo": { "get": { "tags": [ "Manager" ], "summary": "Buscar o tipo de autentica\u00e7\u00e3o e o dom\u00ednio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar o tipo de autentica\u00e7\u00e3o e o dom\u00ednio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Configuracao\/getConfigOptions": { "get": { "tags": [ "Sistema" ], "summary": "Buscar op\u00e7\u00f5es de sistema", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Basic 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar op\u00e7\u00f5es de sistema", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/UsuarioPresenca\/cadastrarUsuarioERamal": { "post": { "tags": [ "Assist" ], "summary": "Cadastrar usu\u00e1rio e ramal na mesma API", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar usu\u00e1rio e ramal na mesma API", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "ramal": { "type": "array", "description": "Objeto de ramal com as propriedades, como RamalConvert\/persist", "example": null, "required": false, "items": { "type": "string" } }, "usuario": { "type": "array", "description": "Objeto de usu\u00e1rio com as proprieades, como UsuarioPresenca\/persist", "example": null, "required": false, "items": { "type": "string" } } } } } } } } }, "\/Integracao\/getGravacaoCRM": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar grava\u00e7\u00e3o CRM", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar grava\u00e7\u00e3o CRM", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/HorarioGrupo\/all": { "get": { "tags": [ "Manager" ], "summary": "Buscar todos os Grupos de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/HorarioGrupo\/delete": { "post": { "tags": [ "Manager" ], "summary": "Deletar um Grupo de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar um Grupo de Hor\u00e1rios", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID do Grupo de Hor\u00e1rios", "example": 1, "required": true } } } } } } } }, "\/HorarioGrupo\/get": { "get": { "tags": [ "Manager" ], "summary": "Buscar um Grupo de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID do Grupo de Hor\u00e1rios", "required": true, "schema": { "type": "integer", "description": "ID do Grupo de Hor\u00e1rios", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/HorarioGrupo\/persist": { "post": { "tags": [ "Manager" ], "summary": "Cadastrar ou Alterar um Grupo de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar um Grupo de Hor\u00e1rios", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome", "apelido" ], "properties": { "nome": { "type": "string", "description": "Nome do Grupo de Hor\u00e1rios", "example": "Feriados", "required": true }, "apelido": { "type": "string", "description": "Apelido do Grupo de Hor\u00e1rios", "example": "feriados", "required": true }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o do Grupo de Hor\u00e1rios", "example": "Datas referentes a feriados", "required": false } } } } } } } }, "\/HorarioGrupo\/getRegrasPorGrupo": { "get": { "tags": [ "Manager" ], "summary": "Buscar todas as Regras de Hor\u00e1rio de um Grupo de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id_horario_grupo", "in": "query", "description": "ID do Grupo de Hor\u00e1rios", "required": true, "schema": { "type": "integer", "description": "ID do Grupo de Hor\u00e1rios", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/HorarioGrupo\/persistRegrasPorGrupo": { "post": { "tags": [ "Manager" ], "summary": "Cadastrar ou Alterar as Regras de Hor\u00e1rio de um Grupo de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar ou Alterar as Regras de Hor\u00e1rio de um Grupo de Hor\u00e1rios", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_horario_grupo", "regras" ], "properties": { "id_horario_grupo": { "type": "integer", "description": "ID do Grupo de Hor\u00e1rios", "example": 1, "required": true }, "regras": { "type": null, "description": "Regras de Hor\u00e1rio no formato JSON", "example": "[]", "required": true } } } } } } } }, "\/HorarioGrupo\/testarGrupo": { "post": { "tags": [ "Manager" ], "summary": "Testar as Regras de Hor\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Testar as Regras de Hor\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_horario_grupo" ], "properties": { "id_horario_grupo": { "type": "integer", "description": "ID do Grupo de Hor\u00e1rios ou seu apelido", "example": 1, "required": true }, "date": { "type": "string", "description": "Uma data espec\u00edfica", "example": "2023-03-28 16:53", "required": false } } } } } } } }, "\/HorarioGrupo\/clonarGrupo": { "post": { "tags": [ "Manager" ], "summary": "Clonar um Grupo de Hor\u00e1rios", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Clonar um Grupo de Hor\u00e1rios", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id_horario_grupo" ], "properties": { "id_horario_grupo": { "type": "integer", "description": "ID do Grupo de Hor\u00e1rios", "example": 1, "required": true }, "dados": { "type": null, "description": "Nome, apelido e descri\u00e7\u00e3o do novo Grupo de Hor\u00e1rios no formato JSON", "example": "[]", "required": false } } } } } } } }, "\/RamalConvert\/getRamaisByTech": { "get": { "tags": [ "Ramais" ], "summary": "Buscar dados espec\u00edficos de ramais das tecnologias sip, iax, pabx, khomp e teams", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Buscar dados espec\u00edficos de ramais das tecnologias sip, iax, pabx, khomp e teams", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/Rotina\/all": { "get": { "tags": [ "Sistema" ], "summary": "Buscar todas as Rotinas cadastradas", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "length", "in": "query", "description": "Quantidade de registros buscados", "required": false, "schema": { "type": "integer", "description": "Quantidade de registros buscados", "example": 10, "required": false } }, { "name": "q", "in": "query", "description": "Termo de consulta para filtro em diversos campos", "required": false, "schema": { "type": "string", "description": "Termo de consulta para filtro em diversos campos", "example": "teste", "required": false } }, { "name": "start", "in": "query", "description": "Limite inicial dos registros", "required": false, "schema": { "type": "integer", "description": "Limite inicial dos registros", "example": null, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Rotina\/delete": { "post": { "tags": [ "Sistema" ], "summary": "Deletar uma Rotina", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Deletar uma Rotina", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "ID da Rotina", "example": 1, "required": true } } } } } } } }, "\/Rotina\/buscarParaEdicao": { "get": { "tags": [ "Sistema" ], "summary": "Buscar uma Rotina espec\u00edfica", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "id", "in": "query", "description": "ID da Rotina", "required": true, "schema": { "type": "integer", "description": "ID da Rotina", "example": 1, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/Rotina\/gerarTokenRemoto": { "post": { "tags": [ "Sistema" ], "summary": "Gerar um Token para um usu\u00e1rio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Gerar um Token para um usu\u00e1rio", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "user", "password" ], "properties": { "user": { "type": "string", "description": "Nome do usu\u00e1rio do Portal", "example": "convertmaster", "required": true }, "password": { "type": "string", "description": "Senha do usu\u00e1rio do Portal", "example": "senha12345", "required": true }, "host": { "type": "string", "description": "Host do servidor de destino", "example": "exemplo.convert.app.br", "required": false } } } } } } } }, "\/Rotina\/persist": { "post": { "tags": [ "Sistema" ], "summary": "Cadastra uma nova Rotina", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastra uma nova Rotina", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "nome", "descricao", "tipo", "json_config", "horario" ], "properties": { "nome": { "type": "string", "description": "Nome da Rotina", "example": "Rotina de Teste", "required": true }, "descricao": { "type": "string", "description": "Descri\u00e7\u00e3o da Rotina", "example": "Rotina destinada a Testes", "required": true }, "tipo": { "type": "string", "description": "Tipo da Rotina", "example": "dbsync-ramais", "required": true }, "json_config": { "type": null, "description": "Objeto JSON contendo as configura\u00e7\u00f5es da Rotina", "example": "{}", "required": true }, "horario": { "type": "string", "description": "Hor\u00e1rio de execu\u00e7\u00e3o da Rotina", "example": "20:00:00", "required": true }, "data_inicial": { "type": "string", "description": "Data inicial de execu\u00e7\u00e3o da Rotina", "example": "2001-01-01", "required": false }, "data_final": { "type": "string", "description": "Data final de execu\u00e7\u00e3o da Rotina", "example": "2099-12-31", "required": false }, "max_records": { "type": "integer", "description": "N\u00famero m\u00e1ximo de execu\u00e7\u00f5es da Rotina", "example": 10000, "required": false } } } } } } } }, "\/Rotina\/simularRotina": { "post": { "tags": [ "Sistema" ], "summary": "Simular uma Rotina", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Simular uma Rotina", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "rotina" ], "properties": { "rotina": { "type": null, "description": "Objeto JSON contendo os dados da Rotina", "example": "{}", "required": true } } } } } } } }, "\/ReportFila\/gerarConsultaRankingPorNumero": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta por n\u00famero", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/ReportFila\/gerarConsultaPorRegiao": { "get": { "tags": [ "Relat\u00f3rio de Filas - Entrada" ], "summary": "Gerar consulta por DDD", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "data-fim", "in": "query", "description": "Data Final", "required": false, "schema": { "type": "string", "description": "Data Final", "example": "2020-08-01", "required": false } }, { "name": "src", "in": "query", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "required": false, "schema": { "type": "string", "description": "Origem da liga\u00e7\u00e3o. Aceita o tipo inLike", "example": "5498408610", "required": false } }, { "name": "transfer", "in": "query", "description": "transfer", "required": false, "schema": { "type": "string", "description": "transfer", "example": "-", "required": false } }, { "name": "hold-min", "in": "query", "description": "Tempo m\u00ednimo de espera", "required": false, "schema": { "type": "integer", "description": "Tempo m\u00ednimo de espera", "example": null, "required": false } }, { "name": "status", "in": "query", "description": "String do Status", "required": false, "schema": { "type": "string", "description": "String do Status", "example": "-", "required": false } }, { "name": "custom-field", "in": "query", "description": "Campo Customizado", "required": false, "schema": { "type": "string", "description": "Campo Customizado", "example": "teste", "required": false } }, { "name": "id-integracao", "in": "query", "description": "ID de Integra\u00e7\u00e3o", "required": false, "schema": { "type": "string", "description": "ID de Integra\u00e7\u00e3o", "example": "123", "required": false } }, { "name": "fila", "in": "query", "description": "N\u00famero da Fila (CA) buscado", "required": true, "schema": { "type": "string", "description": "N\u00famero da Fila (CA) buscado", "example": "440", "required": true } }, { "name": "canal-destino", "in": "query", "description": "Canal de destino", "required": false, "schema": { "type": "string", "description": "Canal de destino", "example": "SIP\/7001%", "required": false } }, { "name": "canal-origem", "in": "query", "description": "Canal de origem", "required": false, "schema": { "type": "string", "description": "Canal de origem", "example": "SIP\/7001%", "required": false } }, { "name": "horario-comercial", "in": "query", "description": "Define se deve obedecer hor\u00e1rio comercial", "required": false, "schema": { "type": "string", "description": "Define se deve obedecer hor\u00e1rio comercial", "example": "1", "required": false } }, { "name": "hora-ini", "in": "query", "description": "Hora inicial", "required": false, "schema": { "type": "string", "description": "Hora inicial", "example": null, "required": false } }, { "name": "data-ini", "in": "query", "description": "Data inicial", "required": false, "schema": { "type": "string", "description": "Data inicial", "example": "2020-08-01", "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DeskManager\/searchUsersDeskManager": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar usu\u00e1rios do Desk Manager", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "q", "in": "query", "description": "Argumento de pesquisa", "required": true, "schema": { "type": "string", "description": "Argumento de pesquisa", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DeskManager\/searchTicketsDeskManager": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar tickets do Desk Manager", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "codigo", "in": "query", "description": "C\u00f3digo do Cliente", "required": true, "schema": { "type": "string", "description": "C\u00f3digo do Cliente", "example": null, "required": true } }, { "name": "limit", "in": "query", "description": "Limite (padr\u00e3o 10)", "required": false, "schema": { "type": "integer", "description": "Limite (padr\u00e3o 10)", "example": 10, "required": false } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DeskManager\/searchTicketByCodDeskManager": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar ticket do Desk Manager", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "codigo", "in": "query", "description": "C\u00f3digo do Ticket", "required": true, "schema": { "type": "string", "description": "C\u00f3digo do Ticket", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DeskManager\/registerTicketDeskManager": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Registrar Ticket no Desk Manager", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Registrar Ticket no Desk Manager", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "codigo", "email" ], "properties": { "codigo": { "type": "string", "description": "C\u00f3digo do Cliente", "example": null, "required": true }, "email": { "type": "string", "description": "E-mail do Cliente", "example": null, "required": true }, "assunto": { "type": "string", "description": "Assunto e Descri\u00e7\u00e3o", "example": "Ticket Gerado por WhatsApp", "required": false } } } } } } } }, "\/DeskManager\/searchOperatorExtensionByTicketDeskManager": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar Ramal pelo C\u00f3digo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "codigo", "in": "query", "description": "C\u00f3digo do Ticket", "required": true, "schema": { "type": "string", "description": "C\u00f3digo do Ticket", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/DeskManager\/reopenTicketDeskManager": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Reabrir Ticket", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Reabrir Ticket", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "chave" ], "properties": { "chave": { "type": "string", "description": "Chave do Ticket", "example": null, "required": true } } } } } } } }, "\/DeskManager\/interactTicketDeskManager": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Interagir um Chamado", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Interagir um Chamado", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "chave", "text" ], "properties": { "chave": { "type": "string", "description": "Chave do Ticket", "example": null, "required": true }, "text": { "type": "string", "description": "Texto para Intera\u00e7\u00e3o", "example": null, "required": true }, "ramal": { "type": "string", "description": "Ramal para Buscar Owner", "example": null, "required": false }, "forma_atendimento": { "type": "string", "description": "Forma de Atendimento para Override", "example": null, "required": false } } } } } } } }, "\/DeskManager\/searchOperatorEmailByTicketDeskManager": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar E-mail pelo C\u00f3digo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "codigo", "in": "query", "description": "C\u00f3digo do Ticket", "required": true, "schema": { "type": "string", "description": "C\u00f3digo do Ticket", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PipeRun\/createPersonPipeRun": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Cadastrar uma pessoa no Pipe.Run", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Cadastrar uma pessoa no Pipe.Run", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "numero", "nome" ], "properties": { "numero": { "type": "string", "description": "N\u00famero para pesquisa", "example": null, "required": true }, "nome": { "type": "string", "description": "Nome do Contato", "example": null, "required": true } } } } } } } }, "\/PipeRun\/searchEverythingPipeRun": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Pesquisar no Pipe.Run", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "numero", "in": "query", "description": "N\u00famero para pesquisa", "required": true, "schema": { "type": "string", "description": "N\u00famero para pesquisa", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PipeRun\/searchDealsPipeRun": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Pesquisar Tickets de uma Pessoa", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "person_id", "in": "query", "description": "Id da Pessoa do Pipe", "required": true, "schema": { "type": "string", "description": "Id da Pessoa do Pipe", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PipeRun\/addActivityCustomPipeRun": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Registrar Atividade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Registrar Atividade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "status", "activity_type_id", "owner_id", "deal_id", "title", "description" ], "properties": { "status": { "type": "string", "description": "Status da atividade (2 para fechada)", "example": null, "required": true }, "activity_type_id": { "type": "string", "description": "Tipo da atividade (mapeada no Pipe)", "example": null, "required": true }, "owner_id": { "type": "string", "description": "Dono padr\u00e3o da atividade", "example": null, "required": true }, "deal_id": { "type": "string", "description": "Id da Atividade", "example": null, "required": true }, "title": { "type": "string", "description": "T\u00edtulo da Intera\u00e7\u00e3o", "example": null, "required": true }, "description": { "type": "string", "description": "Descri\u00e7\u00e3o da Intera\u00e7\u00e3o", "example": null, "required": true } } } } } } } }, "\/ReportCDR\/getTranscript": { "get": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Buscar a transcri\u00e7\u00e3o de um \u00e1udio", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" }, { "name": "uniqueid", "in": "query", "description": "Uniqueid da liga\u00e7\u00e3o", "required": true, "schema": { "type": "string", "description": "Uniqueid da liga\u00e7\u00e3o", "example": null, "required": true } } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } } } }, "\/PipeRun\/createDealPipeRun": { "post": { "tags": [ "Integra\u00e7\u00f5es" ], "summary": "Criar uma oportunidade", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Criar uma oportunidade", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "pipeline_id", "stage_id" ], "properties": { "pipeline_id": { "type": "integer", "description": "Id do Pipeline", "example": 100, "required": true }, "stage_id": { "type": "integer", "description": "Id do Est\u00e1gio", "example": 123, "required": true }, "title": { "type": "string", "description": "T\u00edtulo da Oportunidade", "example": "Oportunidade criada por telefone", "required": false } } } } } } } }, "\/UsuarioPortal\/solicitarResetSenhaPortal": { "post": { "tags": [ "Sistema" ], "summary": "Solicitar Reset Senha Portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Solicitar Reset Senha Portal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "email", "login" ], "properties": { "email": { "type": "string", "description": "E-mail", "example": "teste@gmail.com", "required": true }, "login": { "type": "string", "description": "Login", "example": "teste", "required": true } } } } } } } }, "\/UsuarioPortal\/resetarSenhaAtravesDeLinkPortal": { "post": { "tags": [ "Sistema" ], "summary": "Resetar senha atrav\u00e9s de link recebido por e-mail Portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Resetar senha atrav\u00e9s de link recebido por e-mail Portal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "hash", "password" ], "properties": { "hash": { "type": "string", "description": "Hash", "example": "j324k23j402934823049328", "required": true }, "password": { "type": "string", "description": "", "example": null, "required": true } } } } } } } }, "\/AuthTFA\/ativarTFA": { "post": { "tags": [ "Sistema" ], "summary": "Ativar o 2FA para usu\u00e1rio no portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Ativar o 2FA para usu\u00e1rio no portal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/AuthTFA\/vincularUsuarioTFA": { "post": { "tags": [ "Sistema" ], "summary": "Gerar secret para v\u00ednculo de 2fa para um user do portal", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Gerar secret para v\u00ednculo de 2fa para um user do portal", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/AuthTFA\/verificarStatusTFA": { "get": { "tags": [ "Sistema" ], "summary": "Verificar se usu\u00e1rio est\u00e1 com o TFA ativo", "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": "Verificar se usu\u00e1rio est\u00e1 com o TFA ativo", "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } }, "\/API\/buscarDocumentacaoOpenAPI": { "get": { "tags": [ "M\u00e9todo para buscar documenta\u00e7\u00e3o da API OpenAPI" ], "summary": null, "parameters": [ { "in": "path", "name": "serverUrl", "required": true, "description": "URL do servidor" }, { "in": "header", "name": "Authorization", "required": true, "description": "Token de autoriza\u00e7\u00e3o", "example": "Bearer 1k3o1k051134ki13k5l1kp51" } ], "responses": { "200": { "description": "Sucesso", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status da resposta (pode ser 200 ou 400)...", "example": 200 }, "msg": { "type": "string", "example": "Sucesso", "description": "Mensagem de retorno da request" }, "data": { "type": "object", "example": { "id": 1, "nome": "Nome do registro", "descricao": "Descri\u00e7\u00e3o do registro" } } } } } } } }, "requestBody": { "description": null, "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [], "properties": { "": { "type": null, "description": "", "example": null, "required": false } } } } } } } } } }