REST API v1 · 開發者 · API 參考
邀請與獎勵 API 參考
BotGG REST API v1 的所有 3 個 邀請與獎勵 端點:範圍、參數、欄位、錯誤,以及可直接執行的 curl、JavaScript 與 Python 範例。
開發者文件
本頁目錄
端點
路徑皆相對於 https://console.botgg.app/api/v1。請以 Authorization: Bearer botgg_… 傳送你的 API 金鑰,ID 皆為字串。
| 端點 | 範圍 | 說明 |
|---|---|---|
GET/guilds/{guildId}/invites/members/{userId} | invites:read | Get a member’s invites |
GET/guilds/{guildId}/invites/leaderboard | invites:read | Invites leaderboard |
POST/guilds/{guildId}/invites/members/{userId}/bonus | invites:write | Add or remove bonus invites |
除了下方各自的錯誤外,每個端點還可能回傳這些常見錯誤:
Get a member’s invites
GET/guilds/{guildId}/invites/members/{userId}
Invite counters, all-time rank and the active season’s count and rank. Members who invited nobody get zeros.
需要在伺服器上啟用此功能: 邀請與獎勵
| 名稱 | 位置 | 類型 | 必填 | 說明 |
|---|---|---|---|---|
guildId | 路徑 | string | 是 | 你的伺服器 ID · Discord ID(字串) |
userId | 路徑 | string | 是 | 成員的 Discord 使用者 ID · Discord ID(字串) |
回應
| 欄位 | 類型 | 必填 | 說明 |
|---|---|---|---|
userId | string | 是 | |
invites | integer | 是 | verified + bonus (never below 0) — what milestones and the leaderboard use |
verified | integer | 是 | |
pending | integer | 是 | |
left | integer | 是 | |
fake | integer | 是 | |
bonus | integer | 是 | |
total | integer | 是 | |
rank | integer | null | 是 | |
season | object | null | 是 | The active season, if any |
season.id | integer | 是 | |
season.number | integer | 是 | |
season.name | string | null | 是 | |
season.startsAt | string | null | 是 | |
season.endsAt | string | null | 是 | |
season.invites | integer | 是 | |
season.rank | integer | null | 是 |
{
"userId": "876543210987654321",
"invites": 10,
"verified": 10,
"pending": 10,
"left": 10,
"fake": 10,
"bonus": 10,
"total": 10,
"rank": 1,
"season": {
"id": 98765,
"number": 7,
"name": "Example",
"startsAt": "2026-10-07T12:00:00.000Z",
"endsAt": "2026-10-07T12:00:00.000Z",
"invites": 10,
"rank": 1
}
}範例
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321" \
-H "Authorization: Bearer $BOTGG_API_KEY"// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)錯誤
| HTTP | 代碼 |
|---|---|
| 409 | FEATURE_DISABLED |
| 503 | SERVICE_UNAVAILABLE |
Invites leaderboard
GET/guilds/{guildId}/invites/leaderboard
period=all ranks by invites (verified + bonus), period=season by the active season’s invites (empty without a season). Pass cursor=<nextCursor> for the next page.
需要在伺服器上啟用此功能: 邀請與獎勵
| 名稱 | 位置 | 類型 | 必填 | 說明 |
|---|---|---|---|---|
guildId | 路徑 | string | 是 | 你的伺服器 ID · Discord ID(字串) |
period | 查詢字串 | string | 否 | 其中之一 all, season · 預設值 "all" |
limit | 查詢字串 | integer | 否 | 1–100 · 預設值 25 |
cursor | 查詢字串 | integer | 否 | 0–10,000,000 · 預設值 0 |
回應
| 欄位 | 類型 | 必填 | 說明 |
|---|---|---|---|
period | string | 是 | 其中之一 all, season |
season | object | null | 是 | |
season.id | integer | 是 | |
season.number | integer | 是 | |
season.name | string | null | 是 | |
season.startsAt | string | null | 是 | |
season.endsAt | string | null | 是 | |
items | array of object | 是 | |
items[].rank | integer | 是 | |
items[].userId | string | 是 | |
items[].score | integer | 是 | |
items[].invites | integer | 是 | |
items[].verified | integer | 是 | |
items[].bonus | integer | 是 | |
total | integer | 是 | |
nextCursor | string | null | 是 |
{
"period": "all",
"season": {
"id": 98765,
"number": 7,
"name": "Example",
"startsAt": "2026-10-07T12:00:00.000Z",
"endsAt": "2026-10-07T12:00:00.000Z"
},
"items": [
{
"rank": 1,
"userId": "876543210987654321",
"score": 10,
"invites": 10,
"verified": 10,
"bonus": 10
}
],
"total": 10,
"nextCursor": "98700"
}範例
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/leaderboard?period=all&limit=25&cursor=0" \
-H "Authorization: Bearer $BOTGG_API_KEY"// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/invites/leaderboard?period=all&limit=25&cursor=0', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://console.botgg.app/api/v1/guilds/123456789012345678/invites/leaderboard",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
},
params={
"period": "all",
"limit": 25,
"cursor": 0,
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)錯誤
| HTTP | 代碼 |
|---|---|
| 409 | FEATURE_DISABLED |
| 503 | SERVICE_UNAVAILABLE |
Add or remove bonus invites
POST/guilds/{guildId}/invites/members/{userId}/bonus
Same as /invites add|remove. Counts toward the active season; milestone rewards for additions are granted by the bot within a minute. Written to the audit log.
需要在伺服器上啟用此功能: 邀請與獎勵
| 名稱 | 位置 | 類型 | 必填 | 說明 |
|---|---|---|---|---|
guildId | 路徑 | string | 是 | 你的伺服器 ID · Discord ID(字串) |
userId | 路徑 | string | 是 | 成員的 Discord 使用者 ID · Discord ID(字串) |
Idempotency-Key | 標頭 | string | 否 | 選填。傳送一個唯一值(UUID),重試時沿用同一個值,變更就只會發生一次。 運作方式 |
請求內容
| 欄位 | 類型 | 必填 | 說明 |
|---|---|---|---|
amount | integer | 是 | Positive = add bonus invites, negative = remove -100,000–100,000 |
reason | string | null | 否 | Shown in the audit log 最多 200 個字元 |
回應
| 欄位 | 類型 | 必填 | 說明 |
|---|---|---|---|
userId | string | 是 | |
amount | integer | 是 | |
previousBonus | integer | 是 | |
bonus | integer | 是 | |
invites | integer | 是 | |
verified | integer | 是 |
{
"userId": "876543210987654321",
"amount": 100,
"previousBonus": 10,
"bonus": 10,
"invites": 10,
"verified": 10
}範例
curl -s -X POST "https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321/bonus" \
-H "Authorization: Bearer $BOTGG_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"amount":100,"reason":"Tournament prize"}'// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321/bonus', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(), // reuse it when you retry this request
},
body: JSON.stringify({
amount: 100,
reason: 'Tournament prize',
}),
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os, uuid
import requests
res = requests.post(
"https://console.botgg.app/api/v1/guilds/123456789012345678/invites/members/876543210987654321/bonus",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
"Idempotency-Key": str(uuid.uuid4()), # reuse it when you retry this request
},
json={
"amount": 100,
"reason": "Tournament prize",
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)