Enviar notificação via Whatsapp

POST 
/v1/notifications/whatsapp

Envia uma mensagem de texto (Whatsapp) para o número de telefone informado

Request

application/json

Body

whatsappobjectrequired
Corpo da solicitação contendo informações para o envio de mensagens pelo WhatsApp. Este campo deve ser preenchido de acordo com o provedor de serviço utilizado. As propriedades do objeto podem variar dependendo do provedor e do tipo de mensagem que você deseja enviar.
anyOf
Default
Um objeto JSON que permite qualquer estrutura para o envio de mensagens pelo WhatsApp utilizando o provider da Base39.
property name* any
Um objeto JSON que permite qualquer estrutura para o envio de mensagens pelo WhatsApp utilizando o provider da Base39.
Example: {"messaging_product":"whatsapp","recipient_type":"individual","to":"+5511912345678","type":"text","text":{"preview_url":false,"body":"Olá, mundo!"}}
Twilio
to stringrequired
Número de telefone do destinatário. Pode ser informado com ou sem o código do país (DDI). Caso não informado, será considerado o DDI do Brasil (+55).
Possible values: Value must match regular expression ^(\+[1-9]{1,2})?\d{10,11}$
Example: +5511912345678
text stringrequired
Mensagem a ser enviada.
Example: Olá, mundo!

transport

object

Configurações de transporte. Caso não informado, irá obter das configurações de notificação.

token string

Token de autenticação.

Example: 111

account string

Idendificador da conta.

Example: 222

sender string

Número de telefone do remetente. Caso não informado, irá obter das configurações de notificação.

Example: +5511912345678

Responses

202

Retorna quando a mensagem foi aceita. Esta resposta não confirma se a notificação foi enviada.

application/json

Schema

Schema

message stringrequired

Mensagem de retorno

messageId stringrequired

Identificador da mensagem

Example (from schema)

{
  "message": "string",
  "messageId": "string"
}

400

Retorna quando ocorre um erro no envio da mensagem.

application/json

Schema

Schema

type string
error
Possible values: [error]
Example: error
status int32
O status HTTP da resposta
Example: 400
code string
Um código de erro específico da Base39
Possible values: [created, accepted, no_content, redirect, not_modified, bad_request, unauthorized, forbidden, not_found, method_not_allowed, conflict, precondition_failed, too_many_requests, internal_server_error, unavailable, item_name_invalid, insufficient_scope]
Example: item_name_invalid
message string
Uma breve descrição do erro
Example: Method Not Allowed

context

object

Um objeto de formato livre que contém contexto adicional sobre o erro. Os campos possíveis são definidos por endpoint. message é apenas um exemplo.

message string

More details on the error.

Example: Something went wrong.
help string
Um URL com links para mais informações sobre o motivo da ocorrência desse erro.
Example: https://docs.paketa.com.br/development/first-steps/errors
request string
Um identificador exclusivo para esta resposta, que pode ser usado ao entrar em contato com o suporte da Base39.
Example: abcdef123456

Example (from schema)

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context": {
    "message": "Something went wrong."
  },
  "help": "https://docs.paketa.com.br/development/first-steps/errors",
  "request": "abcdef123456"
}

Loading...