# 获取线索

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/get-leads:
    get:
      summary: 获取线索
      deprecated: false
      description: >+
        获取潜在客户 API
        端点允许您检索从聊天机器人对话生成的潜在客户。通过使用此端点，您可以获取与您的聊天机器人交互的用户的姓名、电话号码和电子邮件。

      tags: []
      parameters:
        - name: chatbotId
          in: query
          description: 您要检索其潜在客户的聊天机器人的 ID。
          required: true
          example: '%5BYour%20Chatbot%20ID%5D'
          schema:
            type: string
        - name: startDate
          in: query
          description: 表示获取对话的日期范围的开始日期。日期应采用“年-月-日”格式（例如，2023-07-10，而不是 2023-7-10）。
          required: false
          example: '2023-01-01'
          schema:
            type: string
        - name: endDate
          in: query
          description: 表示获取对话的日期范围的结束日期。日期应采用“年-月-日”格式（例如，2023-07-13，而不是 2023-7-13）。
          required: false
          example: '2023-12-12'
          schema:
            type: string
        - name: page
          in: query
          description: 指定分页结果的页码。
          required: false
          example: '1'
          schema:
            type: string
        - name: size
          in: query
          description: 表示每页的结果数，也用于分页。
          required: false
          example: '10'
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          example: Bearer <Your-Secret-Key>
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        created_at:
                          type: string
                        chatbot_owner_user_id:
                          type: string
                        chatbot_id:
                          type: string
                        phone:
                          type: string
                        email:
                          type: string
                        name:
                          type: string
                      x-apifox-orders:
                        - id
                        - created_at
                        - chatbot_owner_user_id
                        - chatbot_id
                        - phone
                        - email
                        - name
                required:
                  - data
                x-apifox-orders:
                  - data
              example:
                data:
                  - id: 0
                    created_at: string
                    chatbot_owner_user_id: string
                    chatbot_id: string
                    phone: string
                    email: string
                    name: string
          headers: {}
          x-apifox-name: 成功
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apifox-orders: []
          headers: {}
          x-apifox-name: 请求有误
      security: []
      x-apifox-folder: ''
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4195807/apis/api-157477927-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: http://dev-cn.your-api-server.com
    description: 开发环境
  - url: http://test-cn.your-api-server.com
    description: 测试环境
  - url: https://www.chatbase.co
    description: 正式环境
security: []

```