Documentação da API do Fala.Br

Introdução

A API do Fala.Br disponibiliza serviços para que aplicações de terceiros possam cadastrar, consultar e tratar manifestações.

Para mais informações, inclusive sobre obtenção de acesso à API Fala.BR, acesse o manual do sistema.

Em caso de dúvidas, reclamações ou sugestões sobre esta API, favor entrar em contato com o suporte do sistema Fala.BR pelo e-mail suporte.e-ouv@cgu.gov.br

Notas importantes sobre autenticação no OAuth

Para obter o token de autenticação no padrão OAuth 2.0, faça requisição com o método POST à URL https://falabr.cgu.gov.br/oauth/token tendo em seu corpo (body) os seguintes dados:
- client_id: <id da aplicação>
- client_secret: <senha da aplicação>
- grant_type: password
- username: <login do usuário sistema>
- password: <senha do usuário sistema>
O token dura 1 ano e não é preciso gerá-lo a cada requisição.
Antes de requisitar um token, ative o usuário (username).
A ativação ocorre ao acessar o link enviado para o e-mail do usuário no momento do seu cadastro.

DadosDominio

Controller para endpoints de dados de domínio

API	Description
GET api/tipos-formulario	Consulta e listagem dos tipos de formulário
GET api/segmentos-servico	Consulta e listagem dos itens de segmento dos serviços de acordo com o Portal de Serviços
GET api/segmentos	Consulta e listagem dos segmentos das entidades públicas
GET api/tipos-manifestacao?indPodeRegistrarFormularioPadrao={indPodeRegistrarFormularioPadrao}&indPodeRegistrarFormularioSimplifique={indPodeRegistrarFormularioSimplifique}&indPodeRegistrarFormularioLAI={indPodeRegistrarFormularioLAI}&indPodeRegistrarFormularioDenuncia={indPodeRegistrarFormularioDenuncia}	Consulta e listagem dos tipos de manifestação
GET api/orgaos-siorg	Consulta e listagem dos órgãos (SIORG)
GET api/assuntos?indApenasAtivos={indApenasAtivos}&idOuvidoria={idOuvidoria}	Consulta e listagem de assuntos
GET api/assuntos/{idAssunto}
GET api/tags?idOrgao={idOrgao}	Retorna as tags de um dado órgão.
GET api/canais-entrada	Consulta e listagem de canais de entrada. A manifestação que é registrada pelo usuário pela aplicação Web fica sem canal de entrada, isto é, valor nulo.
GET api/classes-conhecimento-recurso	Consulta e listagem de classes de conhecimento de recursos, indicados pelo FalaBRIA.
GET api/funcoes-envolvido	Consulta e listagem de funções dos envolvidos
GET api/campos-adicionais?idOuvidoria={idOuvidoria}&idTipoManifestacao={idTipoManifestacao}	Consulta a lista de campos adicionais por Ouvidoria e Tipo de Manifestação é possível consultar os campos adicionais somente por ouuvidoria, passando o valor -1 no idTipoManifestacao
GET api/tipos-identificacao-manifestante	Consulta e listagem de tipos de identificação de manifestantes
GET api/tipos-documento-identificacao?somenteAtivos={somenteAtivos}	Consulta e listagem de tipos de documentos de identificação
GET api/faixas-etarias
GET api/cores-racas
GET api/situacoes-manifestacao
GET api/tipos-resposta
GET api/codigos-decisao
GET api/codigos-especificacao-decisao?idDecisao={idDecisao}	Consulta e listagem de especificações de decisão
GET api/motivos-prorrogacao?idTipoFormulario={idTipoFormulario}
GET api/motivos-arquivamento
GET api/motivos-reabertura
GET api/esferas
GET api/subassuntos?idOrgao={idOrgao}	Retorna os subassuntos de um dado órgão.
GET api/modos-resposta	Consulta e listagem dos modos de resposta da manifestação.
GET api/profissoes	Consulta e listagem das profissões.
GET api/escolaridades	Consulta e listagem das escolaridades.
GET api/paises	Consulta e listagem dos países.
GET api/areas-atuacao	Consulta e listagem das áreas de atuação.
GET api/tipos-instituicao	Consulta e listagem dos tipos de instituição.
GET api/tipos-pessoa	Consulta e listagem dos tipos de pessoa.
GET api/motivo-demanda-resolvida?idTipoManifestacao={idTipoManifestacao}	Consulta os motivos de demanda resolvida por tipo de manifestação
GET api/generos	Consulta e listagem dos gêneros.
GET api/ufs	Consulta e listagem de Ufs
GET api/municipios?sigUf={sigUf}	Consulta e listagem de Municípios
GET api/temas	Consulta e listagem de Temas

