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

# 使用配对代码登录设备

> 启动配对码登录指定设备栏位并返回代码在手机上输入。 等于`GET /app/login-with-code`，使用 `X-Device-Id: <device_id>`，设备则取自路径。



## OpenAPI

````yaml /zh/openapi.yml post /devices/{device_id}/login/code
openapi: 3.0.0
info:
  title: WhatsApp API 多设备
  version: 9.7.0
  description: |
    此 API 用于通过 API 发送什么应用。

    Web 仪表板是一个单独的项目(gowa-ui)； 服务器下载它的
    最新版本资产并在 `/` 处服务(或在
    APP_UI_ENABLED=false时返回一个 JSON 横幅)。

    设备范围：
    - 在所有设备范围的REST 调用上发送 `X-Device-Id` 。
    - WebSocket: 连接到"/w?device_id=<id>`.
    - WebSocket 身份验证（启用基本身份验证时）：浏览器无法为
      WebSocket 连接设置 Authorization 请求头，因此还需在
      查询字符串中传入 `&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/File/Video)。
  - name: message
    description: 消息操作 (撤销/react/update)。
  - name: call
    description: 通话管理 (拒绝来电)
  - name: chat
    description: 聊天对话和消息
  - name: group
    description: 组设置
  - name: newsletter
    description: 通讯设置
  - name: chatwoot
    description: 客户支持的聊天窗口集成
paths:
  /devices/{device_id}/login/code:
    post:
      tags:
        - device
      summary: 使用配对代码登录设备
      description: >-
        启动配对码登录指定设备栏位并返回代码在手机上输入。 等于`GET /app/login-with-code`，使用 `X-Device-Id:
        <device_id>`，设备则取自路径。
      operationId: loginDeviceWithCode
      parameters:
        - name: device_id
          in: path
          required: true
          schema:
            type: string
          description: 设备ID
        - name: phone
          in: query
          required: true
          schema:
            type: string
          example: '628912344551'
          description: 要配对的电话号码
      responses:
        '200':
          description: 好的
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceLoginWithCodeResponse'
        '404':
          description: 找不到设备
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '500':
          description: 服务器内部错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  schemas:
    DeviceLoginWithCodeResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Login with code started
        status:
          type: integer
          example: 200
        results:
          type: object
          properties:
            device_id:
              type: string
              example: my-device-id
            pair_code:
              type: string
              example: ABCD-1234
    ErrorNotFound:
      type: object
      properties:
        code:
          type: string
          example: 404
          description: HTTP 状态代码
        message:
          type: string
          example: Chat not found
          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: 附加数据
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [使用配对码登录](https://gowa-docs.mintlify.site/zh/api-reference/app/使用配对码登录.md)
- [使用二维码登录设备](https://gowa-docs.mintlify.site/zh/api-reference/device/使用二维码登录设备.md)
- [确认密钥配对代码](https://gowa-docs.mintlify.site/zh/api-reference/app/确认密钥配对代码.md)
- [会话和连接生命周期](https://gowa-docs.mintlify.site/zh/concepts/sessions.md)
- [API 参考](https://gowa-docs.mintlify.site/zh/api-reference/introduction.md)


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