Versões comparadas

Chave

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

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

Token de autenticação 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”

Nota

Caso não envie um idRegistro informe como null

Para que o push seja aberto na Web que tenha ação para uma funcionalidade, não enviar o atributo idRegistro

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

Bloco de código
languagebash
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
}'

...

Está indicado abaixo a estrutura de retorno do método de envio de push.

Bloco de código
languagejson
{
    "status": true,
    "data": {},
    "message": "Envio realizado com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1672064771591
}