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

# 获取用户联系人列表



## OpenAPI

````yaml /zh/openapi.yml get /user/my/contacts
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:
  /user/my/contacts:
    get:
      tags:
        - user
      summary: 获取用户联系人列表
      operationId: userMyContacts
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
      responses:
        '200':
          description: 好的
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyListContactsResponse'
        '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:
    MyListContactsResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Success get list contacts
        results:
          type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/MyListContacts'
    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: 附加数据
    MyListContacts:
      type: object
      properties:
        jid:
          type: string
          example: 628123123123123@s.whatsapp.net
        name:
          type: string
          example: Aldino Kemal
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [获取每个联系人名称的联系人列表](https://gowa-docs.mintlify.site/zh/api-reference/user/获取每个联系人名称的联系人列表.md)
- [获取加入群组的参与者请求列表](https://gowa-docs.mintlify.site/zh/api-reference/group/获取加入群组的参与者请求列表.md)
- [用户头像](https://gowa-docs.mintlify.site/zh/api-reference/user/用户头像.md)
- [用户我的列表组](https://gowa-docs.mintlify.site/zh/api-reference/user/用户我的列表组.md)
- [从指定的聊天室获取消息](https://gowa-docs.mintlify.site/zh/api-reference/chat/从指定的聊天室获取消息.md)


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