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

# Получить состояние сопряжения с паролем

> Соединение паролем начинается с телефона при входе в систему QR. Когда телефон запрашивает, сервер отправляет вызов WebAuthn, который хранится здесь (также транслируется через веб-сокет как PASSKEY_REQUEST) до тех пор, пока не будет дан ответ.




## OpenAPI

````yaml /ru/openapi.yml get /app/passkey
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:
  /app/passkey:
    get:
      tags:
        - app
      summary: Получить состояние сопряжения с паролем
      description: >
        Соединение паролем начинается с телефона при входе в систему QR. Когда
        телефон запрашивает, сервер отправляет вызов WebAuthn, который хранится
        здесь (также транслируется через веб-сокет как PASSKEY_REQUEST) до тех
        пор, пока не будет дан ответ.
      operationId: appPasskeyStatus
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
      responses:
        '200':
          description: ОК
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyStatusResponse'
        '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:
    PasskeyStatusResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Passkey pairing status
        results:
          type: object
          properties:
            device_id:
              type: string
              example: device-1
            status:
              type: string
              enum:
                - none
                - awaiting_response
                - awaiting_confirmation
              example: awaiting_response
            challenge:
              type: object
              nullable: true
              description: >-
                WebAuthn параметры запроса на утверждение
                (PublicKeyCredentialRequestOptions JSON, base64url-encoded
                двоичные поля)
              properties:
                challenge:
                  type: string
                  example: dGVzdC1jaGFsbGVuZ2U
                timeout:
                  type: integer
                  example: 60000
                rpId:
                  type: string
                  example: whatsapp.com
                allowCredentials:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        example: public-key
                      transports:
                        type: array
                        items:
                          type: string
                userVerification:
                  type: string
                  example: required
            code:
              type: string
              description: >-
                Соединить код подтверждения (установить в ожидании
                подтверждения)
              example: ABCD-EFGH
            skip_handoff_ux:
              type: boolean
              example: false
    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: дополнительные данные
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [Подтвердите код сопряжения паролем](https://gowa-docs.mintlify.site/ru/api-reference/app/подтвердите-код-сопряжения-паролем.md)
- [События WebSocket](https://gowa-docs.mintlify.site/ru/api-reference/websocket.md)
- [Отправить подтверждение WebAuthn для сопряжения с паролем](https://gowa-docs.mintlify.site/ru/api-reference/app/отправить-подтверждение-webauthn-для-сопряжения-с-паролем.md)
- [Получить метаданные бюллетеня (канала)](https://gowa-docs.mintlify.site/ru/api-reference/newsletter/получить-метаданные-бюллетеня-канала.md)
- [Получить прогресс синхронизации Chatwoot](https://gowa-docs.mintlify.site/ru/api-reference/chatwoot/получить-прогресс-синхронизации-chatwoot.md)


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