Api clientes - Criação / atualização de contatos

Regras de negócio

Cria uma novo contato ou atualizar com os dados passados no body.

Endpoint

Endpoint	Método	Header Content-Type	Ambiente	Descrição
https://api.mosiaomnichannel.com.br/privado/omni/contatos/v1/gan/contato	POST	application/json	Sandbox e produção	Cria ou atualizar um contato

Headers

Parâmetro	Obrigatório	Tipo	Descrição
instancia_aplicacao	M	Int	Informe o codigo para o ambiente. 1 - Sandbox e 2 - Produção

Parametros de entrada

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição
idOperadora	M	Int	ID da operadora afim de identificar o contato. Tal informação pode ser obtida com a Mobile Saúde.
bundle	M	Objeto	Necessário saber o bundle da operadora para identificar o contato. Tal informação pode ser obtida com a Mobile Saúde.
contato	M	Objeto	Informações do contato

Objeto Contato [M]

Parâmetro	Obrigatório	Tipo	Descrição
nome	M	String	Nome do beneficiário, prestador ou outros.
email	OP	String	Email
telefone	OP	String	Telefone
chaveUnica	M	String	Chave Única

{
    "nome": "João da Silva",
    "email": "joao.silva@mobilesaude.com.br",
    "telefone": "27997981966"
    "chaveUnica": "92823599053",
}

Request body

{
    "idOperadora":489,
    "bundle":"br.com.mobilesaude.operadorars",
    "contato": {
        "nome": "João da Silva",
        "email": "joao.silva@mobilesaude.com.br",
        "telefone": "27997981966",
        "chaveUnica": "92823599053"
    }
}

Objetos e atributos de retorno

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método de criação ou atualização de contato.

{
  "status": true,
  "data": {
       "idOmniContato": "xyz ",
       "idOperadora": 489,
       "idConfigClienteApp": 372,
       "chaveUnica": "92823599053",
       "nome": "João da Silva",
       "email": "joao.silva@mobilesaude.com.br",
       "telefone": "27997981966",
       "instancia_aplicacao": 1,
       "bundle": "br.com.mobilesaude.operadorars",
       "perfilContato": {}
  },
  "message": "Contato salvo com sucesso.",
  "critical": [],
  "statusCode": 200,
  "timestamp": 1726671480104
}

Exemplo prático de uso

Estamos utilizando a api para atualização de contato no fluxo de identificação na funcionalidade de chatbot.