Api Clientes - Envio de mensagem

Regras de negócio

Envio de push informando o contato no body e o authorization no header.

End-Point

Endpoint

Método

Header Content-Type

Descrição

Endpoint

Método

Header Content-Type

Descrição

https://api.mosiaomnichannel.com.br/clientes/mensageria/envio

POST

application/json

Envio de push

Headers

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

Authorization

M

token do cliente

Token de autenticação do cliente.

Clique aqui para ler a documentação sobre como obter o token de autenticação

Parâmetros de Body

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

chaveUnica

M

String

Chave para localização do contato

msg

M

String

Mensagem que será enviada

Limite de 178 caracteres.

idFuncionalidade

O

String

ID da funcionalidade para redirecionamento do push dentro do app, veja abaixo a lista com os IDs das funcionalidades.

Caso não envie um idFuncionalidade informe como null

idRegistro

O

String

 

ID do registro da funcionalidade.

Serve para vincular o registro da funcionalidade indicado anteriormente no idFuncionalidade, algumas funcionalidades podem ser vinculadas com um idRegistro

Ex:

Noticia idFuncionalidade = “0”

Noticia sobre obesidade idRegistro = “203”

 

Caso não envie um idRegistro informe como null

msgRegistrarPush

O

Boolean

Controla o comportamento da menagem na funcionalidade Inbox do App. Quando falso, o push é enviado mas não é exibido dentro do App na inbox

Valor padrão = true

 

Exemplo request

curl --request POST \ --url https://api.mosiaomnichannel.com.br/clientes/mensageria/envio \ --header 'Content-Type: application/json' \ --header 'authorization: informeAuthorization' \ --data '{ "chaveUnica": "informeChaveUnica", "msg": "Mensagem de teste", "idFuncionalidade": null, "idRegistro": null }'

 

Envios para API de mensageria nas quais o beneficiário não se encontre com o app instalado e logado no app, a API retornará:

Status 404 - sessão não encontrada

{ "status": false, "data": {}, "message": "Sessão não encontrada.", "critical": [], "statusCode": 404, "timestamp": 1692712003443 }

Agendamento de Mensagens

IMPORTANTE

Para envios agendados basta criar um tarefa agendada que a sua rotina consuma a API de Mensageria da Mobile Saúde no dia da campanha.

 

IDs Funcionalidades

IMPORTANTE

Os ID das funcionalidades customizadas são gerados dinamicamente e devem ser vistos no painel público e inclusos na relação de Acesso Funcionalidade da Operadora conforme forem criadas novas funcionalidades customizadas.

 

Clique abaixo para ver a relação das funcionalidades existentes na estrutura da Mobile Saúde.

Noticias: '0', InBox: '1', Agendamento: '2', CartaoVirtual: '3', RedeCredenciada: '4', Medicamento: '5', Alarme: '7', Login: '9', Contatos: '8', ExtratoDeReembolso: '10', Coparticipacao: '11', Boleto: '14', ImpostoRenda: '20', AtualizacaoCadastral: '16', Ouvidoria: '17', Declaracao: '20', ChatMosia: '46', SolicitacaoAutorizacao: '48', MeusProtocolos: '49', SolicitacaoCartao: '50', CancelamentoPlano: '51', MinhasConsultas: '53', ManuaisRevistas: '18', PINSS: '52', ExtratoUtilizacao: '55', PrimeiroAcesso: '134', BoasVindas: '136', RecuperarSenha: '137', TrocarSenha: '138', CentralDeAjuda: '139', Elegibilidade: '141', MeuPerfil: '47888', LiveNow: '47999', Servicos: '47777', FuncionalidadeEspecifica: '9000'

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 envio de push.

Mobile Saúde - Mosia Omnichannel