> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar conexão Telegram

> Consulta os detalhes de uma conta Telegram conectada.



## OpenAPI

````yaml /telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances/{instanceId}
openapi: 3.0.3
info:
  title: Notifique API — Telegram
  description: >-
    Envie mensagens Telegram e gerencie conexões. Autentique com `Authorization:
    Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfTgBearerAuth: []
  - ntfTgApiKeyHeader: []
tags:
  - name: Mensagens
    description: Enviar e gerenciar mensagens
  - name: Instâncias
    description: Criar e conectar bots ou contas USER
  - name: Chats
    description: Listar chats
paths:
  /v1/telegram/instances/{instanceId}:
    get:
      tags:
        - Instâncias
      summary: Consultar conexão Telegram
      description: Consulta os detalhes de uma conta Telegram conectada.
      operationId: ntfTg_getV1TelegramInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            Objeto em `data`. `hasSession` indica se a conexão já pode enviar
            (bot com token ou usuário com sessão salva).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_InstanceDetailEnvelope'
              example:
                success: true
                data:
                  id: clxx_inst
                  name: Suporte
                  status: ACTIVE
                  createdAt: '2026-04-01T12:00:00.000Z'
                  updatedAt: '2026-04-01T12:05:00.000Z'
                  mode: USER
                  botUsername: null
                  userTermsAcceptedAt: '2026-04-01T12:00:01.000Z'
                  userTermsVersion: v1
                  hasSession: true
        '401':
          description: Chave ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Unauthorized
                message: Invalid or missing API Key
                code: UNAUTHORIZED
        '402':
          description: Workspace suspenso ou plano expirado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Payment Required
                message: Plan expired or suspended
                code: WORKSPACE_BLOCKED
        '403':
          description: Sem escopo ou instância não permitida para esta chave.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              examples:
                scope:
                  value:
                    success: false
                    error: Forbidden
                    message: 'Missing scope: telegram:instances:list'
                    code: FORBIDDEN
                instance:
                  value:
                    success: false
                    error: Forbidden
                    message: Access to this instance is not allowed by this API Key
                    code: FORBIDDEN
        '404':
          description: Instância Telegram não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Not Found
                message: Telegram instance not found
                code: NOT_FOUND
components:
  schemas:
    NtfTg_InstanceDetailEnvelope:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/NtfTg_InstanceDetailData'
    NtfTg_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
      required:
        - success
        - error
        - message
        - code
    NtfTg_InstanceDetailData:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        mode:
          type: string
          nullable: true
          description: '`BOT` ou `USER` quando definido.'
        botUsername:
          type: string
          nullable: true
        userTermsAcceptedAt:
          type: string
          format: date-time
          nullable: true
        userTermsVersion:
          type: string
          nullable: true
        hasSession:
          type: boolean
          description: Indica se há token (bot) ou sessão (usuário) configurados.
  securitySchemes:
    ntfTgBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfTgApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````