OMD - Sistema de Ouvidoria (2.1.1)
Download OpenAPI specification:
OMD Api
A API de manifestações do OMD permite o registro de manifestações que podem ser realizadas diretamente a partir do seu site ou importadas de e-mails ou outros sites.
Inserir uma nova manifestação
Inserir uma nova manifestação.
Authorizations:
Request Body schema: application/jsonrequired
| description required | string Texto descritivo da manifestação |
| occurrence_date_hour | string or null <date-time> ISO 8601 (AAAA-MM-DDT23:59:11.505-03:00) Data e hora da ocorrência. Se não informado o sistema utilizará a data e hora de envio para API |
object (InputMode) Default: null Modo de entrada da manifestação | |
object (Identification) Default: null Forma de identificação do manifestante | |
true (boolean) or false (boolean) Default: false Possui gravação telefônica | |
| involved | string or null Default: null Nomes dos envolvidos na manifestação |
object (Priority) Nível de prioridade | |
| final_date | string or null Default: null Prazo final para resposta. Caso não informado, o sistema irá calcular o prazo final com base nos parâmetros de configuração |
| previous_manifestation | string or null Código da manifestação anterior |
object (Ans) Default: null Dados específicos para o perfil ANS | |
object (City) Default: null Cidade da Ocorrência | |
required | object (Unit) Unidade da ocorrência |
object (Subject) Default: null Assunto da manifestação | |
object (Classification) Default: null Classificação da manifestação | |
object (ReturnMode) Default: null Modo de retorno da resposta da manifestação | |
object (Channel) Default: null Canal da manifestação | |
object (Analyst) Default: null Analista responsável | |
object (ProtesterType) Default: null Tipo de manifestante | |
object (Protester) Default: null Dados do manifestante | |
object (Source) Default: null Origem da manifestação | |
| integration_code | string Código de Integração |
Array of objects (Attachment) Anexos da manifestação |
Responses
Request samples
- Payload
{- "description": "Elogiando a nova API",
- "occurrence_date_hour": "2025-05-20T23:59:11.505-03:00",
- "input_mode": {
- "id": null,
- "name": "Site"
}, - "identification": {
- "id": null,
- "name": "Aberta"
}, - "has_recording": false,
- "involved": null,
- "priority": {
- "id": null,
- "name": "Alta"
}, - "final_date": null,
- "previous_manifestation": "233000416054",
- "ans": null,
- "city": {
- "id": null,
- "name": "Florianópolis"
}, - "unit_occurrence": {
- "id": null,
- "name": "Ouvidoria"
}, - "subject": {
- "id": null,
- "name": "Administrativo"
}, - "classification": {
- "id": null,
- "name": "Elogio"
}, - "return_mode": {
- "id": null,
- "name": "Email"
}, - "channel": {
- "id": null,
- "name": "Ouvidoria"
}, - "analyst": {
- "id": null,
- "name": null
}, - "protester_type": {
- "id": null,
- "name": "Pessoa Jurídica"
}, - "protester": {
- "natural_person": {
- "cpf": "123.456.789-09",
- "name": "string",
- "birth_date": "2000-12-01"
}, - "legal_person": {
- "cnpj": "AB12.345.678/0001-90",
- "corporate_name": "Empresa de Fachada Ltda."
}, - "address": {
- "zip_code": "88001-002",
- "address": "Rua da Esperança",
- "number": "98D",
- "complement": "Sobrado",
- "district": "Confiança",
- "city": "Vitória da Conquista",
- "state": "BA"
}, - "ans": {
- "holder": "Jose Titular da Silva"
}, - "email": "cliente@email.com.br",
- "alternative_email": "alternative@email.com",
- "cell_phone": "48 999110022",
- "tellphone": "48 40040000",
- "alternative_phone": "48 40040000"
}, - "source": {
- "id": null,
- "name": "Loja"
}, - "integration_code": "string",
- "attachments": [
- {
- "name": "attach.txt",
- "type": "text/plain",
- "base64": "data:text/plain;base64,VGVzdGUgRG93bmxvYWQgb21kLWZpbGU="
}
]
}Relatório geral de manifestações
Relatório geral de manifestações para análise de dados
Authorizations:
Request Body schema: application/jsonrequired
| initial_date required | string <date-time> ISO 8601 (AAAA-MM-DDT23:59:11.505-03:00) Data inicial de recebimento da manifestação |
| final_date required | string <date-time> ISO 8601 (AAAA-MM-DDT23:59:11.505-03:00) Data final de recebimento da manifestação |
Responses
Request samples
- Payload
{- "initial_date": "2025-05-01T00:00:00.505-03:00",
- "final_date": "2025-05-01T23:59:59.505-03:00"
}