Email

API	Description
POST api/Email?data={data}
POST api/Email?SelectedValue={SelectedValue}

Manifestacao

Controller para endpoints da Manifestação.

API	Description
GET api/manifestacoes?NumProtocolo={NumProtocolo}&DataCadastroInicio={DataCadastroInicio}&DataCadastroFim={DataCadastroFim}&DataPrazoRespostaInicio={DataPrazoRespostaInicio}&DataPrazoRespostaFim={DataPrazoRespostaFim}&DataAtualizacaoInicio={DataAtualizacaoInicio}&DataAtualizacaoFim={DataAtualizacaoFim}&IdSituacaoManifestacao={IdSituacaoManifestacao}&ApenasDenunciasAptas={ApenasDenunciasAptas}&ApenasComApuracaoDeEmpresa={ApenasComApuracaoDeEmpresa}&ApenasComApuracaoDeServidor={ApenasComApuracaoDeServidor}&IdTipoFormulario={IdTipoFormulario}&MaxResultados={MaxResultados}&PosInicioPagina={PosInicioPagina}&OrderBy={OrderBy}	Consulta e listagem de manifestações às quais o consultante possui permissão de acesso. <strong>ATENÇÃO:</strong> Caso na requisição sejam solicitados mais do que 1000 registros, será obrigatório informar parâmetros de data de cadastro que limitem a consulta a, no máximo, 5 dias.
GET api/manifestacoes/{id}	Retorna os detalhes de uma manifestação existente.
GET api/manifestacoes/{idManifestacao}/anexos/{idAnexo}?codigoAcesso={codigoAcesso}	Detalha um anexo específico de uma manifestação, inclusive seu conteúdo.
POST api/manifestacoes/{id}/respostas	Inclui e publica uma nova resposta da ouvidoria numa manifestação. As respostas podem ser conclusivas, intermediárias ou pedidos de complementação ao manifestante.
POST api/manifestacoes/respostas/{id}/atualizar	Atualiza os campos Demanda Resolvida e o texto de observação da resolução da demanda.
POST api/manifestacoes/{id}/prorrogacoes	Inclui nova prorrogação de prazo numa manifestação.
POST api/manifestacoes/{id}/encaminhamentos	Inclui novo encaminhamento a outra ouvidoria numa manifestação.
POST api/manifestacoes/{id}/arquivar	Arquiva uma manifestação cadastrada. Não é possível arquivar manifestações do formulário de acesso à informação.
POST api/manifestacoes/{id}/reabrir	Reabre uma manifestação concluída ou arquivada. Não é possível reabrir manifestações do formulário de acesso à informação.
POST api/manifestacoes/{id}/classificar	Classifica com um novo tipo uma manifestação.
POST api/manifestacoes/{id}/complementacoes	Inclui nova complementação numa manifestação. Complementações são informações adicionais fornecidas pelo manifestante.
POST api/manifestacoes	Cadastra uma manifestação.
POST api/manifestacoes/{id}/atualizar	Atualiza uma manifestação.
POST api/manifestacoes/{idManifestacao}/respostas/{idResposta}/denunciar	Permit denunciar o descumprimento de um compromisso de uma manifestação

ManifestacaoFaro

API	Description
GET api/manifestacoesFaro/{idManifestacao}	Obtem os dados de Aptidão de uma manifestação a partir do seu ID
POST api/manifestacoesFaro/{idManifestacao}/Score?score={score}&flagAcaoAutomatica={flagAcaoAutomatica}	Permite atualizar o valor do score Faro da manifestação

