Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Headers

​
Idempotency-Key
string
​
x-idempotency-key
string

Body

application/json
​
to
string[]
required

chat_id ou @username

Required array length: 1 - 500 elements
​
type
enum<string>
required
Available options:
text,
image,
video,
audio,
document,
location,
template
​
payload
object
required

Conforme type (message, mediaUrl, latitude/longitude, templateId/variables, etc.)

​
from
string
required

Instância Telegram: id ou nome.

​
schedule
object
​
options
object
​
metadata
object

Metadados em TelegramOutboundMessage.metadata (string→string). priority em options usa fila dedicada Telegram + fila prioritária de webhooks quando high.

​
localization
object

Tradução por destinatário (manual ou IA). Campos traduzíveis: payload.message, payload.caption.

​
i18n
object

Mapa locale → string ou objeto com chaves por campo (message, caption, …). Usado com localization.mode=manual.

​
variables
object

Variáveis para substituir placeholders {{chave}} em payload.message, payload.caption e options.autoReplyText.

Response

Mesmo corpo de success de um envio anterior: você reutilizou Idempotency-Key ou x-idempotency-key e o servidor devolve o resultado já registrado (não duplica envio).

​
from
string
required

Instância Telegram: id ou nome.

​
success
boolean
​
data
object
Example: