OMD Soluções
API docs by Redocly

OMD - Sistema de Ouvidoria (2.3.0)

Download OpenAPI specification:

Atendimento: suporte@omd.com.br URL: https://omd.com.br License: Licença Proprietária SaaS

OMD Api

Introdução

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.

Especificação OpenAPI

Esta API é documentada no formato OpenAPI

Autenticação

O token para utilização da API deve ser solicitado junto ao Time de Atendimento da OMD.

Manifestação

Crie e acompanhe suas manifestações

Inserir uma nova manifestação

Inserir uma nova manifestação.

Authorizations:
bearerAuth
Request Body schema: application/json
required
description
required
string

Texto descritivo da manifestação

occurrence_date_hour
string or null <date-time>

Data e hora da ocorrência, em ISO 8601 com fuso (AAAA-MM-DDTHH:mm:ss.SSS-03:00). 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

has_recording
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 (ContractType)
Default: null

Tipo de contrato do plano de saúde (perfil ANS)

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, do cadastro do cliente. Se não for informado na criação, o sistema usa Pessoa Jurídica quando legal_person traz CNPJ ou razão social, e Pessoa Física nos demais casos. O nome do manifestante vem de legal_person.corporate_name quando o tipo é deduzido como Pessoa Jurídica ou quando name é informado como Pessoa Jurídica; informado só pelo id, o nome vem de natural_person.name.

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

Content type
application/json
{
  • "description": "Elogiando a nova API",
  • "occurrence_date_hour": "2025-05-20T23:59:11.505-03:00",
  • "input_mode": {
    },
  • "identification": {
    },
  • "has_recording": false,
  • "involved": null,
  • "priority": {
    },
  • "final_date": null,
  • "previous_manifestation": "233000416054",
  • "ans": null,
  • "city": {
    },
  • "unit_occurrence": {
    },
  • "subject": {
    },
  • "classification": {
    },
  • "contract_type": {
    },
  • "return_mode": {
    },
  • "channel": {
    },
  • "analyst": {
    },
  • "protester_type": {
    },
  • "protester": {
    },
  • "source": {
    },
  • "integration_code": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "password": "string",
  • "ans_protocol": "string"
}

Buscar manifestações por CPF ou CNPJ

Lista as manifestações do manifestante pelo CPF ou pelo CNPJ, da mais recente para a mais antiga. Informe ao menos um dos documentos; a pontuação é opcional. Manifestações excluídas não são retornadas.

Authorizations:
bearerAuth
query Parameters
cpf
string
Example: cpf=123.456.789-09

CPF do manifestante, com ou sem pontuação (11 dígitos)

cnpj
string
Example: cnpj=12.ABC.345/01DE-35

CNPJ do manifestante, com ou sem pontuação (14 caracteres, numérico ou alfanumérico)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Buscar os dados de uma manifestação (integração de sistema)

Busca os dados de uma manifestação pelo código, sem a senha do manifestante. Use esta consulta na integração entre sistemas, chamada a partir do seu servidor.

Fluxo típico: obter os códigos das manifestações pelo relatório geral (POST /reports/general) e consultar os detalhes de cada uma por este endpoint.

A resposta tem a mesma estrutura da consulta em nome do manifestante (GET /manifestations/code/{code}), mas status traz a situação real, como em GET /manifestations/code/{code}/status; na consulta com senha, Nova, Aguardando resposta e Respondida aparecem como Em tratativa. Para consultar a partir do navegador, em nome do manifestante, use aquele endpoint com a senha.

Authorizations:
bearerAuth
path Parameters
code
required
integer <int64> >= 0

Código da manifestação, somente dígitos

Responses

Response samples

Content type
application/json
{
  • "description": "Elogiando a nova API",
  • "occurrence_date_hour": "2025-05-20T23:59:11.505-03:00",
  • "input_mode": {
    },
  • "identification": {
    },
  • "has_recording": false,
  • "involved": null,
  • "status": "Aguardando resposta",
  • "priority": {
    },
  • "final_date": null,
  • "previous_manifestation": "233000416054",
  • "ans": null,
  • "city": {
    },
  • "unit_occurrence": {
    },
  • "subject": {
    },
  • "classification": {
    },
  • "contract_type": {
    },
  • "return_mode": {
    },
  • "channel": {
    },
  • "analyst": {
    },
  • "protester_type": {
    },
  • "protester": {
    },
  • "source": {
    },
  • "integration_code": "string",
  • "attachments": [
    ]
}

Buscar os dados de uma manifestação (em nome do manifestante)

Busca os dados de uma manifestação pelo código e pela senha do manifestante, informada no header password. Indicada para frontends que consultam em nome do manifestante.

Para integração entre sistemas, sem a senha, use GET /manifestations/{code}.

Authorizations:
bearerAuth
path Parameters
code
required
integer <int64>

Código da manifestação

header Parameters
password
string

Senha da manifestação

Responses

Response samples

Content type
application/json
{
  • "description": "Elogiando a nova API",
  • "occurrence_date_hour": "2025-05-20T23:59:11.505-03:00",
  • "input_mode": {
    },
  • "identification": {
    },
  • "has_recording": false,
  • "involved": null,
  • "status": "Aguardando resposta",
  • "priority": {
    },
  • "final_date": null,
  • "previous_manifestation": "233000416054",
  • "ans": null,
  • "city": {
    },
  • "unit_occurrence": {
    },
  • "subject": {
    },
  • "classification": {
    },
  • "contract_type": {
    },
  • "return_mode": {
    },
  • "channel": {
    },
  • "analyst": {
    },
  • "protester_type": {
    },
  • "protester": {
    },
  • "source": {
    },
  • "integration_code": "string",
  • "attachments": [
    ]
}

Verificar o status de uma manifestação

Verificar o status de uma manifestação utilizando o código

Authorizations:
bearerAuth
path Parameters
code
required
integer <int64>

Código da manifestação

Responses

Response samples

Content type
application/json
{
  • "status": "Aguardando manifestante",
  • "final_date": "2019-08-24T14:15:22Z"
}

Analíticos

Obtenha os dados das manifestações para análise

Relatório geral de manifestações

Relatório geral de manifestações para análise de dados

Authorizations:
bearerAuth
Request Body schema: application/json
required
initial_date
required
string <date-time>

Data inicial de recebimento da manifestação, em ISO 8601 com fuso (AAAA-MM-DDTHH:mm:ss.SSS-03:00)

final_date
required
string <date-time>

Data final de recebimento da manifestação, em ISO 8601 com fuso (AAAA-MM-DDTHH:mm:ss.SSS-03:00)

Responses

Request samples

Content type
application/json
{
  • "initial_date": "2025-05-01T00:00:00.505-03:00",
  • "final_date": "2025-05-01T23:59:59.505-03:00"
}

Response samples

Content type
application/json
[
  • {
    }
]