Base de conhecimento

API URA Unimed

15 de agosto de 2024
Funcionalidades
5 Views

O que é

A Unimed tem um processo complexo em que é gerado um Protocolo ANS que é informado ao cliente pela própria URA, durante o atendimento por telefone.

Como funciona

A URA encaminha dados do paciente para a API e o CRM se responsabiliza por se comunicar com a Unimed Brasil e gerar o protocolo de atendimento.
No momento em que o protocolo é gerado, é aberto um chamado no CRM que depois será utilizado pelo agente para tabular o atendimento.
O protocolo é devolvido pela API para a telefonia, que o informa ao ao paciente. Uma vez definida a fila para qual será encaminhada a ligação, a telefonia chama uma URL do CRM passando dados importantes como o número chamado e o número do protocolo, que será usado pelo CRM para trazer para a tela o chamado aberto pela API.

Versões da API

Existem duas versões da API URA Protocolo Unimed:

Versão API 1.0 (SOAP)

EndPoint: 

https:// {CAMINHO_CRM} /webservices/?wsdl

Parâmetros:

  • USUARIO_WS *: Usuário padrão de integração. Verifique com a Unimed ou com a consultoria.
  • SENHA_WS *: Senha padrão de integração. Verifique com a Unimed ou com a consultoria.
  • CARTEIRINHA: Identificador principal do cliente. Número da carteirinha do cliente no formato “9999999999999999”
  • CNPJ_CPF: Identificador principal do cliente. Número da carteirinha do cliente no formato “99999999999” ou “99999999999999”
  • DDD_RES *: DDD do telefone do paciente no formato “99”
  • TEL_RES *: Número de telefone do paciente no formato “99999999”
  • DDD_CEL: DDD do telefone celular do paciente no formato “99”
  • DDD_CEL: DDD do telefone celular do paciente no formato “999999999”
  • DESCRICAO: Texto que será utilizado na abertura do chamado no CRM
  • NOME: Nome do Cliente caso seja uma inclusão.
  • EMAIL: E-mail do cliente caso seja uma inclusão
  • SOLICITACAO: Código de uma solicitação para a abertura do chamado no CRM. Se não informado, o padrão é ‘telefone‘. (sobre solicitações)
  • NEW_CLI: Uma string simples definindo se será incluído novo cliente caso não seja encontrado pela busca. Valores possíveis: ‘T‘ para inlcuir. Caso não deseje incluir, não encaminhe o valor.

Os parâmetros com * são obrigatórios. É importante frisar que é necessária pelo menos uma forma de identificação do cliente, seja pela CARTEIRINHA ou pelo CNPJ_CPF.

Para fazer com que seja aberto chamado em uma Solicitação diferente da padrão, basta informar o código pela API.

Retorno da API

Sucesso: Cliente Encontrado e Protocolo Gerado

Número do Protocolo Unimed no formato string.

Não informar usuário ou senha

Falha: Usuário ou senha inválidos

Não informar a Carteirinha ou CPF/CNPJ

Falha: Informe o número da carteirinha ou CPF do cliente.

Cliente encontrado mas Protocolo não gerado

Falha: Houve um problema de comunicação. O Protocolo não foi gerado. Tente novamente mais tarde.

Carteirinha inválida com menos de 16 dígitos

Falha: Numero de carteirinha inválido

Carteirinha informada com caracteres não numéricos

Falha: Carteirinha informada é inválida. Informar apenas números

CPF ou CNPJ inválidos

Falha: CPF / CNPJ informado é inválido

Cliente não encontrado (informando o CPF e não gerar novo cliente)

Falha: Nenhum cliente encontrado com este CPF.

Código da Solicitação inválido

Falha: Divisão / Solicitação não encontrados.

Novo cliente não gerado

Falha: Falha ao gerar um novo cliente….

Abertura do chamado no CRM

O chamado é aberto no CRM e a ele é atrelado ao PROTOCOLO gerado.
Caso o cliente seja gerado pela API, os dados do cliente que forem informados serão utilizados.
Se o paciente já existe no CRM e forem informados dados como o e-mail, não será alterado o dado pré existente no CRM.

Abertura da tela de atendimento no CRM

É necessário encaminhar algumas variáveis por _GET junto à URL do CRM. Além disso, o Agente precisa estar logado no CRM para ter acesso à tela de atendimento.

A URL seguirá o seguinte padrão:

http://{CAMINHO_CRM}?display=portal&m=servicedesk/ocorrencias&a=oco_edit&nomenu=&status_ramal=RECEPTIVO&ddr=UNIMED&UUID={UUID_DA_CHAMADA_TELEFONICA}&protocolo={PROTOCOLO_UNIMED}

Parâmetros _GET

Fixos:
display=portal&m=servicedesk/ocorrencias&a=oco_edit&nomenu=&status_ramal=RECEPTIVO&ddr=UNIMED

Estas informações servem para o CRM localizar a página de edição e para informar que é uma chamada receptiva vinda da URA Unimed

UUID

ID único da chamada telefônica. Pode ser utilizada posteriormete para localizar gravações e será arquivada no CRM.

&UUID={variável}
PROTOCOLO

Protocolo de atendimento Unimed encaminhado pela API da URA. Ele é utilizado para trazer para o agente o chamado que foi aberto pela API.

protocolo={variável}