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

# Получить метаданные бюллетеня (канала)

> Возвращает метаданные канала (имя, описание, количество подписчиков,
верификация, изображение, код приглашения, состояние). Предоставьте ровно одну из
`newsletter_id` или `invite`. Ни один из вариантов не требует подписки на канал;
`viewer_metadata` имеет значение null, если WhatsApp не возвращает метаданные, относящиеся к конкретному зрителю.




## OpenAPI

````yaml /ru/openapi.yml get /newsletter/info
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: >
    Этот API используется для отправки whatsapp через API.


    Веб-панель инструментов это отдельный проект (gowa-ui); сервер загружает
    свой последний релиз

    и служит в `/` (или возвращает баннер JSON, когда

    APP_UI_ENABLED=false).


    Привязка устройства:

    - Отправляйте `X-Device-Id` при всех вызовах с прикрепленными устройствами.

    - WebSocket: подключиться к `/ws?device_id=<id>`.

    - Аутентификация WebSocket (когда включена основная аутентификация):
    браузеры не могут установить
      Заголовок авторизации при соединениях WebSocket, так же передает
      `&authorization=<base64(user:pass)>` в строке запроса. Использовать TLS в производстве
      так как учетные данные видны на URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Первоначальное подключение к серверу Whatsapp
  - name: device
    description: Управление устройством для поддержки нескольких устройств
  - name: user
    description: Получение информации
  - name: send
    description: Отправить сообщение (Text/Image/Файл/Видео).
  - name: message
    description: Управление сообщениями (отозвать/изменить/обновить).
  - name: call
    description: Управление звонками (отклонить входящие вызовы)
  - name: chat
    description: Общение и обмен сообщениями
  - name: group
    description: Настройки группы
  - name: newsletter
    description: настройка рассылки
  - name: chatwoot
    description: Интеграция с Chatwoot для поддержки клиентов
paths:
  /newsletter/info:
    get:
      tags:
        - newsletter
      summary: Получить метаданные бюллетеня (канала)
      description: >
        Возвращает метаданные канала (имя, описание, количество подписчиков,

        верификация, изображение, код приглашения, состояние). Предоставьте
        ровно одну из

        `newsletter_id` или `invite`. Ни один из вариантов не требует подписки
        на канал;

        `viewer_metadata` имеет значение null, если WhatsApp не возвращает
        метаданные, относящиеся к конкретному зрителю.
      operationId: getNewsletterInfo
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: newsletter_id
          in: query
          required: false
          schema:
            type: string
          example: 120363024512399999@newsletter
        - name: invite
          in: query
          required: false
          description: >-
            Ссылка приглашения канала (https://whatsapp.com/channel/...) или
            просто код
          schema:
            type: string
          example: https://whatsapp.com/channel/0029Va4K0PZ5a245NkngBA2M
      responses:
        '200':
          description: ОК
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewsletterInfoResponse'
        '400':
          description: Плохой запрос
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '500':
          description: Внутренняя ошибка сервера
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Идентификатор устройства для поддержки нескольких устройств. Требуется
        при регистрации нескольких устройств.

        Если только одно устройство зарегистрировано, оно будет использоваться
        по умолчанию.

        Можно также задать параметр `device_id` запроса.
      schema:
        type: string
        example: my-device-id
  schemas:
    NewsletterInfoResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Success get newsletter info
        results:
          $ref: '#/components/schemas/Newsletter'
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: Код состояния HTTP
        message:
          type: string
          example: field cannot be blank
          description: Подробное сообщение об ошибке
        results:
          type: object
          example: null
          description: дополнительные данные
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Подробное сообщение об ошибке
        results:
          type: object
          example: null
          description: дополнительные данные
    Newsletter:
      type: object
      properties:
        id:
          type: string
          example: 120363144038483540@newsletter
        state:
          type: object
          properties:
            type:
              type: string
              example: active
        thread_metadata:
          type: object
          properties:
            creation_time:
              type: string
              example: '1688746895'
            invite:
              type: string
              example: 0029Va4K0PZ5a245NkngBA2M
            name:
              type: object
              properties:
                text:
                  type: string
                  example: WhatsApp
                id:
                  type: string
                  example: '1688746895480511'
                update_time:
                  type: string
                  example: '1688746895480511'
            description:
              type: object
              properties:
                text:
                  type: string
                  example: >-
                    WhatsApp's official channel. Follow for our latest feature
                    launches, updates, exclusive drops and more.
                id:
                  type: string
                  example: '1689653839450668'
                update_time:
                  type: string
                  example: '1689653839450668'
            subscribers_count:
              type: string
              example: '0'
            verification:
              type: string
              example: verified
            picture:
              type: object
              properties:
                url:
                  type: string
                  example: ''
                id:
                  type: string
                  example: '1707950960975554'
                type:
                  type: string
                  example: IMAGE
                direct_path:
                  type: string
                  example: >-
                    /v/t61.24694-24/416962407_970228831134395_8869146381947923973_n.jpg?ccb=11-4&oh=01_Q5AaIIvOIeu3l0HCZWILrmr-dGR_vXFqnhUeytw0-ojPc4hL&oe=670D95B1&_nc_sid=5e03e0&_nc_cat=110
            preview:
              type: object
              properties:
                url:
                  type: string
                  example: ''
                id:
                  type: string
                  example: '1707950960975554'
                type:
                  type: string
                  example: PREVIEW
                direct_path:
                  type: string
                  example: >-
                    /v/t61.24694-24/416962407_970228831134395_8869146381947923973_n.jpg?stp=dst-jpg_s192x192&ccb=11-4&oh=01_Q5AaIHO-DQklqm3q3awF7xwji_WAn9DkgZASQA0B2Ct0qbSa&oe=670D95B1&_nc_sid=5e03e0&_nc_cat=110
            settings:
              type: object
              properties:
                reaction_codes:
                  type: object
                  properties:
                    value:
                      type: string
                      example: ALL
        viewer_metadata:
          type: object
          nullable: true
          description: Null при недоступности метаданных, специфичных для просмотра.
          properties:
            mute:
              type: string
              example: 'off'
            role:
              type: string
              example: subscriber
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [Получить метаданные сервера](https://gowa-docs.mintlify.site/ru/api-reference/app/получить-метаданные-сервера.md)
- [WhatsApp каналы](https://gowa-docs.mintlify.site/ru/examples/newsletters.md)
- [Получить список чатов](https://gowa-docs.mintlify.site/ru/api-reference/chat/получить-список-чатов.md)
- [Получить статус подключения](https://gowa-docs.mintlify.site/ru/api-reference/app/получить-статус-подключения.md)
- [Получить информацию об устройстве](https://gowa-docs.mintlify.site/ru/api-reference/device/получить-информацию-об-устройстве.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.