Ouvidoria

Controller para endpoints da Ouvidoria

API	Description
GET api/ouvidorias?somenteOuvidoriasAtivas={somenteOuvidoriasAtivas}&somenteOuvidoriasAderiramEOuvPadrao={somenteOuvidoriasAderiramEOuvPadrao}&enviamCGUPAD={enviamCGUPAD}&enviamDenunciasCGUPJ={enviamDenunciasCGUPJ}&idEsfera={idEsfera}&sigUf={sigUf}&idMunicipio={idMunicipio}&municipio={municipio}&somenteOuvidoriasAderiramSimplifique={somenteOuvidoriasAderiramSimplifique}&idTipoFormulario={idTipoFormulario}&idOrgaoSiorg={idOrgaoSiorg}&ouvidoriasComRegistroManifestacaoAtivo={ouvidoriasComRegistroManifestacaoAtivo}&incluirTagsComoOuvidorias={incluirTagsComoOuvidorias}	Consulta e listagem das ouvidorias cadastradas.
GET api/ouvidorias/{idOuvidoria}	Consulta e listagem das ouvidorias cadastradas.

API

Description

GET api/ouvidorias?somenteOuvidoriasAtivas={somenteOuvidoriasAtivas}&somenteOuvidoriasAderiramEOuvPadrao={somenteOuvidoriasAderiramEOuvPadrao}&enviamCGUPAD={enviamCGUPAD}&enviamDenunciasCGUPJ={enviamDenunciasCGUPJ}&idEsfera={idEsfera}&sigUf={sigUf}&idMunicipio={idMunicipio}&municipio={municipio}&somenteOuvidoriasAderiramSimplifique={somenteOuvidoriasAderiramSimplifique}&idTipoFormulario={idTipoFormulario}&idOrgaoSiorg={idOrgaoSiorg}&ouvidoriasComRegistroManifestacaoAtivo={ouvidoriasComRegistroManifestacaoAtivo}&incluirTagsComoOuvidorias={incluirTagsComoOuvidorias}

Consulta e listagem das ouvidorias cadastradas.

GET api/ouvidorias/{idOuvidoria}

Consulta e listagem das ouvidorias cadastradas.

PesquisaSatisfacao

Controller para endpoints das Respostas às Pesquisas de Satisfação das manifestações. Versão 1.0: até 11/06/2020.Versão 1.1: após 11/06/2020.

API	Description
GET api/respostaspesquisasatisfacao/v1_1?IdEsfera={IdEsfera}&IdOrgao={IdOrgao}&BuscaTextual={BuscaTextual}&IdsTipoFormulario={IdsTipoFormulario}&IdDecisao={IdDecisao}&DataCadastroInicio={DataCadastroInicio}&DataCadastroFim={DataCadastroFim}&IdVersaoQuestionario={IdVersaoQuestionario}&MaxResultados={MaxResultados}&PosInicioPagina={PosInicioPagina}&OrderBy={OrderBy}	Consulta e listagem de respostas às pesquisas de satisfação para as manifestações que o consultante possua permissão de acesso. (Versão 1.1: após 11/06/2020)
GET api/respostaspesquisasatisfacao?IdEsfera={IdEsfera}&IdOrgao={IdOrgao}&BuscaTextual={BuscaTextual}&IdsTipoFormulario={IdsTipoFormulario}&IdDecisao={IdDecisao}&DataCadastroInicio={DataCadastroInicio}&DataCadastroFim={DataCadastroFim}&IdVersaoQuestionario={IdVersaoQuestionario}&MaxResultados={MaxResultados}&PosInicioPagina={PosInicioPagina}&OrderBy={OrderBy}	Consulta e listagem de respostas às pesquisas de satisfação para as manifestações que o consultante possua permissão de acesso. (Versão 1.1: após 11/06/2020)
GET api/respostaspesquisasatisfacao/v1_0?IdEsfera={IdEsfera}&IdOrgao={IdOrgao}&BuscaTextual={BuscaTextual}&IdsTipoFormulario={IdsTipoFormulario}&IdDecisao={IdDecisao}&DataCadastroInicio={DataCadastroInicio}&DataCadastroFim={DataCadastroFim}&IdVersaoQuestionario={IdVersaoQuestionario}&MaxResultados={MaxResultados}&PosInicioPagina={PosInicioPagina}&OrderBy={OrderBy}	Consulta e listagem de respostas às pesquisas de satisfação para as manifestações que o consultante possua permissão de acesso. (Versão 1.0: até 11/06/2020)

