Skip to main content
POST
/
v1
/
telegram
/
instances
Criar instância (Telegram)
curl --request POST \
  --url https://api.notifique.dev/v1/telegram/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "mode": "BOT",
  "botToken": "<string>",
  "acceptUserTerms": true,
  "termsVersion": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "clxx_inst_bot",
    "name": "Atendimento",
    "status": "ACTIVE",
    "mode": "BOT",
    "botUsername": "@meubot",
    "webhookUrl": "https://api.notifique.dev/webhooks/telegram/clxx_inst_bot"
  }
}

Authorizations

​
Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Body

application/json
​
name
string
required
Minimum string length: 2
​
mode
enum<string>
required
Available options:
BOT,
USER
​
botToken
string

Obrigatório se mode=BOT

​
acceptUserTerms
boolean

Obrigatório true quando mode é USER (confirma que você entende os riscos de automação e as regras de uso).

​
termsVersion
string

Opcional. Rótulo da versão dos termos aceitos no modo USER (ex.: 2026-04 ou v2), usado só para registro e auditoria. Se omitido, o servidor grava um valor padrão (v1). Não altera o funcionamento da API.

Maximum string length: 32

Response

Instância criada. No BOT, data inclui webhookUrl. No USER, data.status costuma ser PENDING e vêm message / code orientando o próximo passo.

​
success
boolean
​
data
object