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 |
|---|---|---|---|
https://api.mosiaomnichannel.com.br/clientes/mensageria/envio | POST | application/json | Envio de push |
Headers
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
Authorization | M | token do cliente |
Utilize a opção de API MENSAGERIA 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 |
|---|---|---|---|
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”
| ||
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 = |
Exemplo request
| Bloco de código | ||
|---|---|---|
| ||
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
}' |
| Nota |
|---|
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 |
| Bloco de código | ||
|---|---|---|
| ||
{
"status": false,
"data": {},
"message": "Sessão não encontrada.",
"critical": [],
"statusCode": 404,
"timestamp": 1692712003443
} |
Agendamento de Mensagens
| Informações |
|---|
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
| Nota |
|---|
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.
| Expandir | |||||
|---|---|---|---|---|---|
| |||||
|
Objetos e atributos de retorno
...
Está indicado abaixo a estrutura de retorno do método de envio de push.
|