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": "Atendimento", "mode": "BOT", "botToken": "123456:ABC-DEF" } '

{ "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" } }

Autorizações

Authorization

string

header

obrigatório

Authorization: Bearer sk_live_xxxxx

Corpo

application/json

name

string

obrigatório

Nome para identificar esta conexão no painel.

Minimum string length: 2

mode

enum<string>

obrigatório

BOT: robô com token. USER: conta pessoal/profissional com login por QR.

Opções disponíveis:

BOT,

USER

botToken

string

Token do bot (obrigatório quando mode é BOT).

acceptUserTerms

boolean

Obrigatório true no modo USER — confirma que você entende as regras de automação.

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

generateShareableLink

boolean

padrão:false

Gera um link para outra pessoa concluir o login. Omita para receber o QR na resposta.

Resposta

Conta cadastrada. Bot fica ACTIVE com webhookUrl. Conta de usuário costuma ficar PENDING até concluir o login (QR ou link).

success

boolean

data

object

Show child attributes