邦妮科技 BotBonnie
Search…
文件說明
教學範例
帳號綁定
用戶推播
用戶標籤
用戶參數
用戶資料
用戶訊息
如何使用 JSON 訊息?
常見問題
如何取得 API Token?
Changelog
Powered By
GitBook
用戶標籤
本教學將說明如何透過 API 來操作 BotBonnie 平台的標籤,包含建立 / 刪除標籤和標籤資料夾,以及如何將標籤貼到用戶身上等。
建立新標籤
在您的伺服器呼叫 BotBonnie 建立標籤的 API:
1
POST https://api.botbonnie.com/v1/api/tag/autogen
Copied!
Request headers
Name
Description
Content-Type
application/json
Authorization
Bearer
{API Token}
如何取得
API Token
?
Request body
Name
Type
Description
Required
botId
String
機器人 ID
o
name
String
標籤名稱
o
type
Number
標籤類型
0
:用戶標籤
1
:標籤資料夾
o
parentId
Number
標籤資料夾 ID
API 回覆
新增成功
1
{
2
"res": "{
3
"id": "tag-xxxxxx" //建立成功之標籤 ID
4
}",
5
"status": 200
6
}
Copied!
錯誤
1
{
2
"errorMessage": "...",
3
"errorCode": 500
4
}
Copied!
取得標籤內容
在您的伺服器呼叫 BotBonnie 取得標籤的 API:
1
GET https://api.botbonnie.com/v1/api/tag/{{tagID}}
Copied!
Query path parameters
Name
Description
tagId
欲查詢的標籤或是標籤資料夾 ID
Request headers
Name
Description
Content-Type
application/json
Authorization
Bearer
{API Token}
API 回覆
回應範例
1
{
2
"res": {
3
"created": 1583983892294, // 標籤建立時的 UNIX 時間戳記(毫秒)
4
"id": "tag--PTfLM4wQ", // 標籤 ID
5
"name": "測試API標籤 child", // 標籤名稱
6
"botId": "bot-WDCLEHlTw", // 機器人 ID
7
"type": 0 // 標籤類型
8
},
9
"status": 200
10
}
Copied!
刪除標籤
在您的伺服器呼叫 BotBonnie 刪除標籤的 API,刪除標籤時,也會同時拔除所有用戶身上的該標籤紀錄。當刪除的標籤為資料夾,會將其資料夾下的標籤與子資料夾一併刪除。
1
DELETE https://api.botbonnie.com/v1/api/tag/{{tagID}}
Copied!
Query path parameters
Name
Description
tagId
欲刪除的標籤或是標籤資料夾 ID
Request headers
Name
Description
Content-Type
application/json
Authorization
Bearer
{API Token}
API 回覆
回應範例
1
{
2
"res": [
3
"tag--PTfLM4Q"
4
], // 此陣列中包含所有被刪除的標籤 ID 與標籤資料夾 ID
5
"status": 200
6
}
Copied!
貼標籤到用戶身上
在您的伺服器呼叫 BotBonnie 用戶標籤 API:
1
POST https://api.botbonnie.com/v1/api/user/tag
Copied!
Request headers
Name
Description
Content-Type
application/json
Authorization
Bearer
{API Token}
Request body
Name
Type
Description
Required
bot_tag_id
String
標籤 ID
o
bot_uid
String
用戶 ID (加密)
與 bot_raw_uid 擇一
bot_raw_uid
String
用戶 ID (未加密)
與 bot_uid 擇一
bot_pid
String
粉絲頁 ID
o
bot_channel
Number
渠道代號
0
:Facebook
1
:LINE
o
移除用戶身上的標籤
在您的伺服器呼叫 BotBonnie 用戶標籤 API:
1
DELETE https://api.botbonnie.com/v1/api/user/tag
Copied!
Request headers
Name
Description
Content-Type
application/json
Authorization
Bearer
{API Token}
Request body
Name
Type
Description
Required
bot_tag_id
String
標籤 ID
o
bot_uid
String
用戶 ID (加密)
與 bot_raw_uid 擇一
bot_raw_uid
String
用戶 ID (未加密)
與 bot_uid 擇一
bot_pid
String
粉絲頁 ID
o
bot_channel
Number
渠道代號
0
:Facebook
1
:LINE
o
API 回覆
新增 / 刪除成功
1
{
2
"res": "ok",
3
"status": 200
4
}
Copied!
錯誤
1
{
2
"errorMessage": "...",
3
"errorCode": 500
4
}
Copied!
查詢用戶身上的標籤
在您的伺服器呼叫 BotBonnie 用戶標籤 API:
1
POST https://api.botbonnie.com/v1/api/user/taglist
Copied!
Request headers
Name
Description
Content-Type
application/json
Authorization
Bearer
{API Token}
Request Body
Name
Type
Description
Required
bot_uid
String
用戶 ID (加密)
與 bot_raw_uid 擇一
bot_raw_uid
String
用戶 ID (未加密)
與 bot_uid 擇一
bot_pid
String
粉絲頁 ID
o
bot_channel
Number
渠道代號
0
:Facebook
1
:LINE
o
API 回覆
回應範例
1
{
2
"res":[
3
{
4
"bot_uid":"53f224d55bd378237ad26dd0d79002f7206527ab1e91bd3d84bf05c9c6ac761291",
5
"bot_raw_uid":"U21ab30ccce78feb456048adeb80cf00a",
6
"bot_pid":"test_audi",
7
"bot_channel":1,
8
"tags":[
9
{
10
"id": "tag-4TbbFavFY",
11
"name": "標籤A",
12
"timestamp": 1540869097545
13
},
14
{
15
"id": "tag-Aw3IcRKNt",
16
"name": "標籤B",
17
"timestamp": 1540869134405
18
},
19
{
20
"id": "tag-bcpe7NStr",
21
"name": "標籤C",
22
"timestamp": 1540869152985
23
}
24
]
25
}
26
]
27
,"status":200
28
}
Copied!
教學範例 - Previous
用戶推播
Next - 教學範例
用戶參數
Last modified
2yr ago
Copy link
Contents
建立新標籤
API 回覆
取得標籤內容
API 回覆
刪除標籤
API 回覆
貼標籤到用戶身上
移除用戶身上的標籤
API 回覆
查詢用戶身上的標籤
API 回覆