Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Regras de negócio

...

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

...

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

...

Bloco de código
languagejson
{
    "nome": "João da Silva",
    "email": "joao.silva@mobilesaude.com.br",
    "telefone": "27997981966"
    "chaveUnica": "92823599053",
}

Request body

Bloco de código
languagejson
{
    "idOperadora": "Everson",489,
    "bundle":"br.com.mobilesaude.operadorars",
    "contato": {
        "nome": "João da Silva",
        "email": "everson@mobilesaudejoao.silva@mobilesaude.com.br",
        "telefone": "27997981966",
        "chaveUnica": "everson@mobilesaude.com.br",
}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.

Bloco de código
languagejson
{
  "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.