Skip to main content
POST
Enviar mensagem

Authorizations

Authorization
string
header
required

Chave de API no cabeçalho Authorization: Bearer SUA-CHAVE.

A API também aceita x-api-key: SUA-CHAVE e Authorization: ApiKey SUA-CHAVE — as três formas são equivalentes, inclusive para o limite de requisições.

A chave dá acesso total à conta e é de servidor para servidor: não a use em navegador ou aplicativo móvel.

Body

application/json
channel_id
string
required

O id da conta de canal, vindo de GET /channels. É ele que define o canal.

contact_id
string

Identificador do contato na WizeBot. Use este ou to, nunca os dois.

to
string

Endereço nativo no canal — telefone no WhatsApp, identificador de chat no Telegram.

type
enum<string>
default:text
Available options:
text,
image,
document,
audio,
video
text
string

Texto da mensagem. Obrigatório quando type é text.

media_url
string

URL pública da mídia. Obrigatório nos tipos de mídia.

caption
string

Legenda da mídia, onde o canal a aceita.

filename
string
default:document

Nome do arquivo, para document.

client_message_id
string

Seu identificador do envio. Duas requisições com o mesmo valor viram um envio só.

Response

Mensagem aceita para envio.

success
boolean
required

Sempre true nas respostas de sucesso.

data
object
required
timestamp
string<date-time>
required