用戶資料
本教學將說明如何透過 API 來取得一個機器人下所有用戶的基本資料。
在您的伺服器呼叫 BotBonnie 用戶資料 API:
GET https://api.botbonnie.com/v1/api/bot/customers
Name | Description |
Content-Type | application/json |
Authorization | Bearer {API Token} |
Name | Description | Required |
botId | 機器人 ID | o |
limit | 單次呼叫欲截取的筆數 [1-3086] | o |
from | 13 碼的 timestamp,抓取「最後互動時間」在這個 timestamp 之後的用戶(如果沒有帶則沒有限制) | x |
next | x |
Name | Type | Description |
res | Object | |
status | Number | HTTP Status |
Name | Type | Description |
records | Array[Record] | |
next | String | 截取下一頁所需的 key |
Name | Type | Description |
id | String | 用戶的 LINE / FB Messenger ID |
name | String | 用戶的姓名 |
platform | String | 值為 FB / LINE |
pageId | String | FB 粉專或 LINE 官方帳號 ID |
status | Number | 用戶的狀態,值的定義分別為 1: 運行中 2: 暫停中 3: 已停止 4: 被封鎖 5:主動封鎖 |
created | Number | 初次互動時間,為 13 碼的 timestamp |
lastActive | Number | 上次互動時間,為 13 碼的 timestamp |
pic | String | 大頭照的連結 |
tags | Array[Tag] | |
params | Array[Param] | |
email | String | 用戶的個人信箱 |
gender | String | 用戶的性別,男 / 女 |
birthday | String | 用戶的生日,YYYY-MM-DD 的格式 |
phone | String | 用戶的電話 |
extId | String | 帳號綁定完取得的 ID |
Name | Type | Description |
id | String | 標籤 ID |
name | String |