projeto-hit/backend/swagger.yaml

436 lines
18 KiB
YAML

openapi: 3.0.0
info:
title: SLM-OMNIHIT-INTEGRATION
description: This API describes the endpoints and parameters to integrate the omnihit application with the SLM from hit telecommunications.
contact: {}
version: "1.0"
servers:
- url: http://177.107.192.247:8095/labs/monitoramentohit/api/api.php
variables: {}
- url: http://172.31.187.4:8080/omnihit/incidente
variables: {}
paths:
/labs/monitoramentohit/api/api.php consultachamadostatus:
post:
tags:
- SLM
summary: Consulta status do chamado
description: Consulta status do chamado
operationId: Consultastatusdochamado
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- auth
- jsonrpc
- method
- id
- params[n_chamado_web]
type: object
properties:
auth:
type: string
example: 0123ce68c916783282f6c66451164g22
jsonrpc:
type: number
format: double
example: 2
method:
type: string
example: omnihit.consultachamadostatus
id:
type: integer
format: int32
example: 101
params[n_chamado_web]:
type: string
example: 200-322094
required: false
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
example:
jsonrpc: "2.0"
result: close
id: "101"
example:
jsonrpc: "2.0"
result: close
id: "101"
deprecated: false
security: []
servers:
- url: http://177.107.192.247:8095/labs/monitoramentohit/api/api.php
variables: {}
/labs/monitoramentohit/api/api.php consultachamado:
post:
tags:
- SLM
summary: Consulta chamado
description: Consulta chamado
operationId: Consultachamado
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- jsonrpc
- method
- id
- params[n_chamado_web]
- auth
type: object
properties:
jsonrpc:
type: number
format: double
example: 2
method:
type: string
example: omnihit.consultachamado
id:
type: integer
format: int32
example: 101
params[n_chamado_web]:
type: string
example: 200-323882
auth:
type: string
example: 0123ce68c916783282f6c66451164g22
required: false
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
example:
jsonrpc: "2.0"
result: "Olá! Sou o atendente Inteligente do grupo HIT! \U0001F916\r\nEspero que você esteja bem. Estou aqui para mantê-lo atualizado sobre o chamado referente à unidade 0001 - Hit World Teste. Meu objetivo é garantir que você esteja plenamente informado sobre o incidente e possa acompanhar todos os detalhes de perto. ❗\r\n\r\n*Protocolo:* 200-323882\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n*Nome do cliente:* Hit World Teste\r\n*Nome da filial:* Hit World Teste\r\n*Código do cliente:* 0001\r\n\r\n*Informação de abertura:* Teste Felipe Ribeiro 16:37\r\n*Contato:* Felipe Ribeiro *Telefone:* 17988310949\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n\r\n*Status do Chamado:* Aguardando\r\n*Atualização do chamado pelo cliente:* Este é um teste de integração SLM X WA para o Adriano 16:41h\r\n*Data da atualização:* 17/07/2023 16:41:21\r\n\r\n*Status do Chamado:* Em Atendimento\r\n*Atualização do chamado pela HIT:* Este é um teste de integração do SLM X WA do Alan Oliveira\r\n*Data da atualização:* 17/07/2023 16:43:28\r\n\r\n*Status do Chamado:* Fechado\r\n*Atualização do chamado pela HIT:* Teste de integração SLM X WA realizado com sucesso por Alan e Adriano 16:45h\r\n*Status de Encerramento:* Chamado concluído\r\n*Data do encerramento:* 17/07/2023 16:45:17\r\n"
id: "101"
example:
jsonrpc: "2.0"
result: "Olá! Sou o atendente Inteligente do grupo HIT! \U0001F916\r\nEspero que você esteja bem. Estou aqui para mantê-lo atualizado sobre o chamado referente à unidade 0001 - Hit World Teste. Meu objetivo é garantir que você esteja plenamente informado sobre o incidente e possa acompanhar todos os detalhes de perto. ❗\r\n\r\n*Protocolo:* 200-323882\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n*Nome do cliente:* Hit World Teste\r\n*Nome da filial:* Hit World Teste\r\n*Código do cliente:* 0001\r\n\r\n*Informação de abertura:* Teste Felipe Ribeiro 16:37\r\n*Contato:* Felipe Ribeiro *Telefone:* 17988310949\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n\r\n*Status do Chamado:* Aguardando\r\n*Atualização do chamado pelo cliente:* Este é um teste de integração SLM X WA para o Adriano 16:41h\r\n*Data da atualização:* 17/07/2023 16:41:21\r\n\r\n*Status do Chamado:* Em Atendimento\r\n*Atualização do chamado pela HIT:* Este é um teste de integração do SLM X WA do Alan Oliveira\r\n*Data da atualização:* 17/07/2023 16:43:28\r\n\r\n*Status do Chamado:* Fechado\r\n*Atualização do chamado pela HIT:* Teste de integração SLM X WA realizado com sucesso por Alan e Adriano 16:45h\r\n*Status de Encerramento:* Chamado concluído\r\n*Data do encerramento:* 17/07/2023 16:45:17\r\n"
id: "101"
deprecated: false
security: []
servers:
- url: http://177.107.192.247:8095/labs/monitoramentohit/api/api.php
variables: {}
/labs/monitoramentohit/api/api.php chamadoaddobs:
post:
tags:
- SLM
summary: Insere info SLM
description: Insere info SLM
operationId: InsereinfoSLM
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- auth
- jsonrpc
- method
- id
- params[n_chamado_web]
- params[obs]
type: object
properties:
auth:
type: string
example: 0424bd59b807674191e7d77572075f33
jsonrpc:
type: number
format: double
example: 2
method:
type: string
example: omnihit.chamadoaddobs
id:
type: integer
format: int32
example: 101
params[n_chamado_web]:
type: string
example: 200-324398
params[obs]:
type: string
example: O tecnico já esta na unidade para prestar o suporte necessario.
required: false
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
example:
jsonrpc: "2.0"
result: Informação adicionada com sucesso.
id: "101"
example:
jsonrpc: "2.0"
result: Informação adicionada com sucesso.
id: "101"
deprecated: false
security: []
servers:
- url: http://177.107.192.247:8095/labs/monitoramentohit/api/api.php
variables: {}
/omnihit/incidente atdfechou:
post:
tags:
- OMNIHIT
summary: Webhook omnihit fechamento do chamado
operationId: Webhookomnihitfechamentodochamado
parameters:
- name: auth
in: header
description: ""
required: true
style: simple
schema:
type: string
example: 0424bd59b807674191e7d77572075f33
requestBody:
description: ""
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/WebhookomnihitfechamentodochamadoRequest"
- example:
n_chamado_web: 200-323934
action: atdfechou
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: "*Olá!*\r\n\r\n*Sou o atendente Inteligente do grupo HIT Communications! \U0001F916*\r\n\r\nGostaria de informar que o chamado referente à unidade 0001 - Hit World Teste foi encerrado. Estou à disposição para qualquer outra assistência através do mesmo número, na opção 4 - Suporte Técnico, ou em qualquer outro setor. A equipe da HIT Communications está pronta para auxiliá-lo em qualquer situação. \U0001F9E1\r\n\r\n*Protocolo:* 200-323882\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n*Nome do cliente:* Hit World Teste\r\n*Nome da filial:* Hit World Teste\r\n*Código do cliente:* 0001\r\n\r\n*Informação de abertura:* Teste Felipe Ribeiro 16:37\r\n*Contato:* Felipe Ribeiro *Telefone:* 17988310949\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n\r\n*Status do Chamado:* Aguardando\r\n*Atualização do chamado pelo cliente:* Este é um teste de integração SLM X WA para o Adriano 16:41h\r\n*Data da atualização:* 17/07/2023 16:41:21\r\n\r\n*Status do Chamado:* Em Atendimento\r\n*Atualização do chamado pela HIT:* Este é um teste de integração do SLM X WA do Alan Oliveira\r\n*Data da atualização:* 17/07/2023 16:43:28\r\n\r\n*Status do Chamado:* Fechado\r\n*Atualização do chamado pela HIT:* Teste de integração SLM X WA realizado com sucesso por Alan e Adriano 16:45h\r\n*Status de Encerramento:* Chamado concluído\r\n*Data do encerramento:* 17/07/2023 16:45:17\r\n\r\n\r\n"
example:
n_chamado_web: 200-323934
action: atdfechou
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: "*Olá!*\r\n\r\n*Sou o atendente Inteligente do grupo HIT Communications! \U0001F916*\r\n\r\nGostaria de informar que o chamado referente à unidade 0001 - Hit World Teste foi encerrado. Estou à disposição para qualquer outra assistência através do mesmo número, na opção 4 - Suporte Técnico, ou em qualquer outro setor. A equipe da HIT Communications está pronta para auxiliá-lo em qualquer situação. \U0001F9E1\r\n\r\n*Protocolo:* 200-323882\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n*Nome do cliente:* Hit World Teste\r\n*Nome da filial:* Hit World Teste\r\n*Código do cliente:* 0001\r\n\r\n*Informação de abertura:* Teste Felipe Ribeiro 16:37\r\n*Contato:* Felipe Ribeiro *Telefone:* 17988310949\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n\r\n*Status do Chamado:* Aguardando\r\n*Atualização do chamado pelo cliente:* Este é um teste de integração SLM X WA para o Adriano 16:41h\r\n*Data da atualização:* 17/07/2023 16:41:21\r\n\r\n*Status do Chamado:* Em Atendimento\r\n*Atualização do chamado pela HIT:* Este é um teste de integração do SLM X WA do Alan Oliveira\r\n*Data da atualização:* 17/07/2023 16:43:28\r\n\r\n*Status do Chamado:* Fechado\r\n*Atualização do chamado pela HIT:* Teste de integração SLM X WA realizado com sucesso por Alan e Adriano 16:45h\r\n*Status de Encerramento:* Chamado concluído\r\n*Data do encerramento:* 17/07/2023 16:45:17\r\n\r\n\r\n"
required: true
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
example:
message: Ok
example:
message: Ok
deprecated: false
security: []
servers:
- url: http://172.31.187.4:8080/omnihit/incidente
variables: {}
/omnihit/incidente atdabriu:
post:
tags:
- OMNIHIT
summary: Webhook omnihit abertura do chamado
operationId: Webhookomnihitaberturadochamado
parameters:
- name: auth
in: header
description: ""
required: true
style: simple
schema:
type: string
example: 0424bd59b807674191e7d77572075f33
requestBody:
description: ""
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/WebhookomnihitaberturadochamadoRequest"
- example:
n_chamado_web: 200-323934
action: atdabriu
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: ""
example:
n_chamado_web: 200-323934
action: atdabriu
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: ""
required: true
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
example:
message: Ok
example:
message: Ok
deprecated: false
security: []
servers:
- url: http://172.31.187.4:8080/omnihit/incidente
variables: {}
/omnihit/incidente atdatualizou:
post:
tags:
- OMNIHIT
summary: Webhook omnihit atualizacao do chamado
operationId: Webhookomnihitatualizacaodochamado
parameters:
- name: auth
in: header
description: ""
required: true
style: simple
schema:
type: string
example: 0424bd59b807674191e7d77572075f33
requestBody:
description: ""
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/WebhookomnihitatualizacaodochamadoRequest"
- example:
n_chamado_web: 200-323934
action: atdatualizou
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: ""
example:
n_chamado_web: 200-323934
action: atdatualizou
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: ""
required: true
responses:
"200":
description: ""
headers: {}
content:
text/plain:
schema:
type: string
example:
message: Ok
example:
message: Ok
deprecated: false
security: []
servers:
- url: http://172.31.187.4:8080/omnihit/incidente
variables: {}
components:
schemas:
WebhookomnihitfechamentodochamadoRequest:
title: WebhookomnihitfechamentodochamadoRequest
required:
- n_chamado_web
- action
- phone
- name
- mensagem
type: object
properties:
n_chamado_web:
type: string
action:
type: string
phone:
type: string
name:
type: string
mensagem:
type: string
example:
n_chamado_web: 200-323934
action: atdfechou
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: "*Olá!*\r\n\r\n*Sou o atendente Inteligente do grupo HIT Communications! \U0001F916*\r\n\r\nGostaria de informar que o chamado referente à unidade 0001 - Hit World Teste foi encerrado. Estou à disposição para qualquer outra assistência através do mesmo número, na opção 4 - Suporte Técnico, ou em qualquer outro setor. A equipe da HIT Communications está pronta para auxiliá-lo em qualquer situação. \U0001F9E1\r\n\r\n*Protocolo:* 200-323882\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n*Nome do cliente:* Hit World Teste\r\n*Nome da filial:* Hit World Teste\r\n*Código do cliente:* 0001\r\n\r\n*Informação de abertura:* Teste Felipe Ribeiro 16:37\r\n*Contato:* Felipe Ribeiro *Telefone:* 17988310949\r\n*Data de abertura:* 17/07/2023 16:38:08\r\n\r\n*Status do Chamado:* Aguardando\r\n*Atualização do chamado pelo cliente:* Este é um teste de integração SLM X WA para o Adriano 16:41h\r\n*Data da atualização:* 17/07/2023 16:41:21\r\n\r\n*Status do Chamado:* Em Atendimento\r\n*Atualização do chamado pela HIT:* Este é um teste de integração do SLM X WA do Alan Oliveira\r\n*Data da atualização:* 17/07/2023 16:43:28\r\n\r\n*Status do Chamado:* Fechado\r\n*Atualização do chamado pela HIT:* Teste de integração SLM X WA realizado com sucesso por Alan e Adriano 16:45h\r\n*Status de Encerramento:* Chamado concluído\r\n*Data do encerramento:* 17/07/2023 16:45:17\r\n\r\n\r\n"
WebhookomnihitaberturadochamadoRequest:
title: WebhookomnihitaberturadochamadoRequest
required:
- n_chamado_web
- action
- phone
- name
- mensagem
type: object
properties:
n_chamado_web:
type: string
action:
type: string
phone:
type: string
name:
type: string
mensagem:
type: string
example:
n_chamado_web: 200-323934
action: atdabriu
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: ""
WebhookomnihitatualizacaodochamadoRequest:
title: WebhookomnihitatualizacaodochamadoRequest
required:
- n_chamado_web
- action
- phone
- name
- mensagem
type: object
properties:
n_chamado_web:
type: string
action:
type: string
phone:
type: string
name:
type: string
mensagem:
type: string
example:
n_chamado_web: 200-323934
action: atdatualizou
phone: +55 17 988310949
name: ADRIANO TESTE
mensagem: ""
tags:
- name: SLM
- name: OMNIHIT