Chatbase

获取线索

开发环境

http://dev-cn.your-api-server.com

GET

/api/v1/get-leads

获取潜在客户 API 端点允许您检索从聊天机器人对话生成的潜在客户。通过使用此端点，您可以获取与您的聊天机器人交互的用户的姓名、电话号码和电子邮件。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/api/v1/get-leads?chatbotId=%5BYour%20Chatbot%20ID%5D&startDate=2023-01-01&endDate=2023-12-12&page=1&size=10' \
--header 'Authorization: Bearer <Your-Secret-Key>'

响应示例

200 - 成功示例

{  
  "data": [  
    {  
      "id": 0,  
      "created_at": "string",  
      "chatbot_owner_user_id": "string",  
      "chatbot_id": "string",  
      "phone": "string",  
      "email": "string",  
      "name": "string"  
    }  
  ]  
}

请求参数

Query 参数

chatbotId

string

必需

您要检索其潜在客户的聊天机器人的 ID。

示例值:

%5BYour%20Chatbot%20ID%5D

startDate

string

可选

表示获取对话的日期范围的开始日期。日期应采用“年-月-日”格式（例如，2023-07-10，而不是 2023-7-10）。

示例值:

2023-01-01

endDate

string

可选

表示获取对话的日期范围的结束日期。日期应采用“年-月-日”格式（例如，2023-07-13，而不是 2023-7-13）。

示例值:

2023-12-12

page

string

可选

指定分页结果的页码。

示例值:

size

string

可选

表示每页的结果数，也用于分页。

示例值:

Header 参数

Authorization

string

必需

示例值:

Bearer <Your-Secret-Key>

返回响应

🟢200成功

application/json

Body

data

array [object {7}]

必需

integer

可选

created_at

string

可选

chatbot_owner_user_id

string

可选

chatbot_id

string

可选

phone

string

可选

string

可选

name

string

可选

🟠400请求有误

修改于 2024-03-20 09:59:28

更新聊天机器人设置

获取对话