Skip to main content
POST
/
integracao
/
v1
/
notificacao
/
inAppMessaging
Enviar notificação in-app
curl --request POST \
  --url https://api-vendas.taximachine.com.br/integracao/v1/notificacao/inAppMessaging \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "passageiros": [
    123
  ],
  "titulo": "Titulo",
  "body": "Mensagem aqui",
  "url_imagem": null,
  "solicitacao_id": null,
  "titulo_botao_redirecionamento": null,
  "link_redirecionamento": null
}
'
{
  "success": true,
  "message": "inAppMessaging enviado com sucesso"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
passageiros
integer[]
required

Obrigatório. Lista de usuários que irão receber as notificações.

titulo
string
required

Opcional. Título da notificação. Limite de 40 caracteres.

Maximum string length: 40
body
string
required

Obrigatório. Mensagem da notificação. Limite de 255 caracteres.

Maximum string length: 255
url_imagem
string | null

Opcional. URL de uma imagem a ser exibida.

solicitacao_id
integer | null

Opcional. ID da solicitação. Se informado, a notificação só será exibida caso a solicitação esteja em andamento.

titulo_botao_redirecionamento
string | null

Obrigatório. Título do botão de redirecionamento. Limite de 20 caracteres.

Maximum string length: 20

Opcional. URL de redirecionamento do botão.

Response

200 - application/json

Sucesso

The response is of type object.