Recurso

Controller para endpoints de Recursos

API	Description
GET api/recursos?NumProtocolo={NumProtocolo}&DataAberturaInicio={DataAberturaInicio}&DataAberturaFim={DataAberturaFim}&DataPrazoAtendimentoInicio={DataPrazoAtendimentoInicio}&DataPrazoAtendimentoFim={DataPrazoAtendimentoFim}&IdInstancia={IdInstancia}&OrigemTerceiraInstancia={OrigemTerceiraInstancia}&IdSituacaoRecurso={IdSituacaoRecurso}&MaxResultados={MaxResultados}&PosInicioPagina={PosInicioPagina}&OrderBy={OrderBy}	Consulta e listagem de recursos aos quais o consultante possui permissão de acesso.
GET api/recursos/{idRecurso}/anexos/{idAnexo}	Detalha um anexo específico de um recurso, inclusive seu conteúdo.

API

Description

GET api/recursos?NumProtocolo={NumProtocolo}&DataAberturaInicio={DataAberturaInicio}&DataAberturaFim={DataAberturaFim}&DataPrazoAtendimentoInicio={DataPrazoAtendimentoInicio}&DataPrazoAtendimentoFim={DataPrazoAtendimentoFim}&IdInstancia={IdInstancia}&OrigemTerceiraInstancia={OrigemTerceiraInstancia}&IdSituacaoRecurso={IdSituacaoRecurso}&MaxResultados={MaxResultados}&PosInicioPagina={PosInicioPagina}&OrderBy={OrderBy}

Consulta e listagem de recursos aos quais o consultante possui permissão de acesso.

GET api/recursos/{idRecurso}/anexos/{idAnexo}

Detalha um anexo específico de um recurso, inclusive seu conteúdo.

Reencaminhamento

Controller para endpoints de Reencaminhamentos

API	Description
GET api/reencaminhamentosmanifestacoes	Obtem os reencaminhamentos das manifestações com alguns filtros recebidos via GET
GET api/reencaminhamentosmanifestacoes/download	Consulta e listagem de manifestações às quais o usuário possui permissão de acesso e retorna o arquivo excel para download.

ServicoFederal

Controller para dados de serviços federais

API	Description
GET api/servicosfederais?Sigla={Sigla}&Nome={Nome}&Descricao={Descricao}&IdServicoOriginal={IdServicoOriginal}&IdOrgaoSiorg={IdOrgaoSiorg}&DataInativacao={DataInativacao}&SomenteServicoAtivo={SomenteServicoAtivo}&IdSegmentoServico={IdSegmentoServico}&SomenteServicoExclusivoDoSegmento={SomenteServicoExclusivoDoSegmento}&MaxResultados={MaxResultados}	Consulta serviços públicos federais.

ServicoNaoFederal

Controller para dados de serviços não federais

API	Description
GET api/servicosnaofederais?IdOuvidoria={IdOuvidoria}&Descricao={Descricao}&indServicoAtivo={indServicoAtivo}&MaxResultados={MaxResultados}	Consulta serviços públicos não federais.

Status

API	Description
GET api/monitoramento/status

Unidade

Controller para endpoints da Ouvidoria

API	Description
GET api/unidades?idOuvidoria={idOuvidoria}	Consulta e listagem das unidades vinculadas a ouvidoria.

Usuario

Controller para Dados de usuários do fala.br

API	Description
GET api/usuarios?cpf={cpf}	Retorna dados do Usuário a partir do CPF
POST api/usuarios	Cadastra um usuário cidadão.