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

# Estado del enlace Telegram

> Consulta si el enlace para conectar está activo.



## OpenAPI

````yaml /es/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances/{instanceId}/connect-page
openapi: 3.0.3
info:
  title: Notifique API — Telegram
  description: >-
    Envíe mensajes de Telegram y gestione conexiones. Autentíquese con
    `Authorization: Bearer sk_live_...` o `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producción
security:
  - ntfTgBearerAuth: []
  - ntfTgApiKeyHeader: []
tags:
  - name: Mensajes
    description: Enviar y gestionar mensajes
  - name: Instancias
    description: Crear y conectar bots o cuentas USER
  - name: Chats
    description: Listar chats
paths:
  /v1/telegram/instances/{instanceId}/connect-page:
    get:
      tags:
        - Instâncias
      summary: Estado del enlace Telegram
      description: Consulta si el enlace para conectar está activo.
      operationId: ntf_telegram_getConnectPage
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          example: inst_abc
      responses:
        '200':
          description: Configuración de la página de conexión.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ConnectPageStatusResponse'
              examples:
                disabled:
                  summary: Enlace deshabilitado
                  value:
                    success: true
                    data:
                      enabled: false
                      publicId: null
                      allowedHosts: []
                      needsSecretRotation: false
                      hostedUrl: null
                      embedUrl: null
                      iframeSnippet: null
                enabled:
                  summary: Enlace habilitado con URLs
                  value:
                    success: true
                    data:
                      enabled: true
                      publicId: V1StGXR8_Z5jdHi6B-myT
                      allowedHosts:
                        - app.cliente.com
                      needsSecretRotation: false
                      hostedUrl: >-
                        https://api.notifique.dev/w/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
                      embedUrl: >-
                        https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
                      iframeSnippet: >-
                        <iframe
                        src="https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345"
                        style="border:0;width:100%;min-height:560px"
                        allow="clipboard-read; clipboard-write"></iframe>
                      shareableLink:
                        hostedUrl: >-
                          https://api.notifique.dev/w/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
                        embedUrl: >-
                          https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
                        publicId: V1StGXR8_Z5jdHi6B-myT
                        secret: AbCdEfGhIjKlMnOpQrStUvWxYz012345
                        iframeSnippet: >-
                          <iframe
                          src="https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345"
                          style="border:0;width:100%;min-height:560px"
                          allow="clipboard-read; clipboard-write"></iframe>
                needsRotation:
                  summary: Habilitado, pero hay que rotar el secret
                  value:
                    success: true
                    data:
                      enabled: true
                      publicId: V1StGXR8_Z5jdHi6B-myT
                      allowedHosts: []
                      needsSecretRotation: true
                      hostedUrl: null
                      embedUrl: null
                      iframeSnippet: null
                      hostedUrlBase: >-
                        https://api.notifique.dev/w/instance-connect/V1StGXR8_Z5jdHi6B-myT
                      embedUrlBase: >-
                        https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT
        '401':
          description: No autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Unauthorized
                message: Invalid or missing API Key
                code: UNAUTHORIZED
        '403':
          description: Escopo ausente ou instancia fora do escopo da API Key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Forbidden
                message: Missing scope
                code: FORBIDDEN
        '404':
          description: Instancia no encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Not Found
                message: Instance not found
                code: NOT_FOUND
components:
  schemas:
    NtfTg_ConnectPageStatusResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            enabled:
              type: boolean
              example: true
            publicId:
              type: string
              nullable: true
              example: V1StGXR8_Z5jdHi6B-myT
            allowedHosts:
              type: array
              items:
                type: string
              example:
                - app.cliente.com
            needsSecretRotation:
              type: boolean
              description: >-
                true quando o secret não está mais disponível no servidor —
                chame rotate-secret para obter novas URLs.
              example: false
            hostedUrl:
              type: string
              nullable: true
              example: >-
                https://api.notifique.dev/w/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
            embedUrl:
              type: string
              nullable: true
              example: >-
                https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
            iframeSnippet:
              type: string
              nullable: true
              example: >-
                <iframe
                src="https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345"
                style="border:0;width:100%;min-height:560px"
                allow="clipboard-read; clipboard-write"></iframe>
            secret:
              type: string
              nullable: true
              description: >-
                Presente no GET quando o secret ainda está disponível no
                servidor.
              example: AbCdEfGhIjKlMnOpQrStUvWxYz012345
            hostedUrlBase:
              type: string
              nullable: true
              description: >-
                Base da URL hospedada sem token (quando
                needsSecretRotation=true).
              example: >-
                https://api.notifique.dev/w/instance-connect/V1StGXR8_Z5jdHi6B-myT
            embedUrlBase:
              type: string
              nullable: true
              description: >-
                Base da URL de embed sem token (quando
                needsSecretRotation=true).
              example: >-
                https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT
            shareableLink:
              $ref: '#/components/schemas/NtfTg_ShareableLink'
    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: >-
            Mensaje 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 [Respuestas 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_ShareableLink:
      type: object
      description: >-
        URLs da página pública de conexão. Quem tiver a URL pode
        conectar/desconectar a instancia — rotacione o secret após o uso.
      properties:
        hostedUrl:
          type: string
          description: URL hospedada da página de conexão (inclui o token).
          example: >-
            https://api.notifique.dev/w/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
        embedUrl:
          type: string
          description: URL para embed em iframe (inclui o token).
          example: >-
            https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345
        publicId:
          type: string
          description: ID público da página de conexão.
          example: V1StGXR8_Z5jdHi6B-myT
        secret:
          type: string
          description: >-
            Secret bruto (retornado em enable/rotate). Prefira usar hostedUrl,
            que já embute o token.
          example: AbCdEfGhIjKlMnOpQrStUvWxYz012345
        iframeSnippet:
          type: string
          description: Snippet HTML de iframe pronto para colar.
          example: >-
            <iframe
            src="https://api.notifique.dev/w/embed/instance-connect/V1StGXR8_Z5jdHi6B-myT?token=AbCdEfGhIjKlMnOpQrStUvWxYz012345"
            style="border:0;width:100%;min-height:560px" allow="clipboard-read;
            clipboard-write"></iframe>
      required:
        - hostedUrl
        - embedUrl
        - publicId
  securitySchemes:
    ntfTgBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfTgApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````