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
instanceId
string
required
to
string[]
required

chat_id ou @username

Required array length: 1 - 100 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.)

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.

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).

success
boolean
data
object