911Proxy OpenAPI

支援透過網站 OpenAPI 前綴管理個人帳戶、代理資源和團隊帳單。

認證方式以各操作的 security 定義為準：

  • apiKeyAuth：透過查詢參數 app_key 傳入個人或團隊 API Key；後端也相容於 key、appkey、openid 參數及 POST 請求體傳參。
  • bearerAuth：Authorization: Bearer <JWT>，用於網頁登入令牌。請勿把 API Key 當作 JWT。
  • 團隊 API Key 綁定固定團隊；支援團隊空間的介面可省略 team_id，明確傳入必須與 Key 綁定團隊一致。
  • 僅支援個人空間的介面會拒絕團隊 API Key；團隊操作仍遵循持有成員的資源權限。

JSON 回應包含 code、msg、data、request_id。 code=200 表示業務成功；HTTP 200 也可能攜帶業務錯誤碼。 msg 隨請求語言變化，客戶端應使用 code 判斷結果。部分匯出介面另支援文字、CSV 或 XML，詳見操作定義。 金額、流量、日期及分頁欄位以各介面 Schema 為準。

基礎 URL：

驗證

  • HTTP 驗證，方案：bearer
  • API Key（apiKeyAuth）
    • 參數名稱： app_key, in: query. 個人或團隊 API Key。建議查詢參數 app_key；也相容於 key/appkey/openid 及 POST 請求體。團隊 Key 只能存取綁定團隊的受支援介面。

代理帳戶管理

代理帳戶列表 (GET /api-gate-way/whitelist-account/list)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/whitelist-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/whitelist-account/list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串；團隊 Key 可省略，傳入時必須與 Key 一致

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» coderesponseCodefalse無狀態碼,200 成功、3 app_key 無效
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» idintegerfalse無帳戶編號
»»» usernamestringfalse無代理帳戶名
»»» passwordstringfalse無代理帳戶密碼
»»» created_atstringfalse無添加時間
»»» remarkstringfalse無備註
»»» product_typeproductTypesfalse無套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP
»»» usage_flowintegerfalse無已使用流量，單位：KB
»»» limit_flowintegerfalse無自訂流量上限：單位GB最大102400，0 不限制
»»» statusintegerfalse無啟用狀態：1啟用，0停用

列舉值

屬性值
product_type9
product_type11
product_type14
product_type25

檢測代理帳戶可設定的流量限制

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» accountbodystringfalse編輯已有代理帳戶時傳入帳號名稱

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "isAgent": 0,
    "trendMax": 0,
    "staticMax": 0,
    "maxLimit": 0,
    "minLimit": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
isAgent0
isAgent1

取得動態代理子帳號配額與已使用數量

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/whitelist-account/child-account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/whitelist-account/child-account

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "totalChildAccount": 0,
    "usedChildAccount": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

新增代理帳戶。 (POST /api-gate-way/whitelist-account/add)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue帳號密碼，請按格式 username:password 填寫，帳號和密碼僅支援數字和字母，禁止輸入任何特殊符號或空格,冒號隔開帳號和密碼。支援批量添加，英文逗號（,）分隔代理帳戶。
» remarkbodystringfalse代理帳戶描述
» product_typebodyproductTypesfalse套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP

列舉值

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

刪除代理帳戶 (POST /api-gate-way/whitelist-account/delete)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/delete

請注意刪除後無法恢復，已使用流量等無法查詢。刪除約5分鐘等待時間，期間仍可能產生費用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue代理帳戶，僅支援數字和字母。支援批次操作，英文逗號（,）分隔代理帳戶

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

停用代理帳戶 (POST /api-gate-way/whitelist-account/disable)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/disable

禁用約5分鐘等待時間，在此期間仍可能產生費用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue代理帳戶，僅支援數字和字母。支援批次操作，英文逗號（,）分隔代理帳戶

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

啟用代理帳戶 (POST /api-gate-way/whitelist-account/enable)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue代理帳戶，僅支援數字和字母。支援批次操作，英文逗號（,）分隔代理帳戶

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

修改代理帳戶密碼

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/change-password

請注意修改後有5分鐘等待時間，在此期間舊密碼仍可能正常使用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "password": "pass"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountbodystringtrue代理帳戶，僅支援數字和字母。
» passwordbodystringtrue代理帳戶新密碼，僅支援數字和字母。

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

修改代理帳戶備註

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "remark": ""
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountbodystringtrue代理帳戶，僅支援數字和字母。
» remarkbodystringtrue代理帳戶新備註，32個中文或64個英文以內。

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

修改代理帳戶流量上限

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/change-limit

請注意流量統計可能有5分鐘以內延遲，即實際消耗流量可能超過此限制。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "limit": 0
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountbodystringtrue代理帳戶，僅支援數字和字母。
» limitbodyintegerfalse流量限制，單位：GB，0為不設上限

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

快速建立代理帳戶

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/quick-add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/quick-add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» product_typebodyintegertrue無

回應範例

200 回應

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "username": "string",
    "password": "string"
  }
}

回應

狀態碼含義描述資料模型
200OK業務成功時返回新帳戶和密碼Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無none
» msgstringfalse無none
» request_idstringfalse無none
» dataanyfalse無none

oneOf

名稱類型必填限制描述
»» anonymousobjectfalse無none
»»» usernamestringtrue無none
»»» passwordstringtrue無none

xor

名稱類型必填限制描述
»» anonymousnullfalse無none

修改代理帳戶每日流量上限

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/change-daily-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/change-daily-limit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "daily_limit": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» accountbodystringtrue無
» daily_limitbodyintegerfalse單位 GB

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

修改代理帳號資訊 (POST /api-gate-way/whitelist-account/change)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/change

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» accountbodystringtrue無
» passwordbodystringfalse無
» remarkbodystringfalse無
» limitbodyintegerfalse總流量上限，單位 GB
» daily_limitbodyintegerfalse每日流量上限，單位 GB
» statusbodyintegerfalse無
» udpbodyintegerfalse無

列舉值

ParameterValue
» status0
» status1
» udp0
» udp1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

重新整理目前資源空間的代理帳戶認證快取

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/whitelist-account/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/whitelist-account/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

指定產品類型的代理帳戶配額

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/whitelist-account/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/whitelist-account/quota

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
product_typequeryintegertrue無

回應範例

200 回應

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "usage": 0,
    "limit": 0,
    "expand": 0
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無none
» msgstringfalse無none
» request_idstringfalse無none
» dataobjectfalse無none
»» usageintegertrue無none
»» limitintegertrue無none
»» expandintegertrue無none

所有產品類型的代理帳戶配額

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/whitelist-account/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/whitelist-account/quotas

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無

回應範例

200 回應

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "product_type": 0,
        "limit": 0,
        "usage": 0
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無none
» msgstringfalse無none
» request_idstringfalse無none
» dataobjectfalse無none
»» list[object]false無none
»»» product_typeintegerfalse無none
»»» limitintegerfalse無none
»»» usageintegerfalse無none

代理帳戶列表 (GET /api-gate-way/proxy-account/list)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/proxy-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/proxy-account/list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串；團隊 Key 可省略，傳入時必須與 Key 一致

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» coderesponseCodefalse無狀態碼,200 成功、3 app_key 無效
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» idintegerfalse無帳戶編號
»»» usernamestringfalse無代理帳戶名
»»» passwordstringfalse無代理帳戶密碼
»»» created_atstringfalse無添加時間
»»» remarkstringfalse無備註
»»» product_typeproductTypesfalse無套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP
»»» usage_flowintegerfalse無已使用流量，單位：KB
»»» limit_flowintegerfalse無自訂流量上限：單位GB最大102400，0 不限制
»»» statusintegerfalse無啟用狀態：1啟用，0停用

列舉值

屬性值
product_type9
product_type11
product_type14
product_type25

新增代理帳戶。 (POST /api-gate-way/proxy-account/add)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue帳號密碼，請按格式 username:password 填寫，帳號和密碼僅支援數字和字母，禁止輸入任何特殊符號或空格,冒號隔開帳號和密碼。支援批量添加，英文逗號（,）分隔代理帳戶。
» remarkbodystringfalse代理帳戶描述
» product_typebodyproductTypesfalse套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP

列舉值

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

刪除代理帳戶 (POST /api-gate-way/proxy-account/delete)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-account/delete

請注意刪除後無法恢復，已使用流量等無法查詢。刪除約5分鐘等待時間，期間仍可能產生費用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue代理帳戶，僅支援數字和字母。支援批次操作，英文逗號（,）分隔代理帳戶

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

啟用代理帳戶 (POST /api-gate-way/proxy-account/enable)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue代理帳戶，僅支援數字和字母。支援批次操作，英文逗號（,）分隔代理帳戶

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

停用代理帳戶 (POST /api-gate-way/proxy-account/disable)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-account/disable

禁用約5分鐘等待時間，在此期間仍可能產生費用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountsbodystringtrue代理帳戶，僅支援數字和字母。支援批次操作，英文逗號（,）分隔代理帳戶

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» datanullfalse無none

修改代理帳號資訊 (POST /api-gate-way/proxy-account/change)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-account/change

修改代理帳戶密碼、備註、流量限制、每日流量限制、啟用狀態或 UDP 開關。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» accountbodystringtrue代理帳戶名
» passwordbodystringfalse新密碼，6-16 位數字或字母；不傳則不修改
» remarkbodystringfalse新備註
» limitbodyintegerfalse流量上限，單位 GB，0 表示不限制
» daily_limitbodyintegerfalse每日流量上限，單位 GB，0 表示不限制
» statusbodyintegerfalse啟用狀態
» udpbodyintegerfalseUDP 支援開關，僅對套餐類型 14、16、21、25 生效

列舉值

ParameterValue
» status0
» status1
» udp0
» udp1

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» datanullfalse無none

產生代理連接訊息

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/whitelist-account/format?ac=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/whitelist-account/format

支援個人和團隊 API Key。僅傳回目前資源空間內有權存取的代理帳號，支援套餐類型 9、11、12。 JSON/XML 傳回結構化帳密清單；txt/csv 傳回依 f 格式拼接的連線字串。

參數

名稱位置類型必填描述
acqueryinteger,stringtrue代理帳號 ID 或使用者名稱；相容參數 account
aequerystringfalse無
stquerystringfalse無
ctquerystringfalse無
lfqueryintegerfalse無
nqueryintegerfalse無
fqueryintegerfalse僅影響 txt/csv 的連接串格式
typequerystringfalse無
lbquerystringfalse無
epquerystringfalse無
team_idqueryResourceSpaceIdfalse無

列舉值

ParameterValue
f1
f2
f3
f4
f5
typejson
typexml
typetxt
typecsv

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "password": "string",
        "server": "string",
        "port": 0
      }
    ]
  },
  "request_id": "string"
}

"string"

<?xml version="1.0" encoding="UTF-8" ?>
<WebV1SuccessResponse>
  <code>200</code>
  <msg>SUCCESS</msg>
  <data/>
  <request_id>string</request_id>
</WebV1SuccessResponse>

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。WebV1SuccessResponse

訂單管理

訂單建立、查詢、取消等

訂單列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/order/list

團隊空間訂單額外返回 creator，表示實際下單成員；管理員和超級管理員可見完整聯絡方式，其他角色返回脫敏聯絡方式。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse訂單資源空間識別；個人空間省略或傳空字串
page_noqueryintegerfalse無
page_sizequeryintegerfalse無
trade_noquerystringfalse訂單編號
start_timequerystring(date-time)false開始時間（內含），如 2024-01-01 00:00:00
end_timequerystring(date-time)false結束時間（不含）
statusqueryintegerfalse訂單狀態
product_typequeryintegerfalse產品類型
invoicequeryintegerfalse發票狀態：0不限制 1已開發票 -1未開發票（可補）
pay_fee_statusqueryintegerfalse長短款篩選：1超額支付 2短款支付

Detailed descriptions

status: 訂單狀態

狀態描述
0待支付
1已支付
2逾時未付款已取消
3已退款

product_type: 產品類型

產品類型說明
3餘額儲值
9動態流量套餐
11動態全球包時套餐V2
12長效IDC流量套餐
13住宅靜態IP流量套餐
14資料中心靜態IP套餐
15長效ISP流量套餐
16靜態流量套餐
17動態IP數量套件
18web-scraper
19靜態IP續費
20靜態IP更換配額
21靜態流量套餐v2
24靜態流量附加包套件
25住宅靜態IP套餐
26補單 - 部分支付管道需要用戶手動填寫金額，如：虛擬幣，若發生短款，需要聯絡客服透過此種產品進行補支付
27Serp
28Video

列舉值

ParameterValue
status0
status1
status2
status3
product_type3
product_type9
product_type11
product_type12
product_type14
product_type16
product_type17
product_type18
product_type19
product_type21
product_type24
product_type25
product_type26
product_type27
product_type28
invoice-1
invoice0
invoice1
pay_fee_status1
pay_fee_status2

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {
          "name": "string",
          "org_name": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string",
          "email": "[email protected]",
          "role_type": 0,
          "vat_id": "string",
          "address_country": "string",
          "address_city": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_postal_code": "string"
        }
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK成功Inline

回應結構

建立訂單

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/order/create

因套餐種類較多，且每種套餐有不同的配置，請依實際情況填寫參數。不正當填寫參數可能導致訂單建立失敗。

examples:

續費靜態IP

{
    "pid": 套餐ID, // 從 /openapi/product 介面取得
    "upids": "1,2,3,4,5,6", // 從 /openapi/ip/get-static-ip 介面取得對應的 id 字段
    "pm_id": 1 // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
  }

靜態住宅IP購買

{
  "pid": 套餐ID, // 從 /openapi/product 介面取得
  "pm_id": 支付方式ID, // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
  "region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地區,數量,ASN|地區,數量,ASN（ASN編號可選）
}

靜態資料中心IP購買

{
  "pid": 套餐ID, // 從 /openapi/product 介面取得
  "pm_id": 支付方式ID, // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
  "region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地區,數量,ASN|地區,數量,ASN（ASN編號可選）
}

動態住宅流量購買

{
  "pid": 套餐ID, // 從 /openapi/product 介面取得
  "pm_id": 支付方式ID // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
}

靜態輪換流量購買

{
  "pid": 套餐ID, // 從 /openapi/product 介面取得
  "pm_id": 支付方式ID // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
}

動態無限流量購買

{
  "pid": 套餐ID, // 從 /openapi/product 介面取得
  "pm_id": 支付方式ID, // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
  "product_sku_bandwidth_id": 頻寬規格ID,
  "product_sku_concurrency_id": 並發規格ID
}

餘額儲值

{
  "pid": 套餐ID, // 從 /openapi/product 介面取得
  "pm_id": 支付方式ID, // 從 /openapi/payment/list 或 /openapi/payment/groups 介面取得
  "recharge_amount": 儲值金額
}

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 0,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "use_invitation_registration_discount": true,
  "renew_duration": 0,
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» pidbodyintegertrue套餐ID，來自 /openapi/product 介面返回的 id 字段
» upidsbodystringfalse續費套餐ID清單（逗號分隔），來自 /openapi/user-product/list 或 /openapi/ip/get-static-ip 介面傳回的 id 字段
» amountbodynumberfalse新購套餐數量
» pm_idbodyintegertrue支付方式ID，來自 /openapi/payment/list 或 /openapi/payment/groups 介面傳回的 id 字段
» region_listbodystringfalse購買靜態IP時指定區域+數量+ASN編號，格式：地區,數量,ASN
» coupon_snbodystringfalse優惠券編號
» use_invitation_registration_discountbodybooleanfalse是否使用邀請註冊優惠
» renew_durationbodyintegerfalse續費時長-靜態IP可選
» product_sku_bandwidth_idbodyintegerfalse套餐11：頻寬套餐ID
» product_sku_concurrency_idbodyintegerfalse套餐11：並發套餐ID
» product_sku_duration_idbodyintegerfalse套餐type=11必填：時長規格ID
» etdbodyintegerfalse時長倍數，從套餐 extension_of_time_days 獲取，2代表天數×2，價格上浮
» recharge_amountbodyintegerfalse套餐3：儲值金額

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK創建成功Inline

回應結構

取消訂單

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/order/close

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» trade_nobodystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

訂單詳情

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/order/info?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/order/info

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
trade_noquerystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

訂單詳情 V2

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/order/info-v2?order_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/order/info-v2

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
order_idquerystringtrue用戶端加密後的訂單 ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；訂單已支付或已取消時可能以業務錯誤 code 攜帶訂單數據Inline

回應結構

歷史訂單補開發票

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/order/reissue-invoice \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/order/reissue-invoice

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no_list": [
    "string"
  ]
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» trade_no_listbody[string]true無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

訂單預檢

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/order/check

建立訂單前調用，用於預覽價格、折扣、IP續費明細等，不會實際建立訂單。 參數與 /openapi/order/create 完全一致。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» pidbodyintegertrue套餐ID
» upidsbodystringfalseIP續費：用戶套餐ID列表，逗號分隔
» amountbodyintegerfalse購買數量
» pm_idbodyintegertrue付款方式ID
» region_listbodystringfalse靜態IP購買地區+數量，格式：地區ID,數量
» coupon_snbodystringfalse優惠券編號
» renew_durationbodystringfalseIP續費時間：1m=1個月，2m=2個月，em=下個月月底
» product_sku_bandwidth_idbodyintegerfalse套餐type=11必填：頻寬規格ID
» product_sku_concurrency_idbodyintegerfalse套餐type=11必填：並發規格ID
» product_sku_duration_idbodyintegerfalse套餐type=11必填：時長規格ID
» etdbodyintegerfalse長度倍數，從套餐 extension_of_time_days 獲取
» recharge_amountbodynumberfalse套餐type=3必填：儲值金額

列舉值

ParameterValue
» renew_duration1m
» renew_duration2m
» renew_durationem

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {
          "name_zh_cn": "string",
          "flag": "string",
          "square_flag": "string"
        }
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK預檢成功Inline

回應結構

API Key 管理

個人和團隊資源空間的 API Key 管理

API Key 列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/api-keys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/api-keys

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
pagequeryintegerfalse無
pageSizequeryintegerfalse無

回應範例

200 回應

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無none
» msgstringtrue無none
» request_idstringtrue無none
» dataobjecttrue無none
»» list[UserApiKeyMetadata]true無none
»»» idintegertrue無API Key ID
»»» api_keystringtrue無建立響應為完整 Key；團隊清單中為脫敏值
»»» team_user_idintegertrue無團隊 Key 實際持有成員 ID，個人 Key 為 0
»»» remarkstringtrue無備註
»»» statusintegertrue無0=停用，1=啟用
»»» created_atstringtrue無創建時間
»»» updated_atstring,nullfalse無更新時間
»» totalintegertrue無none
»» pageintegertrue無none
»» pageSizeintegertrue無none

列舉值

屬性值
status0
status1

建立 API Key

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/api-keys/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/api-keys/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» remarkbodystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK業務成功時返回完整 API Key，僅此一次Inline

回應結構

列舉值

屬性值
status0
status1

啟用 API Key

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/api-keys/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/api-keys/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrueAPI Key ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

停用 API Key

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/api-keys/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/api-keys/disable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrueAPI Key ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

刪除 API Key

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/api-keys/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/api-keys/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrueAPI Key ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

修改 API Key 備註

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/api-keys/update-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/api-keys/update-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrue無
» remarkbodystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

每月續費帳單

每月匯總續費的即時帳單、預檢、下單和歷史記錄

當月每月匯總續費帳單

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/monthly-renewal-bill \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/monthly-renewal-bill

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
typecurrent
typenext

檢查月度匯總續費訂單

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/monthly-renewal-bill/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/monthly-renewal-bill/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

參數

名稱位置類型必填描述
bodybodyMonthlyRenewalRequesttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idsbodyanytrue使用者套餐 ID 數組，也相容於英文逗號分隔字串
»» anonymousbody[integer]false無
»» anonymousbodystringfalse無
» user_coupon_idbodyintegerfalse無
» coupon_snbodystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_coupon_id": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
typecurrent
typenext

建立每月匯總續費訂單

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/monthly-renewal-bill/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/monthly-renewal-bill/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

參數

名稱位置類型必填描述
bodybodyMonthlyRenewalRequesttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idsbodyanytrue使用者套餐 ID 數組，也相容於英文逗號分隔字串
»» anonymousbody[integer]false無
»» anonymousbodystringfalse無
» user_coupon_idbodyintegerfalse無
» coupon_snbodystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "currency": "string",
    "user_coupon_id": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

每月匯總續費歷史帳單

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/monthly-renewal-bill/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/monthly-renewal-bill/history

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
trade_noquerystringfalse無
start_datequerystring(date)false無
end_datequerystring(date)false無
pagequeryintegerfalse無
sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "page": 1,
    "size": 1,
    "list": [
      {
        "id": 1,
        "trade_no": "string",
        "status": 0,
        "pay_fee": 0,
        "currency": "string",
        "pay_at": "string",
        "created_at": "string",
        "pay_method": 0,
        "pm_id": 0,
        "pay_channel": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "items": [
          {
            "id": 0,
            "user_product_id": 1,
            "product_id": 1,
            "product_type": 0,
            "parent_product_type": 0,
            "title": "string",
            "expired_at": "string",
            "target_expired_at": "string",
            "renew_days": 1,
            "unit_month_price": 0,
            "pay_fee": 0,
            "currency": "string",
            "bandwidth": 0,
            "bandwidth_mbsp": 0,
            "concurrency": 0,
            "ip": "string",
            "country_code": "string",
            "paid_at": "string",
            "refunded_at": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

發票管理

發票抬頭、開立發票申請和可開立發票訂單

發票抬頭詳情

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-invoice/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-invoice/info

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
invoice_codequerystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 1,
    "invoice_type": 0,
    "vat_id": "string",
    "tax_no": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "bank_name": "string",
    "bank_account": "string",
    "is_def": true
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

創建或修改發票抬頭

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-invoice/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-invoice/create

Body parameter

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true,
  "team_id": "A1b2C3d4E5f6",
  "new_invoice_code": false
}

參數

名稱位置類型必填描述
bodybodyanytrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功，data 為 nullInline

回應結構

發票抬頭列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-invoice/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-invoice/list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "invoice_code": "string",
        "name": "string",
        "org_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "[email protected]",
        "role_type": 1,
        "invoice_type": 0,
        "vat_id": "string",
        "tax_no": "string",
        "address_country": "string",
        "address_city": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_postal_code": "string",
        "bank_name": "string",
        "bank_account": "string",
        "is_def": true,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

刪除發票抬頭

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-invoice/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-invoice/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» invoice_codebodystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功，data 為 nullInline

回應結構

開立發票記錄列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-invoice/record-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-invoice/record-list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
statusqueryintegerfalse無

列舉值

ParameterValue
status0
status1
status2
status3
status4

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "invoice_no": "string",
        "invoice_amount": 0,
        "invoice_download_url": "string",
        "status": 0,
        "remark": "string",
        "order_ids": [
          0
        ],
        "created_at": 0,
        "invoice_info": {
          "invoice_code": "string",
          "name": "string",
          "org_name": "string",
          "role_type": 1,
          "invoice_type": 0
        }
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

提交開立發票申請

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-invoice/submit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-invoice/submit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string",
  "order_ids": [
    0
  ]
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» invoice_codebodystringtrue無
» order_idsbody[integer]true無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_id": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

取消開票申請

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-invoice/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-invoice/cancel

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_id": 1,
  "reason": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» invoice_idbodyintegertrue無
» reasonbodystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功，data 為 nullInline

回應結構

開票金額統計

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-invoice/statistics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-invoice/statistics

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoiceable_amount": 0,
    "invoiced_amount": 0,
    "processing_amount": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

可開立發票訂單列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-invoice/invoiceable-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-invoice/invoiceable-orders

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "order_no": "string",
        "pay_fee": 0,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

團隊管理

團隊創建、查詢、改名和解散

創建團隊

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/create

Body parameter

{
  "name": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» namebodystringtrue團隊名稱

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

目前使用者可存取的團隊列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/list

參數

名稱位置類型必填描述
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

團隊詳情

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/detail

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

修改團隊名稱

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/update-name \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/update-name

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» namebodystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

解散團隊

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/dissolve \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/dissolve

僅團隊超級管理員可調用。請求中的 name 必須與團隊目前名稱完全一致。 此介面強制執行操作二次驗證：未處於 15 分鐘信任狀態時回傳 code=348， 呼叫方應根據回應 data 中的可用方式取得驗證碼後，攜帶 verify_type 和 verify_code 重試。 可重複呼叫以繼續未完成的解散流程。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» namebodystringtrue團隊名稱確認，必須與團隊目前名稱完全一致
» verify_typebodystringfalse二次驗證方式；需要驗證時與 verify_code 一起提交
» verify_codebodystringfalse二次驗證碼；處於 15 分鐘信任狀態時可不傳

列舉值

ParameterValue
» verify_typephone
» verify_typeemail
» verify_typewechat
» verify_typetotp

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

查詢團隊解散狀態

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/dissolve-status?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/dissolve-status

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

團隊成員

團隊成員清單、角色調整、移除和退出

團隊成員列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/members?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/members

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
role1
role2
role3
role4
status0
status1
status2
status3

團隊人員統一列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/people?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/people

返回有效成員；超級管理員和管理員也會看到待處理邀請。其他邀請狀態僅保留在邀請歷史清單中。

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

調整成員角色

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/members/update-role \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/members/update-role

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» team_member_idbodyintegertrue無
» rolebodyintegertrue無

列舉值

ParameterValue
» role2
» role3

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
role1
role2
role3
role4
status0
status1
status2
status3

移除團隊成員

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/members/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/members/remove

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» team_member_idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data.status=3Inline

回應結構

列舉值

屬性值
role1
role2
role3
role4
status0
status1
status2
status3

退出團隊

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/members/leave \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/members/leave

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data.status=2Inline

回應結構

列舉值

屬性值
role1
role2
role3
role4
status0
status1
status2
status3

團隊邀請

團隊成員邀請的創建、查詢和處理

創建團隊邀請

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/invitations/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/invitations/create

按已註冊用戶、郵箱或手機號碼建立邀請。當郵箱或手機號碼符合到本站使用者時，回應會規範化為 invite_type=1。 前端可提交本站邀請 URL 相對路徑模板，服務端僅將其中的 替換為一次性邀請令牌。 未註冊目標使用受邀手機號碼註冊，或使用受邀信箱完成驗證後，服務端會將仍有效的邀請綁定到新用戶、輪換 token，並只補發一條未讀站內信；原郵件或短信中的舊 token 隨即失效。若信箱邀請尚未完成自動綁定，使用受邀信箱註冊的目前帳號可直接接受，無需等待 email_verify。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "[email protected]",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» invite_typebodyintegertrue1=已註冊用戶，2=郵箱，3=手機號
» rolebodyintegertrue2=管理員，3=普通成員
» user_idbodyintegerfalseinvite_type=1 時必填
» emailbodystring(email)falseinvite_type=2 時必填
» country_codebodyintegerfalseinvite_type=3 時必填
» phonebodystringfalseinvite_type=3 時必填
» invitation_url_templatebodystringfalse本站前端定義的相對路徑範本；必須以單一 / 開頭、不得包含網域名稱或換行，且必須且只能包含一個 佔位符
» anonymousbodyobjectfalse無
»» invite_typebodyanyfalse無
» anonymousbodyobjectfalse無
»» invite_typebodyanyfalse無
» anonymousbodyobjectfalse無
»» invite_typebodyanyfalse無

列舉值

ParameterValue
» invite_type1
» invite_type2
» invite_type3
» role2
» role3

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 code，200 為業務成功Inline

回應結構

列舉值

屬性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

團隊邀請列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/invitations?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/invitations

僅團隊超級管理員或管理員可存取；返回前會將已到期的待處理邀請更新為已過期。

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue團隊公開標識
pagequeryintegerfalse頁碼，從 1 開始
page_sizequeryintegerfalse每頁數量

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

預覽團隊邀請

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/invitations/preview?invitation_token=string \
  -H 'Accept: application/json'

GET /api-gate-way/team/invitations/preview

使用一次性 invitation_token 匿名預覽邀請；連結中不使用邀請數字 ID。

參數

名稱位置類型必填描述
invitation_tokenquerystringtrue邀請連結攜帶的非空明文一次性令牌

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
role2
role3
status0
status1
status2
status3
status4

重發團隊邀請通知

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/invitations/resend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/invitations/resend

重投原始發送管道；已註冊用戶同時發送站內信。重發會輪換令牌，之前的所有邀請連結立即失效。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» invitation_idbodyintegertrue邀請 ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

接受團隊邀請

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/invitations/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/invitations/accept

目前登入使用者使用一次性 invitation_token 接受邀請，必須與邀請目標相符且屬於邀請所屬站點；不需要傳 team_id。

Body parameter

{
  "invitation_token": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» invitation_tokenbodystringtrue明文一次性邀請令牌

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 為成員對象Inline

回應結構

列舉值

屬性值
role1
role2
role3
role4
status0
status1
status2
status3

拒絕團隊邀請

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/invitations/reject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/invitations/reject

目前登入使用者使用一次性 invitation_token 拒絕與本人相符的邀請；不需要傳 team_id。

Body parameter

{
  "invitation_token": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» invitation_tokenbodystringtrue明文一次性邀請令牌

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data.status=2Inline

回應結構

列舉值

屬性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

取消團隊邀請

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/invitations/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/invitations/cancel

取消指定團隊內的待處理邀請，操作人必須有權邀請該目標角色。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» invitation_idbodyintegertrue邀請 ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data.status=3Inline

回應結構

列舉值

屬性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

團隊資產

團隊資產查詢與個人/團隊空間劃轉

團隊套餐資訊

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/product-info?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/product-info

傳回指定團隊資源空間的套餐摘要，欄位與 /web_v1/user/info 的套餐欄位保持一致， 不回傳團隊超級管理員的個人資料、餘額或內部數位團隊 ID。積分套餐詳細資訊請使用 /web_v1/credit/info。

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

團隊資產列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/assets?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/assets

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

可劃入團隊的個人資產

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/assets/personal-candidates?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/assets/personal-candidates

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

個人資產劃入團隊

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/assets/move-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/assets/move-in

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

團隊資產移回個人

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/assets/move-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/assets/move-out

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

積分管理

積分套餐資訊、自動補充、消耗記錄和統計

獲取積分套餐信息 (GET /web_v1/credit/info)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/info

查詢目前資源空間的積分套餐摘要。團隊空間要求 USE_ASSETS 權限；此介面同時支援登入態、個人 API Key 和團隊 API Key。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串；團隊 API Key 可省略，傳入時必須與 Key 一致

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 為積分等級、總量、剩餘量、重置時間和自動補充狀態Inline

回應結構

設定餘額自動補充積分

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/web_v1/credit/update-auto-supplement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /web_v1/credit/update-auto-supplement

登入態設定目前資源空間的自動補充開關。團隊空間要求 USE_OWNER_PAYMENT_CAPABILITIES 權限，目前僅團隊超級管理員可操作；團隊空間預設為關閉。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» statusbodyintegertrue0=關閉，1=開啟

列舉值

ParameterValue
» status0
» status1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；當業務成功時 data.status 為更新後的開關狀態Inline

回應結構

取得積分消耗記錄 (GET /web_v1/credit/consumption-logs)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/consumption-logs

登入態或 API Key 分頁查詢目前資源空間的積分消耗記錄。團隊空間需求 VIEW_BILLING 權限。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無
start_datequerystring(date)false開始日期，依站點時區解釋
end_datequerystring(date)false結束日期，依站點時區解釋
consumption_typequerystringfalse消耗類型

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；當業務成功時 data 包含 list、page、page_size、total_count 和 total_pageInline

回應結構

取得積分重置記錄 (GET /web_v1/credit/reset-logs)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/reset-logs

登入態或 API Key 分頁查詢目前資源空間的積分重設記錄。團隊空間需求 VIEW_BILLING 權限。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含積分重置記錄及分頁資訊Inline

回應結構

取得積分統計 (GET /web_v1/credit/stats)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/stats

登入態或 API Key 查詢目前資源空間按消耗類型聚合的積分統計。團隊空間需求 VIEW_BILLING 權限。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false開始日期，依站點時區解釋
end_datequerystring(date)false結束日期，依站點時區解釋

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 by_type 和 totalInline

回應結構

取得按天積分統計 (GET /web_v1/credit/daily-stats)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/daily-stats

登入態或 API Key 查詢目前資源空間的按天積分消耗，預設最近 7 天。團隊普通成員僅返回本人實際消費；具備 VIEW_BILLING 權限的管理員、超級管理員和財務成員返回團隊全量資料。歷史未記錄消費成員的團隊日誌僅對全量檢視可見。 API Key 查詢最多包含 31 個自然日（含首尾），開始日期不得晚於結束日期。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false開始日期，預設 6 天前
end_datequerystring(date)false結束日期，預設今天
consumption_typequerystringfalse可選消耗類型
fill_gapsqueryintegerfalse是否補齊缺失日期

列舉值

ParameterValue
fill_gaps0
fill_gaps1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 daily_stats 和 summaryInline

回應結構

取得按小時積分統計 (GET /web_v1/credit/hourly-stats)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/hourly-stats

登入態或 API Key 查詢目前資源空間的按小時積分消耗，預設最近 7 天。團隊空間需求 VIEW_BILLING 權限。 API Key 查詢最多包含 31 個自然日（含首尾），開始日期不得晚於結束日期。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false開始日期，預設 6 天前
end_datequerystring(date)false結束日期，預設今天
consumption_typequerystringfalse可選消耗類型
fill_gapsqueryintegerfalse是否補齊缺失小時

列舉值

ParameterValue
fill_gaps0
fill_gaps1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 hourly_stats 和 summaryInline

回應結構

獲取積分套餐信息 (GET /api-gate-way/credit/info)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/credit/info

查詢目前資源空間的積分套餐摘要。團隊空間要求 USE_ASSETS 權限；此介面同時支援登入態、個人 API Key 和團隊 API Key。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串；團隊 API Key 可省略，傳入時必須與 Key 一致

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 為積分等級、總量、剩餘量、重置時間和自動補充狀態Inline

回應結構

取得積分消耗記錄 (GET /api-gate-way/credit/consumption-logs)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/credit/consumption-logs

登入態或 API Key 分頁查詢目前資源空間的積分消耗記錄。團隊空間需求 VIEW_BILLING 權限。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無
start_datequerystring(date)false開始日期，依站點時區解釋
end_datequerystring(date)false結束日期，依站點時區解釋
consumption_typequerystringfalse消耗類型

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；當業務成功時 data 包含 list、page、page_size、total_count 和 total_pageInline

回應結構

取得積分重置記錄 (GET /api-gate-way/credit/reset-logs)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/credit/reset-logs

登入態或 API Key 分頁查詢目前資源空間的積分重設記錄。團隊空間需求 VIEW_BILLING 權限。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含積分重置記錄及分頁資訊Inline

回應結構

取得積分統計 (GET /api-gate-way/credit/stats)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/credit/stats

登入態或 API Key 查詢目前資源空間按消耗類型聚合的積分統計。團隊空間需求 VIEW_BILLING 權限。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false開始日期，依站點時區解釋
end_datequerystring(date)false結束日期，依站點時區解釋

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 by_type 和 totalInline

回應結構

取得按天積分統計 (GET /api-gate-way/credit/daily-stats)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/credit/daily-stats

登入態或 API Key 查詢目前資源空間的按天積分消耗，預設最近 7 天。團隊普通成員僅返回本人實際消費；具備 VIEW_BILLING 權限的管理員、超級管理員和財務成員返回團隊全量資料。歷史未記錄消費成員的團隊日誌僅對全量檢視可見。 API Key 查詢最多包含 31 個自然日（含首尾），開始日期不得晚於結束日期。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false開始日期，預設 6 天前
end_datequerystring(date)false結束日期，預設今天
consumption_typequerystringfalse可選消耗類型
fill_gapsqueryintegerfalse是否補齊缺失日期

列舉值

ParameterValue
fill_gaps0
fill_gaps1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 daily_stats 和 summaryInline

回應結構

取得按小時積分統計 (GET /api-gate-way/credit/hourly-stats)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/credit/hourly-stats

登入態或 API Key 查詢目前資源空間的按小時積分消耗，預設最近 7 天。團隊空間需求 VIEW_BILLING 權限。 API Key 查詢最多包含 31 個自然日（含首尾），開始日期不得晚於結束日期。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false開始日期，預設 6 天前
end_datequerystring(date)false結束日期，預設今天
consumption_typequerystringfalse可選消耗類型
fill_gapsqueryintegerfalse是否補齊缺失小時

列舉值

ParameterValue
fill_gaps0
fill_gaps1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 hourly_stats 和 summaryInline

回應結構

Xcrawl Activity Log

Xcrawl 單任務與批次任務的記錄、詳情和總結查詢

取得 Xcrawl 近期任務列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/xcrawl-activity-log/recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/recent-runs

登入態查詢目前資源空間的單一任務清單和總和。團隊空間要求 USE_ASSETS；一般成員只能查看自己建立憑證產生的任務，管理員和超級管理員可查看全團​​隊任務。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無
endpointquerystringfalse端點類型
statusquerystringfalse無
start_timequerystringfalse用戶時區時間，格式 Y-m-d H:i:s
end_timequerystringfalse使用者時區時間，包含結束邊界
urlquerystringfalse目標 URL 或 Data scraper 標識
job_idquerystringfalse任務 ID 前綴

列舉值

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含分頁 list 和 metadataInline

回應結構

取得 Xcrawl Crawl Result

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/xcrawl-activity-log/crawl-result?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/crawl-result

登入態查詢目前資源空間指定任務的 Crawl Result。團隊空間要求 USE_ASSETS，並依成員可見憑證範圍校驗任務歸屬。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
job_idquerystringtrue任務 ID

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；當業務成功時 data 包含 job_id 和 crawl_resultInline

回應結構

取得 Xcrawl 任務詳情與日誌

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/xcrawl-activity-log/activity-logs?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/activity-logs

登入態查詢目前資源空間指定單一任務及其結果詳情。團隊空間要求 USE_ASSETS，並依成員可見憑證範圍校驗任務歸屬。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
job_idquerystringtrue任務 ID
pagequeryintegerfalsecrawl/data 子結果頁碼
page_sizequeryintegerfalsecrawl/data 子結果分頁數量

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 job 和按 endpoint 變更的 detailInline

回應結構

取得 Data URL 聚合統計

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/xcrawl-activity-log/data-url-summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/data-url-summary

登入態聚合目前資源空間的 Data scraper 任務。團隊空間要求 USE_ASSETS，結果遵循成員可見憑證範圍。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
limitqueryintegerfalse返回數量；0 返回空列表

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data.list 為 scraper 聚合結果Inline

回應結構

取得大量爬取近期任務列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/xcrawl-activity-log/batch-recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-recent-runs

登入態查詢目前資源空間的批次任務清單和總和。團隊空間要求 USE_ASSETS；一般成員只能查看自己建立憑證產生的任務，管理員和超級管理員可查看全團​​隊任務。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無
endpointquerystringfalse端點類型，通常為 batch_scrape
statusquerystringfalse無
start_timequerystringfalse用戶時區時間，格式 Y-m-d H:i:s
end_timequerystringfalse使用者時區時間，包含結束邊界
batch_idquerystringfalse批次任務 ID 前綴

列舉值

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含分頁 list 和 metadataInline

回應結構

取得大量爬取任務詳情與日誌

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/web_v1/xcrawl-activity-log/batch-activity-logs?batch_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-activity-logs

登入態查詢目前資源空間指定批次任務及其子項結果。團隊空間要求 USE_ASSETS，並依成員可見憑證範圍校驗任務歸屬。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
batch_idquerystringtrue批次任務 ID
pagequeryintegerfalse子項頁碼
page_sizequeryintegerfalse子項分頁數量

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；業務成功時 data 包含 job 和批次任務 detailInline

回應結構

帳戶管理

取得個人帳戶概覽

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/account/profile

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "username": "string",
    "nickname": "string",
    "email": "string",
    "balance": "string",
    "gift_balance": "string",
    "currency": "string",
    "language": "string",
    "timezone": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢個人餘額流水

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/wallet/change-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/wallet/change-list

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

參數

名稱位置類型必填描述
re_typequeryintegerfalse無
transaction_typequeryintegerfalse無
balance_typequeryintegerfalse無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

列舉值

ParameterValue
re_type0
re_type1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "re_type": 0,
        "transaction_type": 0,
        "balance_type": 0,
        "fee": "string"
      }
    ],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

日誌匯出

建立代理日誌匯出任務

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-usage-flow-log-export/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-usage-flow-log-export/create

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。 開始時間必須早於結束時間，時間跨度不超過 31 天；同一用戶只允許一個等待或處理中的匯出任務，日誌上限為 500 萬條。

Body parameter

{
  "start_time": 0,
  "end_time": 0,
  "type": "dynamic"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» start_timebodyintegertrue開始 Unix 時間戳，秒
» end_timebodyintegertrue結束 Unix 時間戳，秒
» typebodystringfalse無

列舉值

ParameterValue
» typedynamic
» typehost_pool

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "task_id": 0,
    "status": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢日誌匯出任務詳情

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-usage-flow-log-export/detail?task_id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-usage-flow-log-export/detail

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

參數

名稱位置類型必填描述
task_idqueryintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "user_id": 0,
    "start_time": "string",
    "end_time": "string",
    "status": "pending",
    "file_size": 0,
    "record_count": 0,
    "created_at": "string",
    "completed_at": "string",
    "file_url": "string",
    "download_url": "string",
    "error_message": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

查詢日誌匯出任務列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-usage-flow-log-export/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-usage-flow-log-export/list

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

參數

名稱位置類型必填描述
pagequeryintegerfalse無
sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "user_id": 0,
        "start_time": "string",
        "end_time": "string",
        "status": "pending",
        "file_size": 0,
        "record_count": 0,
        "created_at": "string",
        "completed_at": "string",
        "file_url": "string",
        "download_url": "string",
        "error_message": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

取消尚未執行的日誌匯出任務

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-usage-flow-log-export/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-usage-flow-log-export/cancel

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。 只能取消佇列中處於等待狀態的任務，已執行的任務無法取消。

Body parameter

{
  "task_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» task_idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

優惠券

查詢個人優惠券列表

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-coupon/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-coupon/list

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

Body parameter

{
  "status": 0,
  "page": 1,
  "size": 20
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» statusbodyintegerfalse無
» pagebodyintegerfalse無
» sizebodyintegerfalse無

列舉值

ParameterValue
» status0
» status1
» status2

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "coupon_id": 0,
        "type": 0,
        "status": 0,
        "source": 0,
        "title": "string",
        "title_en": "string",
        "description": "string",
        "description_en": "string",
        "start_amount": "string",
        "start_amount_usd": "string",
        "start_amount_hkd": "string",
        "deduction_amount": "string",
        "deduction_amount_usd": "string",
        "deduction_amount_hkd": "string",
        "discount_rate": "string",
        "discount_ceiling_amount": "string",
        "discount_ceiling_amount_usd": "string",
        "discount_ceiling_amount_hkd": "string",
        "created_at": "string",
        "effect_at": "string",
        "expired_at": "string",
        "used_at": "string",
        "product_types": "string",
        "created_timestamp": 0,
        "effect_timestamp": 0,
        "expired_timestamp": 0,
        "used_timestamp": 0,
        "is_expired": true
      }
    ],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢個人優惠券詳情

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-coupon/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-coupon/info

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

Body parameter

{
  "id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "coupon_id": 0,
    "type": 0,
    "status": 0,
    "source": 0,
    "title": "string",
    "title_en": "string",
    "description": "string",
    "description_en": "string",
    "start_amount": "string",
    "start_amount_usd": "string",
    "start_amount_hkd": "string",
    "deduction_amount": "string",
    "deduction_amount_usd": "string",
    "deduction_amount_hkd": "string",
    "discount_rate": "string",
    "discount_ceiling_amount": "string",
    "discount_ceiling_amount_usd": "string",
    "discount_ceiling_amount_hkd": "string",
    "created_at": "string",
    "effect_at": "string",
    "expired_at": "string",
    "used_at": "string",
    "product_types": "string",
    "created_timestamp": 0,
    "effect_timestamp": 0,
    "expired_timestamp": 0,
    "used_timestamp": 0,
    "is_expired": true
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

通知管理

查詢站內通知

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/notify/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/notify/list

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

參數

名稱位置類型必填描述
pagequeryintegerfalse無
sizequeryintegerfalse無
readqueryintegerfalse無
typequeryintegerfalse無

列舉值

ParameterValue
read0
read1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "type": 0,
        "read_status": 0,
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
read_status0
read_status1

查詢站內通知詳情

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/notify/detail?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/notify/detail

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

參數

名稱位置類型必填描述
idqueryintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "type": 0,
    "read_status": 0,
    "created_at": "string",
    "created_timestamp": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
read_status0
read_status1

將站內通知標記為已讀

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/notify/read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/notify/read

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

Body parameter

{
  "id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

批量標記站內通知為已讀

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/notify/batch-read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/notify/batch-read

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

Body parameter

{
  "ids": [
    1
  ]
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» idsbody[integer]true無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢通知頻道配置

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-notify \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-notify

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "scene": 0,
        "email_notify": true,
        "phone_notify": true,
        "browser_notify": true,
        "site_inner_message_notify": true,
        "webhook_notify": true,
        "telegram_notify": true
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢通知郵箱

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-notification-email/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-notification-email/list

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "email": "string",
        "created_at": 0
      }
    ],
    "max_count": 0,
    "current_count": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢通知場景

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-notification-email/scenes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-notification-email/scenes

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "description": "string"
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢郵箱訂閱場景

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-notification-email/email-scenes?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-notification-email/email-scenes

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

參數

名稱位置類型必填描述
idqueryintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "scenes": [
      0
    ],
    "subscribe_all": true
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

代理配置

查詢個人代理快取開關

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/proxy-cache/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/proxy-cache/status

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "status": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
status0
status1

設定個人代理快取開關

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-cache/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-cache/change

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

Body parameter

{
  "status": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» statusbodyintegertrue無

列舉值

ParameterValue
» status0
» status1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

查詢個人代理 UDP 開關

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-proxy-config/udp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-proxy-config/udp

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
enabled0
enabled1

設定個人代理 UDP 開關

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-proxy-config/udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-proxy-config/udp

僅支援個人空間的登入態或個人 API Key；團隊 API Key 不支援。

Body parameter

{
  "udp": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» udpbodyintegertrue無

列舉值

ParameterValue
» udp0
» udp1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請檢查業務 code，200 為成功。Inline

回應結構

列舉值

屬性值
enabled0
enabled1

團隊錢包

查詢團隊錢包

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/wallet/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/wallet/detail

需要 VIEW_BILLING 權限。團隊錢包獨立於超級管理員和成員的個人餘額。

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

查詢團隊錢包流水

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/team/wallet/records?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/team/wallet/records

需要 VIEW_BILLING 權限。流水金額始終為正數，資金增減由 direction 欄位表示。

參數

名稱位置類型必填描述
team_idqueryTeamPublicIdtrue無
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

列舉值

屬性值
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

個人餘額轉入團隊錢包

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/wallet/transfer-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/wallet/transfer-in

僅團隊超級管理員具有 TRANSFER_BALANCE 權限。原子扣減其個人儲值餘額後增加團隊錢包；轉入金額不計入 total_recharge_fee，且不支援轉回個人餘額。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» amountbodynumber(double)true無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

團隊餘額轉回個人帳戶

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/team/wallet/transfer-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/team/wallet/transfer-out

僅超級管理員登入態可呼叫。原子扣減團隊錢包並增加其個人儲值餘額；不改變團隊或個人的累積儲值金額。解散中的團隊可用於回收餘額，已解散團隊無法呼叫。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyTeamPublicIdtrue團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» amountbodynumber(double)true不得超過團隊目前可用餘額

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKHTTP 成功；請繼續判斷回應體 codeInline

回應結構

IP擷取

提取IP (GET /api-gate-way/ip/get-ip)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/get-ip?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/get-ip

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse團隊 Key 可省略；傳入時必須與 Key 綁定團隊一致
app_keyquerystring(password)true存取密鑰
ccquerystringfalse國家或地區
statequerystringfalse省或州
cityquerystringfalse城市
formatquerystringfalse取得格式
lbquerystringfalse間隔符，僅text格式有效
numquerynumberfalse提取數量
lifequerynumberfalse保持週期-分鐘
epquerystringfalse代理商網路

列舉值

ParameterValue
epus
ephk
epde

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[any]false無none

城市列表 (GET /api-gate-way/ip/dynamic-area-city-list)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dynamic-area-city-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dynamic-area-city-list

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[object]false無清單
»»» name_zh_cnstringfalse無國家或地區名稱
»»» name_enstringfalse無國家或地區名稱
»»» continent_codestringfalse無大洲代碼
»»» country_codestringfalse無國家或地區代碼
»»» items[any]false無省或州
»»»» citystringfalse無城市名稱
»»»» statestringfalse無省或州名稱代碼
»»»» continent_codestringfalse無大洲代碼
»»»» country_codestringfalse無國家或地區代碼

IP 擷取數量按天統計

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-extract-ip/days \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-extract-ip/days

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_datequerystring(date)false預設 6 天前
end_datequerystring(date)false預設今天
product_typequeryintegerfalse無

列舉值

ParameterValue
product_type9
product_type17
product_type22

回應範例

200 回應

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "count": 0,
        "date": "2019-08-24"
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無none
» msgstringfalse無none
» request_idstringfalse無none
» dataobjectfalse無none
»» list[object]false無none
»»» countintegertrue無none
»»» datestring(date)true無none

提取IP (GET /api-gate-way/ip/v3)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/v3

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse團隊 Key 可省略；傳入時必須與 Key 綁定團隊一致
app_keyquerystring(password)true存取密鑰
ccquerystringfalse國家或地區
statequerystringfalse省或州
cityquerystringfalse城市
formatquerystringfalse取得格式
lbquerystringfalse間隔符，僅text格式有效
numquerynumberfalse提取數量
lifequerynumberfalse保持週期-分鐘
epquerystringfalse代理商網路

列舉值

ParameterValue
epus
ephk
epde

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[any]false無none

動態地區城市列表V4

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dcl4

按使用者名稱取得城市列表，需要登入認證，且帳戶必須屬於目前用戶

參數

名稱位置類型必填描述
usernamequerystringtrue代理帳戶用戶名

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» cachebooleanfalse無是否來自緩存
»» list[object]false無none
»»» Citystringfalse無城市
»»» Areastringfalse無地區
»»» Statestringfalse無州/省

動態地區州/省列表V4

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dsl4

按使用者名稱取得州/省列表，需要登入認證，且帳戶必須屬於當前用戶

參數

名稱位置類型必填描述
usernamequerystringtrue代理帳戶用戶名

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» cachebooleanfalse無是否來自緩存
»» list[object]false無none
»»» Citystringfalse無城市
»»» Areastringfalse無地區
»»» Statestringfalse無州/省

動態地區州/省城市融合清單V4

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dal4

按使用者名稱取得州/省和城市的融合列表，按地區分組。需要登入認證，且帳戶必須屬於目前用戶

參數

名稱位置類型必填描述
usernamequerystringtrue代理帳戶用戶名

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": "California",
            "cities": [
              "Los Angeles"
            ]
          }
        ]
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» cachebooleanfalse無是否來自緩存
»» list[object]false無地區列表
»»» Areastringfalse無地區代碼
»»» states[object]false無州/省列表
»»»» Statestringfalse無州/省名稱
»»»» cities[string]false無城市列表

城市列表 (GET /api-gate-way/ip/dynamic-citys)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dynamic-citys

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[object]false無清單
»»» name_zh_cnstringfalse無國家或地區名稱
»»» name_enstringfalse無國家或地區名稱
»»» continent_codestringfalse無大洲代碼
»»» country_codestringfalse無國家或地區代碼
»»» items[any]false無省或州
»»»» citystringfalse無城市名稱
»»»» statestringfalse無省或州名稱代碼
»»»» continent_codestringfalse無大洲代碼
»»»» country_codestringfalse無國家或地區代碼

城市搜尋

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dynamic-citys/search

參數

名稱位置類型必填描述
country_codequerystringtrue國家或地區代碼
statequerystringtrue州或省代碼

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[string]false無清單

州列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dynamic-states

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[object]false無清單
»»» name_zh_cnstringfalse無國家或地區名稱
»»» name_enstringfalse無國家或地區名稱
»»» continent_codestringfalse無大洲代碼
»»» country_codestringfalse無國家或地區代碼
»»» items[any]false無省或州
»»»» statestringfalse無省或州名稱代碼
»»»» continent_codestringfalse無大洲代碼
»»»» country_codestringfalse無國家或地區代碼

州/省搜索

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/dynamic-states/search

參數

名稱位置類型必填描述
country_codequerystringtrue國家或地區代碼

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[string]false無清單

取得已指派的資料中心靜態 IP 列表

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/ip/get-datacenter-assign-ip-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/ip/get-datacenter-assign-ip-list

已廢棄，推薦使用 /openapi/user-product/datacenter-isp-ip-list。為相容於舊客戶端，本介面使用 POST 方法，但篩選參數均從 query 讀取。

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串；團隊 Key 可省略，傳入時必須與 Key 一致
areaquerystringfalse國家/地區代碼
statusqueryintegerfalse0=所有，1=有效，2=過期
trade_noquerystringfalse訂單編號
created_atqueryarray[string]false創建時間範圍，必須同時傳開始和結束時間

列舉值

ParameterValue
status0
status1
status2

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 1,
        "ip": "string",
        "country_code": "string",
        "up_id": 1,
        "expired_at": "string",
        "created_at": "string",
        "country_name_zh_cn": "string",
        "country_name_en": "string",
        "country_continent_code": "string",
        "port": 1
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

提取已購買靜態IP列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/get-static-ip

參數

名稱位置類型必填描述
country_codequerystringfalse國家或地區代碼
product_typequerynumberfalse產品類型, 25:靜態住宅IP, 14: 資料中心IP
trade_noquerystringfalse透過訂單號碼篩選IP
pagequerynumberfalse頁碼
sizequerynumberfalse每頁數量
statusquerynumberfalse狀態, 1:有效, 2:無效, 3:即將過期, 4:維護中

列舉值

ParameterValue
product_type14
product_type25
status1 - 2 - 3 - 4

回應

狀態碼含義描述資料模型

取得在售地區靜態IP數量

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/ip/static-ip-region

參數

名稱位置類型必填描述
ispqueryintegerfalseISP 篩選，不傳則不篩選（站點 1/4/5 除外預設為 1）
asnqueryintegerfalse是否返回 ASN 分組數據
exclusivequeryintegerfalse是否依獨享庫存統計

Detailed descriptions

isp: ISP 篩選，不傳則不篩選（站點 1/4/5 除外預設為 1）

值說明
0資料中心靜態IP（IDC）
1家庭住宅靜態IP（ISP）

asn: 是否返回 ASN 分組數據

值說明
0不傳回 ASN 分組資料（預設）
1返回 ASN 分組資料

exclusive: 是否依獨享庫存統計

值說明
0依目前使用者/共享群組口徑統計（預設）
1排除所有已分配IP，僅統計可用庫存

列舉值

ParameterValue
isp0
isp1
asn0
asn1
exclusive0
exclusive1

回應範例

200 回應

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[any]false無none
»»» codestringtrue無國家或地區代碼
»»» numberintegertrue無數量

取得 host_pool 支援國家/地區

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/host-pool/regions

查詢 host_pool 服務目前網站支援的國家/地區清單。

此介面面向資料中心 IP 按流量積分的隨機擷取場景，僅按目前站點可用資料中心 IP 庫存統計國家/地區。

回應範例

200 回應

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» codestringtrue無國家或地區代碼，ISO 3166-1 alpha-2
»»» numberintegertrue無目前站點可用資料中心 IP 數量
»»» name_zh_cnstringfalse無國家或地區中文名稱
»»» name_enstringfalse無國家或地區英文名稱
»»» square_flagstringfalse無方形旗幟圖片 URL

IP白名單

IP 白名單列表 (GET /api-gate-way/proxy-ip/list)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/proxy-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/proxy-ip/list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
product_typequeryintegerfalse套餐類型編號

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» ipstringfalse無白名單 IP
»»» remarkstringfalse無備註
»»» product_typeintegerfalse無套餐類型
»»» created_atstringfalse無創建時間

新增 IP 白名單 (POST /api-gate-way/proxy-ip/add)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» ipsbodystringtrue需要新增的白名單 IP，多個用英文逗號或換行分隔
» remarkbodystringfalse備註
» product_typebodyintegerfalse套餐類型編號
» user_product_idbodyintegerfalse用戶套餐 ID，套餐類型為 11 時必填

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» datanullfalse無none

刪除 IP 白名單 (POST /api-gate-way/proxy-ip/delete)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/proxy-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» ipsbodystringtrue需要刪除的白名單 IP，多個以英文逗號分隔
» verify_typebodystringfalse驗證類型：phone、email、wechat、totp
» verify_codebodystringfalse驗證碼

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» datanullfalse無none

IP 白名單列表 (GET /api-gate-way/white-ip/list)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/white-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/white-ip/list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
product_typequeryintegerfalse套餐類型編號

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» ipstringfalse無白名單 IP
»»» remarkstringfalse無備註
»»» product_typeintegerfalse無套餐類型
»»» created_atstringfalse無創建時間

新增 IP 白名單 (POST /api-gate-way/white-ip/add)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/white-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/white-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» ipsbodystringtrue需要新增的白名單 IP，多個用英文逗號或換行分隔
» remarkbodystringfalse備註
» product_typebodyintegerfalse套餐類型編號
» user_product_idbodyintegerfalse用戶套餐 ID，套餐類型為 11 時必填

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» datanullfalse無none

刪除 IP 白名單 (POST /api-gate-way/white-ip/delete)

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/white-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/white-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» app_keybodystringfalse授權密鑰
» ipsbodystringtrue需要刪除的白名單 IP，多個以英文逗號分隔
» verify_typebodystringfalse驗證類型：phone、email、wechat、totp
» verify_codebodystringfalse驗證碼

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": null
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功
» msgstringfalse無狀態訊息
» datanullfalse無none

修改 IP 白名單備註

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/white-ip/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/white-ip/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ip": "192.168.0.1",
  "remark": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» ipbodystring(ipv4)true無
» remarkbodystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

刷新目前資源空間 IP 白名單認證快取

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/white-ip/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/white-ip/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

指定產品類型的 IP 白名單配額

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/white-ip/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/white-ip/quota

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
product_typequeryintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

所有產品類型的 IP 白名單配額

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/white-ip/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/white-ip/quotas

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

流量日誌查詢

近期使用流量按天匯總

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-usage-flow/days \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-usage-flow/days

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» daysbodyintegerfalse無
» product_typebodyintegerfalse無
» usernamebodystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

代理帳戶歷史使用流量

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-usage-flow/username-total \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-usage-flow/username-total

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "flow": 0
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

匯出代理帳戶月度使用流量

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-usage-flow/export-csv \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-usage-flow/export-csv

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

回應範例

200 回應

回應

狀態碼含義描述資料模型
200OKGBK 編碼 CSV 文件string

套餐流量總量與剩餘量

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-usage-flow/flow-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-usage-flow/flow-total

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
unitquerystringfalse無

列舉值

ParameterValue
unitKB
unitMB
unitGB
unitTB
unitPB

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
unitKB
unitMB
unitGB
unitTB
unitPB

每日速率圖

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-usage-flow/rate-graph \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-usage-flow/rate-graph

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
startquerystring(date)false無
endquerystring(date)false無
usernamequerystringfalse無
user_product_idqueryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

每日快取流量統計

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-usage-flow/cache-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-usage-flow/cache-total

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_timequerystringfalse無
end_timequerystringfalse無
product_typequeryintegerfalse無
usernamequerystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

使用流量按天匯總

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-usage-flow/total

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
app_keyquerystring(password)true認證金鑰
start_timequerystring(Y-m-d H:i:s)false起始時間，可精確到秒。請注意，日誌記錄有5分鐘以內延遲。預設7天以內。
end_timequerystring(Y-m-d H:i:s)false截止時間，可精確到秒。請注意，日誌記錄有5分鐘以內延遲。預設當前時間。
usernamequerystringfalse子帳戶名稱,預設查詢所有帳戶，可指定子帳戶。請注意如果您新增了相同名稱的子帳戶，此查詢將傳回同名代理帳戶的所有使用記錄。
product_typequerynumberfalse套餐類型

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» daystringfalse無日期
»»» flowintegerfalse無消耗流量,單位KB

代理日誌

用戶端 IP 代理存取統計

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/http-t-dom/list-v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/http-t-dom/list-v2

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_timequerystring(date)false無
end_timequerystring(date)false無
exportquerystringfalse無

列舉值

ParameterValue
exportcsv

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "visit_count": 0,
        "client_ip": "string",
        "time": "2019-08-24",
        "country_code": "string",
        "country": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKJSON 統計結果；export=csv 時傳回 CSV 文件string

用戶端 IP 存取佔比

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/http-t-dom/client-ip-proportion \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/http-t-dom/client-ip-proportion

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
start_timequerystring(date)false無
end_timequerystring(date)false無
exportquerystringfalse無

列舉值

ParameterValue
exportcsv

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "client_ip": "string",
        "visit_count": 0,
        "visit_percentage": "string",
        "country": "string",
        "country_code": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKJSON 佔比結果；export=csv 時傳回 CSV 文件string

套餐查詢

已購套餐列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-product/list

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
app_keyquerystring(password)true認證金鑰
trade_noquerystringfalse訂單編號，請輸入完整訂單編號。不支援模糊搜尋。
pagequerynumberfalse分頁，預設：1
sizequerynumberfalse分頁顯示數量,預設：20
product_typequerynumberfalse套餐類型

回應範例

200 回應

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "created_at": "2022-05-13 12:14:15",
        "expired_at": "2022-05-13 12:14:15",
        "product_type": 9,
        "trade_no": "2022051312134339861461465434",
        "order": {
          "created_at": "2022-05-13 12:13:43",
          "pay_at": "2022-05-13 12:13:43",
          "title": "入门级"
        }
      }
    ],
    "page": 1,
    "page_size": 20,
    "total_count": 0,
    "total_page": 0
  }
}

回應

狀態碼含義描述資料模型
200OK請求成Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegertrue無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringtrue無狀態訊息
» dataobjectfalse無none
»» list[object]false無none
»»» idintegerfalse無套餐編號
»»» created_atstringfalse無套餐生效時間
»»» expired_atstringfalse無套餐過期時間,過期後流量無法使用。
»»» product_typeproductTypesfalse無套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP
»»» trade_nostringfalse無訂單交易編號
»»» orderobjectfalse無none
»»»» created_atstringfalse無訂單創建時間
»»»» pay_atstringfalse無訂單支付時間
»»»» titlestringfalse無訂單描述
»» pageintegertrue無目前分頁
»» page_sizeintegerfalse無分頁大小
»» total_countintegerfalse無總記錄數量
»» total_pageintegerfalse無總分頁數量

列舉值

屬性值
product_type9
product_type11
product_type14
product_type25

用戶套餐數據匯總

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-product/summary

獲取用戶套餐的統計匯總信息，包括總量、有效量、臨期量、過期量等

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
app_keyquerystring(password)true認證金鑰
product_typequeryintegerfalse產品類型，僅支援 9（動態流量套餐）、12（長效IDC流量套餐）

列舉值

ParameterValue
product_type9
product_type12

回應範例

200 回應

{
  "code": 200,
  "msg": "成功",
  "data": {
    "total": 1048576,
    "total_count": 5,
    "effective": 524288,
    "effective_count": 3,
    "effective_total": 786432,
    "effective_used": 262144,
    "temporary": 102400,
    "temporary_count": 1,
    "expired": 51200,
    "expired_count": 1,
    "used": 473088
  }
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

Status Code 200

名稱類型必填限制描述
» codeintegerfalse無狀態碼,200 成功、3 app_key 無效、156 帳戶未實名認證
» msgstringfalse無狀態訊息
» dataobjectfalse無none
»» totalintegerfalse無流量/IP總量（單位：KB）
»» total_countintegerfalse無套餐總個數
»» effectiveintegerfalse無有效剩餘量（單位：KB）
»» effective_countintegerfalse無有效套餐數
»» effective_totalintegerfalse無有效總量（單位：KB）
»» effective_usedintegerfalse無有效已使用量（單位：KB）
»» temporaryintegerfalse無臨期總量（7天內到期，單位：KB）
»» temporary_countintegerfalse無臨期套餐個數（7天內到期）
»» expiredintegerfalse無過期剩餘量（單位：KB）
»» expired_countintegerfalse無過期套餐數
»» usedintegerfalse無已使用總量（單位：KB）

靜態 IP 列表

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/datacenter-isp-ip-list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/datacenter-isp-ip-list

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0,
  "page": 1,
  "size": 20,
  "user_product_id": 1,
  "country_code": "string",
  "product_type": 0,
  "ip": "192.168.0.1",
  "auto_renewal": 0,
  "support_renewal": 0,
  "remaining_days": 0,
  "limit_days": 0,
  "sort": "exp_asc",
  "remark": "string"
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» statusbodyintegerfalse無
» pagebodyintegerfalse無
» sizebodyintegerfalse無
» user_product_idbodyintegerfalse無
» country_codebodystringfalse無
» product_typebodyintegerfalse無
» ipbodystring(ipv4)false無
» auto_renewalbodyintegerfalse無
» support_renewalbodyintegerfalse無
» remaining_daysbodyintegerfalse無
» limit_daysbodyintegerfalse無
» sortbodystringfalse無
» remarkbodystringfalse無

列舉值

ParameterValue
» auto_renewal0
» auto_renewal1
» support_renewal0
» support_renewal1
» sortexp_asc
» sortexp_desc

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

刪除已過期套餐

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

大量刪除已過期套餐

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/batch-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/batch-delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ]
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idsbody[integer]true無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

修改套餐備註

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrue無
» remarkbodystringtrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

批次設定靜態 IP UDP 開關

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/set-ip-udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/set-ip-udp

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ],
  "udp": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idsbody[integer]true無
» udpbodyintegertrue無

列舉值

ParameterValue
» udp0
» udp1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

套餐管理

更換資料中心 ISP 靜態 IP

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/change-datacenter-isp-ip \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/change-datacenter-isp-ip

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» idbodyintegertrue用戶套餐 ID
» country_codebodystringfalse目標國家代碼；不傳時優先沿用目前 IP 國家/地區
» ipbodystringfalse目標 IP 前綴篩選

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

取得靜態 IP 更換記錄

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/user-product/ip-change-log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/user-product/ip-change-log

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse資源空間標識；個人空間省略或傳空字串
pagequeryintegerfalse無
page_sizequeryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "old": "string",
        "new": "string",
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 0,
    "page_count": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

設定單一套餐的自動續費開關

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "status": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idbodyintegertrue無
» statusbodyintegerfalse0=停用，1=啟用

列舉值

ParameterValue
» status0
» status1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

大量設定套餐自動續費開關

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/batch-set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/batch-set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "status": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idsbody[integer]true無
» statusbodyintegerfalse0=停用，1=啟用

列舉值

ParameterValue
» status0
» status1

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功；每個套餐獨立返回處理結果Inline

回應結構

設定產品類型的預設自動續費參數

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/set-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/set-auto-renewal-default-config

days_before_expire、traffic_threshold、renewal_cycle_days 至少傳一個；值為 0 表示重置對應配置。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» product_typebodyintegertrue無
» days_before_expirebodyintegerfalse無
» traffic_thresholdbodyintegerfalse單位 GB，僅 9/12/24 支持
» renewal_cycle_daysbodyintegerfalse僅 11/14/16/25 支持，且必須是當前在售產品週期
» anonymousbodyobjectfalse無
» anonymousbodyobjectfalse無
» anonymousbodyobjectfalse無

列舉值

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功，data 為 nullInline

回應結構

取得產品類型的預設自動續費參數

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/get-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/get-auto-renewal-default-config

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» product_typebodyintegerfalse不傳則回傳全部支援類型

列舉值

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": 9,
        "days_before_expire": 0,
        "source": "user",
        "renewal_cycle": {
          "days": 1,
          "unit": "day",
          "source": "user"
        },
        "traffic_threshold": 0,
        "traffic_source": "user"
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
product_type9
product_type11
product_type12
product_type14
product_type16
product_type24
product_type25
sourceuser
sourcesystem
sourceuser
sourcesystem
traffic_sourceuser
traffic_sourcesystem

取得單一套餐自動續費配置和續費預覽

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/get-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/get-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idbodyintegertrue無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "expired_at": "string",
    "time_days": 0,
    "time_unit": "day",
    "next_expired_at": "string",
    "agreed_price": 0,
    "currency": "string",
    "config": {
      "id": 1,
      "user_id": 1,
      "team_id": "A1b2C3d4E5f6",
      "team_user_id": 0,
      "product_type": 0,
      "left_traffic": 0,
      "left_days": 0,
      "user_product_id": 1,
      "product_id": 0,
      "status": 0,
      "currency": "string",
      "agreed_price": 0,
      "agreed_bandwidth_price": 0,
      "agreed_concurrency_price": 0,
      "bandwidth_id": 0,
      "concurrency_id": 0,
      "duration": 0,
      "renew_product_id": 0,
      "days_before_expire": 0,
      "traffic_threshold": 0,
      "parent_product_type": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "traffic_threshold": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
time_unitday
time_unithour
status0
status1

取得自動續費執行記錄

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/user-product/auto-renewal-logs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/user-product/auto-renewal-logs

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

參數

名稱位置類型必填描述
bodybodyobjectfalse無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» user_product_idbodyintegerfalse不傳則查詢目前空間全部記錄
» pagebodyintegerfalse無
» sizebodyintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "config_id": 0,
        "user_product_id": 1,
        "product_type": 0,
        "renew_product_id": 0,
        "order_id": 0,
        "fee": 0,
        "currency": "string",
        "before_expired_at": "string",
        "after_expired_at": "string",
        "before_remain": 0,
        "after_remain": 0,
        "trigger_type": 0,
        "status": 1,
        "revoke_at": "string",
        "revoke_remark": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_page": 0,
    "total_count": 0
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

列舉值

屬性值
trigger_type0
trigger_type1
status1
status2
status3

支付管理

拉起訂單支付

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/pay?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/pay

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
trade_noquerystringtrue無
pm_idqueryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

後台開單未支付訂單拉起支付

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/pay/index-choose \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/pay/index-choose

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

參數

名稱位置類型必填描述
bodybodyobjecttrue無
» team_idbodyanyfalse公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
»» anonymousbodystringfalse無
»» anonymousbodyTeamPublicIdfalse團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
» trade_nobodystringtrue無
» pay_methodbodyintegerfalse無
» pm_idbodyintegerfalse無
» trade_typebodystringfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK操作成功WebV1SuccessResponse

支付校驗和費用預覽

程式碼範例

# 也可以使用 wget
curl -X POST https://api.911proxy.com/api-gate-way/pay/pay-check?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api-gate-way/pay/pay-check

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
trade_noquerystringtrue無
pm_idqueryintegerfalse無

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "pm_id": 0,
    "pay_method": 0,
    "trade_type": "string",
    "country_code": "string",
    "currency": "string",
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0,
    "pay_method_info": {
      "id": 0,
      "type": 0,
      "title": "string",
      "group": "string",
      "handling_rate": 0,
      "handling_fee": 0,
      "handling_fee_currency": "usd",
      "handling_fee_converted": 0
    },
    "origin": {
      "pm_id": 0,
      "pay_method": 0,
      "goods_fee": 0,
      "discount_fee": 0,
      "handling_fee": 0,
      "pay_fee": 0,
      "total_fee": 0
    }
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK請求成功Inline

回應結構

直接渲染 Web 支付頁

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/pay/web-direct-pay?trade_no=string \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/pay/web-direct-pay

參數

名稱位置類型必填描述
team_idqueryResourceSpaceIdfalse無
trade_noquerystringtrue無
pm_idqueryintegerfalse無

回應範例

200 回應

"string"

回應

狀態碼含義描述資料模型
200OKHTML 付款頁string

取得付款方式列表 (GET /api-gate-way/payment/list)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/payment/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/payment/list

參數

名稱位置類型必填描述
trade_noquerystringfalse訂單號碼 - 部分訂單需要取得特定付款方式時可傳入
currencyquerystringfalse貨幣單位

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK獲取成功Inline

回應結構

取得付款方式列表 (GET /api-gate-way/payment/groups)

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/payment/groups

參數

名稱位置類型必填描述
trade_noquerystringfalse訂單號碼 - 部分訂單需要取得特定付款方式時可傳入

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          "string"
        ],
        "items": [
          {
            "id": 0,
            "title": "string",
            "logo": "string",
            "group": "string",
            "disabled": false,
            "min": 0,
            "max": 0
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OK獲取成功Inline

回應結構

行銷

儲值贈金比例

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/activity/balance-recharge-gift-ratio

儲值贈金比例

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      null
    ]
  },
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKOKInline

回應結構

產品

產品列表

程式碼範例

# 也可以使用 wget
curl -X GET https://api.911proxy.com/api-gate-way/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api-gate-way/product

取得目前網站可購買的套餐列表，支援按類型、有效期限等條件篩選。

參數

名稱位置類型必填描述
typequeryintegerfalse套餐類型，請參閱 Product.type 列舉說明。不傳則傳回所有類型。
parent_product_typequeryintegerfalse父套餐類型，僅 type=19（IP續費）時有效，用於篩選產品線：14=資料中心 25=住宅
time_daysqueryanyfalse有效期天數篩選，支援單值或數組，如 30 / [30,90,365]
show_typequeryanyfalse展示類型篩選，支援單值或數組

列舉值

ParameterValue
parent_product_type14
parent_product_type25

回應範例

200 回應

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          "string"
        ]
      },
      "sku": {
        "bandwidth_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "duration_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "concurrency_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ]
      }
    }
  ],
  "request_id": "string"
}

回應

狀態碼含義描述資料模型
200OKOKInline

回應結構

資料結構

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

屬性

名稱類型必填限制描述
idintegertrue無使用者 ID
usernamestringtrue無使用者名稱
nicknamestringtrue無暱稱
emailstringtrue無綁定信箱
balancestringtrue無儲值餘額，十進位字串
gift_balancestringtrue無當前贈送餘額，十進位字串
currencystringtrue無站點幣種
languagestringtrue無使用者語言，未設定時使用網站語言
timezonestringtrue無使用者時區，未配置時使用站點時區

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

屬性

名稱類型必填限制描述
idinteger,stringfalse無資料庫數值可能序列化為字串
re_typeinteger,stringfalse無0 支出，1 收入
transaction_typeinteger,stringfalse無交易類型
balance_typeinteger,stringfalse無餘額類型
feestring,numberfalse無變動金額，站點幣種

OpenApiLogExportTask

{
  "id": 0,
  "user_id": 0,
  "start_time": "string",
  "end_time": "string",
  "status": "pending",
  "file_size": 0,
  "record_count": 0,
  "created_at": "string",
  "completed_at": "string",
  "file_url": "string",
  "download_url": "string",
  "error_message": "string"
}

屬性

名稱類型必填限制描述
idinteger,stringfalse無資料庫數值可能序列化為字串
user_idinteger,stringfalse無詳情介面返回
start_timestringfalse無Y-m-d H:i:s；非 RFC 3339 日期
end_timestringfalse無Y-m-d H:i:s；非 RFC 3339 日期
statusstringfalse無none
file_sizeinteger,string,nullfalse無none
record_countinteger,string,nullfalse無none
created_atstringfalse無Y-m-d H:i:s；非 RFC 3339 日期
completed_atstringfalse無Y-m-d H:i:s；非 RFC 3339 日期
file_urlstringfalse無完成後詳情介面返回
download_urlstringfalse無完成後返回，有效期 24 小時的簽名下載地址
error_messagestringfalse無失敗時詳情介面可能返回

列舉值

屬性值
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

OpenApiCoupon

{
  "id": 0,
  "coupon_id": 0,
  "type": 0,
  "status": 0,
  "source": 0,
  "title": "string",
  "title_en": "string",
  "description": "string",
  "description_en": "string",
  "start_amount": "string",
  "start_amount_usd": "string",
  "start_amount_hkd": "string",
  "deduction_amount": "string",
  "deduction_amount_usd": "string",
  "deduction_amount_hkd": "string",
  "discount_rate": "string",
  "discount_ceiling_amount": "string",
  "discount_ceiling_amount_usd": "string",
  "discount_ceiling_amount_hkd": "string",
  "created_at": "string",
  "effect_at": "string",
  "expired_at": "string",
  "used_at": "string",
  "product_types": "string",
  "created_timestamp": 0,
  "effect_timestamp": 0,
  "expired_timestamp": 0,
  "used_timestamp": 0,
  "is_expired": true
}

屬性

名稱類型必填限制描述
idinteger,stringfalse無資料庫數值可能序列化為字串
coupon_idinteger,stringfalse無資料庫數值可能序列化為字串
typeinteger,stringfalse無資料庫數值可能序列化為字串
statusinteger,stringfalse無資料庫數值可能序列化為字串
sourceinteger,stringfalse無資料庫數值可能序列化為字串
titlestringfalse無none
title_enstringfalse無none
descriptionstringfalse無none
description_enstringfalse無none
start_amountstring,number,nullfalse無none
start_amount_usdstring,number,nullfalse無none
start_amount_hkdstring,number,nullfalse無none
deduction_amountstring,number,nullfalse無none
deduction_amount_usdstring,number,nullfalse無none
deduction_amount_hkdstring,number,nullfalse無none
discount_ratestring,number,nullfalse無none
discount_ceiling_amountstring,number,nullfalse無none
discount_ceiling_amount_usdstring,number,nullfalse無none
discount_ceiling_amount_hkdstring,number,nullfalse無none
created_atstring,nullfalse無Y-m-d H:i:s
effect_atstring,nullfalse無Y-m-d H:i:s
expired_atstring,nullfalse無Y-m-d H:i:s
used_atstring,nullfalse無Y-m-d H:i:s
product_typesstring,nullfalse無適用套餐類型
created_timestampinteger,nullfalse無none
effect_timestampinteger,nullfalse無none
expired_timestampinteger,nullfalse無none
used_timestampinteger,nullfalse無none
is_expiredbooleanfalse無列表介面返回

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

屬性

名稱類型必填限制描述
idinteger,stringfalse無資料庫數值可能序列化為字串
titlestringfalse無none
contentstringfalse無按請求語言渲染的內容
typeinteger,stringfalse無資料庫數值可能序列化為字串
read_statusintegerfalse無none
created_atstringfalse無Y-m-d H:i:s；非 RFC 3339 日期
created_timestampintegerfalse無none

列舉值

屬性值
read_status0
read_status1

productTypes

9

套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP

屬性

名稱類型必填限制描述
anonymousintegerfalse無套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態資料中心IP、25 靜態住宅IP

列舉值

屬性值
anonymous9
anonymous11
anonymous14
anonymous25

apiKey

"pa$$word"

API Key；使用 apiKeyAuth 或操作聲明的請求參數傳遞

屬性

名稱類型必填限制描述
anonymousstring(password)false無API Key；使用 apiKeyAuth 或操作聲明的請求參數傳遞

responseCode

200

狀態碼,200 成功、3 app_key 無效

屬性

名稱類型必填限制描述
anonymousintegerfalse無狀態碼,200 成功、3 app_key 無效

responseMsg

"success"

response message

屬性

名稱類型必填限制描述
anonymousstringfalse無response message

SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

屬性

None

ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

屬性

None

WebV1SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

屬性

名稱類型必填限制描述
codeintegertrue無none
msgstringtrue無none
dataobject,array,string,number,boolean,nulltrue無業務數據，具體類型由介面定義
request_idstringtrue無請求鏈路追蹤 ID

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

屬性

名稱類型必填限制描述
codeintegertrue無業務錯誤碼

not

名稱類型必填限制描述
» anonymousanyfalse無none

continued

名稱類型必填限制描述
msgstringtrue無錯誤描述
dataobject,array,nulltrue無錯誤附加數據，無附加數據時為 null
request_idstringtrue無請求鏈路追蹤 ID

TeamPublicId

"A1b2C3d4E5f6"

團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

屬性

名稱類型必填限制描述
anonymousstringfalse無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

ResourceSpaceId

"A1b2C3d4E5f6"

公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識

屬性

oneOf

名稱類型必填限制描述
anonymousstringfalse無none

xor

名稱類型必填限制描述
anonymousTeamPublicIdfalse無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵

Team

{
  "id": "A1b2C3d4E5f6",
  "name": "string",
  "super_admin_user_id": 1,
  "status": 0,
  "current_role": 1,
  "dissolving_at": "string",
  "dissolved_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

屬性

名稱類型必填限制描述
idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
namestringtrue無團隊名稱
super_admin_user_idintegertrue無超級管理員用戶 ID
statusintegertrue無團隊狀態：0=禁用，1=有效，2=解散中，3=已解散
current_roleinteger,nulltrue無當前使用者在團隊中的角色；無法確定時為 null
dissolving_atstring,nulltrue無開始解散時間
dissolved_atstring,nulltrue無解散完成時間
created_atstringtrue無創建時間
updated_atstringtrue無更新時間

列舉值

屬性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

TeamAsset

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "status": 0,
  "total_amount": 0,
  "remain": 0,
  "bandwidth": 0,
  "concurrency": 0,
  "expired_at": "string",
  "created_at": "string",
  "ip": "string",
  "country_code": "string",
  "country_name": "string",
  "asn": "string",
  "port": 0
}

屬性

名稱類型必填限制描述
idintegertrue無用戶套餐 ID
user_idintegertrue無資源所有人使用者 ID
team_idResourceSpaceIdtrue無公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
team_user_idintegertrue無實際建立成員使用者 ID
product_idintegertrue無產品 ID
product_typeintegertrue無產品類型
parent_product_typeintegertrue無父產品類型
statusintegertrue無套餐狀態
total_amountinteger(int64)true無總量
remaininteger(int64)true無剩餘量
bandwidthintegerfalse無頻寬（Mbps）；僅 product_type=19 或 11 返回
concurrencyintegerfalse無並發數；僅 product_type=11 返回
expired_atstring,nulltrue無過期時間
created_atstringtrue無創建時間
ipstringfalse無靜態 IP 位址；僅 product_type=19 返回
country_codestringfalse無靜態 IP 國家代碼；僅 product_type=19 返回
country_namestringfalse無靜態 IP 國家名稱；僅 product_type=19 傳回
asnstringfalse無靜態 IP ASN；僅 product_type=19 返回
portintegerfalse無靜態 IP 代理埠；僅 product_type=19 返回

TeamProductInfo

{
  "team_id": "A1b2C3d4E5f6",
  "product_types": [
    0
  ],
  "product_residence_remain_count": 0,
  "product_residence_total_count": 0,
  "pdrue2_timestamp": 0,
  "remain": 0,
  "total_amount": 0,
  "scraping_remain": 0,
  "scraping_total_amount": 0,
  "scraping_timestamp": "string",
  "scraping_timestamp2": 0,
  "common_scraping_remain": 0,
  "common_scraping_total_amount": 0,
  "common_scraping_timestamp": "string",
  "common_scraping_timestamp2": 0,
  "pdidcr_count": 0,
  "pdidcr_total": 0,
  "pdidcr_traffic_remain": 0,
  "pdidcr_traffic_total": 0,
  "p_sitai_ip_count": 0,
  "p_sitai_ip": 0,
  "p_sitai_ip_total": 0,
  "p_sitai_remain": 0,
  "p_sitai_total": 0,
  "pdidc_count": 0,
  "pdidc_total": 0,
  "pdidc_ip_count": 0,
  "pdidc_ip_all_count": 0,
  "pdispr_count": 0,
  "pdispr_total": 0,
  "pdispr_traffic_remain": 0,
  "pdispr_traffic_total": 0,
  "product_datacenter_isp_traffic_ip_count": 0,
  "product_datacenter_isp_traffc_ip": 0,
  "product_datacenter_isp_traffc_ip_total": 0,
  "product_datacenter_isp_traffic_ip": 0,
  "product_datacenter_isp_traffic_ip_total": 0,
  "product_datacenter_isp_traffc_remain": 0,
  "product_datacenter_isp_traffc_total": 0,
  "product_datacenter_isp_traffic_remain": 0,
  "product_datacenter_isp_traffic_total": 0,
  "product_datacenter_isp_ip": 0,
  "product_datacenter_isp_ip_total": 0,
  "product_datacenter_isp_ip_count": 0,
  "product_datacenter_isp_ip_all_count": 0,
  "product_datacenter_isp_ip_traffic_remain": 0,
  "product_datacenter_isp_ip_traffic_total": 0,
  "product_agent_residence_remain_count": 0,
  "product_agent_residence_total_count": 0,
  "product_serp_remain": 0,
  "product_serp_total": 0,
  "product_serp_timestamp": "string",
  "product_serp_timestamp2": 0,
  "product_video_remain": 0,
  "product_video_total": 0,
  "product_video_timestamp": "string",
  "product_video_timestamp2": 0
}

套餐統計欄位與 /web_v1/user/info 保持一致；取消、退款或軟刪除記錄不計入摘要；除 team_id、product_types 外，僅傳回目前網站支援產品類型對應的字段

屬性

名稱類型必填限制描述
team_idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
product_types[integer]true無團隊資源空間未取消、未軟體刪除且目前網站支援的套餐類型
product_residence_remain_countinteger(int64)false無類型 9 剩餘流量
product_residence_total_countinteger(int64)false無類型 9 總流量
pdrue2_timestampinteger(int64)false無類型 11 最晚過期時間戳記；無團隊套餐時為 0
remaininteger,stringfalse無類型 17 剩餘數量
total_amountinteger,stringfalse無類型 17 總數量
scraping_remaininteger(int64)false無類型 18 剩餘次數
scraping_total_amountinteger(int64)false無類型 18 總次數
scraping_timestampstringfalse無類型 18 最晚過期時間；無套餐時為 "-"
scraping_timestamp2integer(int64)false無類型 18 最晚過期時間戳
common_scraping_remaininteger(int64)false無類型 29 剩餘次數
common_scraping_total_amountinteger(int64)false無類型 29 總次數
common_scraping_timestampstringfalse無類型 29 最晚過期時間；無套餐時為 "-"
common_scraping_timestamp2integer(int64)false無類型 29 最晚過期時間戳
pdidcr_countintegerfalse無類型 12 有效套餐數量
pdidcr_totalintegerfalse無類型 12 套餐總數
pdidcr_traffic_remaininteger(int64)false無類型 12 剩餘流量
pdidcr_traffic_totalinteger(int64)false無類型 12 總流量
p_sitai_ip_countintegerfalse無類型 13 有效 IP 數量
p_sitai_ipintegerfalse無類型 13 有效套餐數量
p_sitai_ip_totalintegerfalse無類型 13 套餐總數
p_sitai_remaininteger(int64)false無類型 13/24 剩餘流量
p_sitai_totalinteger(int64)false無類型 13/24 總流量
pdidc_countintegerfalse無類型 14 有效套餐數量
pdidc_totalintegerfalse無類型 14 套餐總數
pdidc_ip_countintegerfalse無類型 14 有效 IP 數量
pdidc_ip_all_countintegerfalse無類型 14 IP 總數
pdispr_countintegerfalse無類型 15 有效套餐數量
pdispr_totalintegerfalse無類型 15 套餐總數
pdispr_traffic_remaininteger(int64)false無類型 15 剩餘流量
pdispr_traffic_totalinteger(int64)false無類型 15 總流量
product_datacenter_isp_traffic_ip_countintegerfalse無類型 16 有效 IP 數量
product_datacenter_isp_traffc_ipintegerfalse無類型 16 有效套餐數量；歷史相容拼字
product_datacenter_isp_traffc_ip_totalintegerfalse無類型 16 套餐總數；歷史相容拼寫
product_datacenter_isp_traffic_ipintegerfalse無類型 16 有效套餐數量
product_datacenter_isp_traffic_ip_totalintegerfalse無類型 16 套餐總數
product_datacenter_isp_traffc_remaininteger(int64)false無類型 16/24 剩餘流量；歷史相容拼字
product_datacenter_isp_traffc_totalinteger(int64)false無類型 16/24 總流量；歷史相容拼字
product_datacenter_isp_traffic_remaininteger(int64)false無類型 16/24 剩餘流量
product_datacenter_isp_traffic_totalinteger(int64)false無類型 16/24 總流量
product_datacenter_isp_ipintegerfalse無類型 21 或 25 有效套餐數量
product_datacenter_isp_ip_totalintegerfalse無類型 21 或 25 套餐總數
product_datacenter_isp_ip_countintegerfalse無類型 21 或 25 有效 IP 數量
product_datacenter_isp_ip_all_countintegerfalse無類型 21 或 25 IP 總數
product_datacenter_isp_ip_traffic_remaininteger(int64)false無類型 21 對應類型 24 剩餘流量
product_datacenter_isp_ip_traffic_totalinteger(int64)false無類型 21 對應類型 24 總流量
product_agent_residence_remain_countinteger(int64)false無類型 22 剩餘流量
product_agent_residence_total_countinteger(int64)false無類型 22 總流量
product_serp_remaininteger(int64)false無類型 27 剩餘次數
product_serp_totalinteger(int64)false無類型 27 總次數
product_serp_timestampstringfalse無類型 27 最晚過期時間；無套餐時為 "-"
product_serp_timestamp2integer(int64)false無類型 27 最晚過期時間戳
product_video_remaininteger(int64)false無類型 28 剩餘流量
product_video_totalinteger(int64)false無類型 28 總流量
product_video_timestampstringfalse無類型 28 最晚過期時間；無套餐時為 "-"
product_video_timestamp2integer(int64)false無類型 28 最晚過期時間戳

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

團隊錢包，與超級管理員個人餘額隔離；金額使用目前網站預設貨幣，最多 4 位小數。

屬性

名稱類型必填限制描述
team_idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
balancenumber(double)true無目前可用團隊餘額
total_recharge_feenumber(double)true無目前未消費的團隊儲值本金，不含個人餘額轉入金額
updated_atstringtrue無錢包最近變更時間

TeamWalletRecord

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "operator_user_id": 0,
  "creator": {
    "user_id": 0,
    "display_name": "string",
    "nickname": "string",
    "username": "string",
    "email": "string",
    "phone": "string"
  },
  "direction": 0,
  "transaction_type": 1,
  "amount": 0.1,
  "after_balance": 0.1,
  "link_id": 0,
  "request_id": "string",
  "remark": "string",
  "created_at": "string"
}

屬性

名稱類型必填限制描述
idintegertrue無none
team_idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
operator_user_idintegertrue無操作人，系統退款為 0
creatorTeamCreatorfalse無none
directionintegertrue無0=支出，1=收入
transaction_typeintegertrue無1=充值入賬，2=個人餘額轉入，3=餘額消費，4=退款或儲值退款扣回，5=轉回個人餘額
amountnumber(double)true無本次變動金額，方向由 direction 表示
after_balancenumber(double)true無變動後的團隊錢包餘額
link_idintegertrue無關聯訂單 ID；個人餘額轉入時為操作使用者 ID
request_idstringtrue無none
remarkstringtrue無none
created_atstringtrue無none

列舉值

屬性值
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

屬性

名稱類型必填限制描述
user_idintegertrue無操作人使用者 ID；系統操作為 0
display_namestringtrue無展示名稱，依序取暱稱、使用者名稱、信箱、手機號
nicknamestringtrue無none
usernamestringtrue無none
emailstringtrue無非管理員視角為脫敏值
phonestringtrue無非管理員視角為脫敏值

TeamResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataTeamfalse無none

TeamListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» list[Team]true無none
»» totalintegertrue無none
»» pageintegertrue無none
»» page_sizeintegertrue無none

TeamMemberListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» list[TeamMember]true無none
»» totalintegertrue無none
»» pageintegertrue無none
»» page_sizeintegertrue無none

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» list[TeamPerson]true無none
»» totalintegertrue無none
»» pageintegertrue無none
»» page_sizeintegertrue無none

TeamAssetResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataTeamAssetfalse無none

TeamProductInfoResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataTeamProductInfofalse無套餐統計欄位與 /web_v1/user/info 保持一致；取消、退款或軟刪除記錄不計入摘要；除 team_id、product_types 外，僅傳回目前網站支援產品類型對應的字段

TeamWalletResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataTeamWalletfalse無團隊錢包，與超級管理員個人餘額隔離；金額使用目前網站預設貨幣，最多 4 位小數。

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» list[TeamWalletRecord]true無none
»» totalintegertrue無none
»» pageintegertrue無none
»» page_sizeintegertrue無none

TeamAssetListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» list[TeamAsset]true無none
»» totalintegertrue無none
»» pageintegertrue無none
»» page_sizeintegertrue無none

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

屬性

名稱類型必填限制描述
idintegertrue無API Key ID
api_keystringtrue無建立響應為完整 Key；團隊清單中為脫敏值
team_user_idintegertrue無團隊 Key 實際持有成員 ID，個人 Key 為 0
remarkstringtrue無備註
statusintegertrue無0=停用，1=啟用
created_atstringtrue無創建時間
updated_atstring,nullfalse無更新時間

列舉值

屬性值
status0
status1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true
}

屬性

名稱類型必填限制描述
invoice_codestringfalse無none
namestringfalse無none
org_namestringfalse無none
first_namestringfalse無none
last_namestringfalse無none
phonestringfalse無none
emailstring(email)false無none
role_typeintegerfalse無none
invoice_typeintegerfalse無none
vat_idstringfalse無none
tax_nostringfalse無none
address_countrystringfalse無none
address_citystringfalse無none
address_line1stringfalse無none
address_line2stringfalse無none
address_postal_codestringfalse無none
bank_namestringfalse無none
bank_accountstringfalse無none
is_defbooleanfalse無none

列舉值

屬性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

MonthlyRenewalRequest

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

屬性

名稱類型必填限制描述
team_idResourceSpaceIdfalse無公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
user_product_idsanytrue無使用者套餐 ID 數組，也相容於英文逗號分隔字串

oneOf

名稱類型必填限制描述
» anonymous[integer]false無none

xor

名稱類型必填限制描述
» anonymousstringfalse無none

continued

名稱類型必填限制描述
user_coupon_idintegerfalse無none
coupon_snstringfalse無none

TeamInvitation

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "inviter_user_id": 1,
  "invitee_user_id": 0,
  "invite_type": 1,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 1,
  "role": 2,
  "status": 0,
  "accepted_by_user_id": 0,
  "expired_at": "2026-07-17 10:00:00",
  "accepted_at": null,
  "rejected_at": null,
  "cancelled_at": null,
  "created_at": "2026-07-10 10:00:00"
}

屬性

名稱類型必填限制描述
idintegertrue無邀請 ID
team_idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
inviter_user_idintegertrue無邀請人用戶 ID
invitee_user_idintegertrue無受邀用戶 ID，尚未比對註冊用戶時為 0
invite_typeintegertrue無邀請類型：1=已註冊用戶，2=信箱，3=手機號
invite_country_codeintegertrue無手機號國家或地區碼，非手機號邀請為 0
invite_targetstringtrue無標準化後的邀請目標；已註冊使用者為 user:{user_id}
delivery_typeintegertrue無原始投遞管道：1=已註冊用戶，2=郵箱，3=手機號碼；郵箱或手機號碼匹配到已註冊用戶時仍保留原始頻道
roleintegertrue無目標角色：2=管理員，3=普通成員
statusintegertrue無邀請狀態：0=待處理，1=已接受，2=已拒絕，3=已取消，4=過期
accepted_by_user_idintegertrue無接受人用戶 ID，未接受時為 0
expired_atstringtrue無過期時間，格式 YYYY-MM-DD HH:mm:ss
accepted_atstring,nulltrue無接受時間
rejected_atstring,nulltrue無拒絕時間
cancelled_atstring,nulltrue無取消時間
created_atstringtrue無建立時間，格式 YYYY-MM-DD HH:mm:ss

列舉值

屬性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

屬性

名稱類型必填限制描述
team_member_idintegertrue無會員關係 ID
team_idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
user_idintegertrue無成員用戶 ID
roleintegertrue無角色：1=超級管理員，2=管理員，3=普通成員，4=財務成員
statusintegertrue無成員狀態：0=停用，1=有效，2=已退出，3=已移除
joined_atstring,nulltrue無加入時間，格式 YYYY-MM-DD HH:mm:ss
nicknamestringtrue無成員暱稱
usernamestringtrue無會員使用者名稱

列舉值

屬性值
role1
role2
role3
role4
status0
status1
status2
status3

TeamPerson

{
  "record_type": "member",
  "record_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 0,
  "inviter_user_id": 0,
  "invite_type": 0,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 0,
  "role": 1,
  "status": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "joined_at": "string",
  "expired_at": "string",
  "created_at": "string"
}

屬性

名稱類型必填限制描述
record_typestringtrue無記錄類型；member 為有效成員，invitation 為待處理邀請
record_idintegertrue無會員關係 ID 或邀請 ID
team_idTeamPublicIdtrue無團隊公開標識，首字為 ASCII 字母，其餘字元僅包含 ASCII 字母和數字；不下發資料庫數字主鍵
user_idintegertrue無用戶 ID，未註冊受邀用戶為 0
inviter_user_idintegertrue無邀請人使用者 ID，成員記錄為 0
invite_typeintegertrue無邀請類型，成員記錄為 0
invite_country_codeintegertrue無手機號國家或地區碼，會員記錄為 0
invite_targetstringtrue無邀請目標，成員記錄為空字串
delivery_typeintegertrue無原始投遞管道，成員記錄為 0
roleintegertrue無角色：1=超級管理員，2=管理員，3=普通成員，4=財務成員
statusintegertrue無member 固定為 1，invitation 固定為 0
display_namestringtrue無統一展示名稱，依序取暱稱、使用者名稱、信箱、手機號；一般成員視角下聯絡方式使用脫敏值
nicknamestringtrue無成員或已註冊受邀用戶暱稱
usernamestringtrue無會員或已註冊受邀用戶名
emailstringtrue無郵箱；超級管理員和管理員傳回完整值，普通成員傳回帶有星號的脫敏值
phonestringtrue無手機號碼；超級管理員和管理員返回完整值，普通成員返回帶有星號的脫敏值
joined_atstring,nulltrue無成員加入時間，邀請記錄為 null
expired_atstring,nulltrue無邀請過期時間，成員記錄為 null
created_atstringtrue無記錄建立時間，格式 YYYY-MM-DD HH:mm:ss

列舉值

屬性值
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

TeamInvitationResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataTeamInvitationfalse無none

TeamMemberResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataTeamMemberfalse無none

TeamInvitationCreateResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» invitationTeamInvitationtrue無none
»» invitation_tokenstringtrue無明文邀請令牌，僅為相容既有客戶端保留；新客戶端直接使用 invitation_url
»» invitation_urlstring(uri)true無包含邀請令牌的前端處理鏈接
»» notification_channelsTeamInvitationNotificationChannelstrue無none

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

屬性

名稱類型必填限制描述
emailstringfalse無郵件頻道結果
smsstringfalse無簡訊管道結果
site_inner_messagestringfalse無站內信通路結果

列舉值

屬性值
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

TeamInvitationPreviewResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» team_namestringtrue無團隊名稱
»» roleintegertrue無目標角色
»» statusintegertrue無邀請狀態
»» expired_atstringtrue無過期時間，格式 YYYY-MM-DD HH:mm:ss

列舉值

屬性值
role2
role3
status0
status1
status2
status3
status4

TeamInvitationResendResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» invitationTeamInvitationtrue無none
»» invitation_urlstring(uri)true無新的邀請處理連結；舊連結已失效
»» notification_channelsTeamInvitationNotificationChannelstrue無none

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

屬性

allOf

名稱類型必填限制描述
anonymousWebV1SuccessResponsefalse無none

and

名稱類型必填限制描述
anonymousobjectfalse無none
» dataobjectfalse無none
»» list[TeamInvitation]true無none
»» totalintegertrue無邀請總數
»» pageintegertrue無目前頁碼
»» page_sizeintegertrue無實際每頁數量

User

{
  "id": 0,
  "email": "[email protected]",
  "phone": "string",
  "balance": 0.1,
  "status": 0,
  "is_real_name": true,
  "created_at": "2019-08-24T14:15:22Z"
}

屬性

名稱類型必填限制描述
idintegerfalse無none
emailstring(email)false無none
phonestringfalse無none
balancenumber(float)false無none
statusintegerfalse無none
is_real_namebooleanfalse無none
created_atstring(date-time)false無none

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

屬性

名稱類型必填限制描述
idintegerfalse無訂單ID
trade_nostringfalse無內部訂單編號
out_trade_nostringfalse無外部訂單編號
product_idintegerfalse無套餐ID
product_typeintegerfalse無套餐類型，見產品類型枚舉
amountintegerfalse無購買數量
unit_pricenumber(float)false無單價
total_feenumber(float)false無訂單總價（不含折扣，含手續費）
goods_feenumber(float)false無商品價格（含折扣，不含手續費）
pay_feenumber(float)false無實付金額（含折扣，含手續費）
discount_feenumber(float)false無優惠金額
handling_feenumber(float)false無手續費
refund_feenumber(float)false無退款金額
pm_idintegerfalse無支付方式ID（來自 /openapi/payment/list）
pm_titlestringfalse無付款方式名稱
pm_logostringfalse無付款方式Logo URL
statusintegerfalse無訂單狀態
titlestringfalse無套餐標題
detailstringfalse無套餐描述
region_descstringfalse無地區規格描述
pay_atstring(date-time)false無支付時間
pay_timestampintegerfalse無支付時間戳
created_atstring(date-time)false無創建時間
pay_fee_statusintegerfalse無長短款狀態：0正常 1長款（超額支付） 2短款
invoiceobjectfalse無發票資訊（僅線上支付訂單有值）
» namestringfalse無全名
» org_namestringfalse無企業名稱
» first_namestringfalse無none
» last_namestringfalse無none
» phonestringfalse無none
» emailstring(email)false無none
» role_typeintegerfalse無1個人 2企業
» vat_idstringfalse無稅號
» address_countrystringfalse無none
» address_citystringfalse無none
» address_line1stringfalse無none
» address_line2stringfalse無none
» address_postal_codestringfalse無none

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

訂單預檢結果

屬性

名稱類型必填限制描述
product_idintegerfalse無套餐ID
amountintegerfalse無數量
discount_feenumber(float)false無優惠金額
total_feenumber(float)false無訂單總額
pay_feenumber(float)false無實付金額
product_typeintegerfalse無套餐類型
titlestringfalse無套餐標題
detailstringfalse無套餐描述
ip_result[object]false無IP批量續費結果（僅IP續費時返回）
» ipstringfalse無none
» pricenumber(float)false無none
» country_codestringfalse無none
» current_timestring(date-time)false無none
» renewal_timestring(date-time)false無none
» countryobjectfalse無none
»» name_zh_cnstringfalse無none
»» flagstringfalse無圓形旗幟URL
»» square_flagstringfalse無方形旗幟URL

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

屬性

名稱類型必填限制描述
idintegerfalse無套餐ID
titlestringfalse無套餐主標題
typeintegerfalse無套餐類型
show_typeintegerfalse無展示類型：1普通 2大推薦 3不可購買（需客製化） 4試用
statusintegerfalse無狀態：1上架 0下架
pricenumber(float)false無人民幣價格
usd_pricenumber(float)false無美元價格
price_hkdnumber(float)false無港幣價格
original_pricenumber(float)false無原價（CNY）
original_usd_pricenumber(float)false無原價（USD）
original_price_hkdnumber(float)false無原價（HKD）
local_pricenumber(float)false無在地化價格（依賴 preferred_currency）
local_original_pricenumber(float)false無在地化原價（依賴 preferred_currency）
preferred_currencystringfalse無建議顯示貨幣，如 usd / cny / hkd
support_currenciesstringfalse無支援的貨幣列表，逗號分隔，如 usd,cny
flow_valuenumber(float)false無流量套餐預設流量（GB）
flow_givenumber(float)false無送禮流量（GB）
balance_givenumber(float)false無餘額儲值送額
balance_valuenumber(float)false無儲值金額
time_validitynumber(float)false無包量套餐預設有效時長
time_pricenumber(float)false無包量套餐每IP價格
time_daysintegerfalse無有效期限天數，如 30/90/180/365
tip1stringfalse無標籤說明1
tip2stringfalse無標籤說明2
introduce[string]false無文字介紹列表
region_list_idintegerfalse無地區ID
renew_product_liststringfalse無可續訂套餐ID清單（逗號分隔）
parent_product_typeintegerfalse無父套餐類型（type=19時有效）：14或25
total_countintegerfalse無總庫存，0表示不限制
remain_countintegerfalse無剩餘庫存
extension_of_time_days[integer]false無時長倍數列表，為空或僅含1表示不支持
time_days_price_ratenumber(float)false無時長價格係數，價格 × (1 + (倍數-1) × rate)
descobjectfalse無套餐描述訊息
» subtitlestringfalse無副標題
» flow_valuenumber(float)false無none
» flow_givenumber(float)false無none
» balance_givenumber(float)false無none
» time_validitynumber(float)false無none
» time_pricenumber(float)false無none
» tip1stringfalse無none
» tip2stringfalse無none
» introduce[string]false無none
skuobjectfalse無規格參數（type=11時返回）
» bandwidth_list[object]false無頻寬規格列表
»» idintegerfalse無none
»» valueintegerfalse無頻寬值（Mbps）
»» pricenumber(float)false無none
»» price_usdnumber(float)false無none
»» price_hkdnumber(float)false無none
» duration_list[object]false無時長規格列表
»» idintegerfalse無none
»» valueintegerfalse無時長（天）
»» pricenumber(float)false無none
»» price_usdnumber(float)false無none
»» price_hkdnumber(float)false無none
» concurrency_list[object]false無並發規格列表
»» idintegerfalse無none
»» valueintegerfalse無並發數
»» pricenumber(float)false無none
»» price_usdnumber(float)false無none
»» price_hkdnumber(float)false無none

WhiteIp

{
  "id": 0,
  "ip": "string",
  "remark": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

屬性

名稱類型必填限制描述
idintegerfalse無none
ipstringfalse無none
remarkstringfalse無none
created_atstring(date-time)false無none

WhitelistAccount

{
  "id": 0,
  "username": "string",
  "limit": 0,
  "used": 0,
  "status": 0
}

屬性

名稱類型必填限制描述
idintegerfalse無none
usernamestringfalse無none
limitintegerfalse無none
usedintegerfalse無none
statusintegerfalse無none

Coupon

{
  "id": 0,
  "name": "string",
  "code": "string",
  "discount": 0.1,
  "expire_time": "2019-08-24T14:15:22Z"
}

屬性

名稱類型必填限制描述
idintegerfalse無none
namestringfalse無none
codestringfalse無none
discountnumber(float)false無none
expire_timestring(date-time)false無none

Article

{
  "id": 0,
  "title": "string",
  "content": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

屬性

名稱類型必填限制描述
idintegerfalse無none
titlestringfalse無none
contentstringfalse無none
created_atstring(date-time)false無none

Pagination

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

屬性

名稱類型必填限制描述
totalintegerfalse無none
page_nointegerfalse無none
page_sizeintegerfalse無none
total_pagesintegerfalse無none

AutoRenewalConfig

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_type": 0,
  "left_traffic": 0,
  "left_days": 0,
  "user_product_id": 1,
  "product_id": 0,
  "status": 0,
  "currency": "string",
  "agreed_price": 0,
  "agreed_bandwidth_price": 0,
  "agreed_concurrency_price": 0,
  "bandwidth_id": 0,
  "concurrency_id": 0,
  "duration": 0,
  "renew_product_id": 0,
  "days_before_expire": 0,
  "traffic_threshold": 0,
  "parent_product_type": 0,
  "created_at": "string",
  "updated_at": "string"
}

單一套餐的自動續費配置快照

屬性

名稱類型必填限制描述
idintegerfalse無none
user_idintegerfalse無none
team_idResourceSpaceIdfalse無公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
team_user_idintegerfalse無none
product_typeintegerfalse無none
left_trafficintegerfalse無已廢棄字段
left_daysintegerfalse無已廢棄字段
user_product_idintegerfalse無none
product_idintegerfalse無已廢棄字段
statusintegerfalse無0=停用，1=啟用
currencystringfalse無none
agreed_pricenumberfalse無約定總價
agreed_bandwidth_pricenumberfalse無套餐 11 的約定頻寬單價
agreed_concurrency_pricenumberfalse無套餐 11 的約定並發單價
bandwidth_idintegerfalse無none
concurrency_idintegerfalse無none
durationintegerfalse無續費時長，單位天
renew_product_idintegerfalse無none
days_before_expireintegerfalse無none
traffic_thresholdintegerfalse無流量閾值，資料庫值單位 KB
parent_product_typeintegerfalse無none
created_atstringfalse無none
updated_atstringfalse無none

列舉值

屬性值
status0
status1

AutoRenewalLog

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "config_id": 0,
  "user_product_id": 1,
  "product_type": 0,
  "renew_product_id": 0,
  "order_id": 0,
  "fee": 0,
  "currency": "string",
  "before_expired_at": "string",
  "after_expired_at": "string",
  "before_remain": 0,
  "after_remain": 0,
  "trigger_type": 0,
  "status": 1,
  "revoke_at": "string",
  "revoke_remark": "string",
  "created_at": "string",
  "updated_at": "string"
}

屬性

名稱類型必填限制描述
idintegertrue無none
user_idintegertrue無none
team_idResourceSpaceIdtrue無公開資源空間標識；請求個人空間時省略 team_id 或傳空字串，回應個人空間時為空字串；數字 0 和字串 "0" 均非法，團隊空間使用 6-12 位元團隊公開標識
team_user_idintegertrue無none
config_idintegertrue無none
user_product_idintegertrue無none
product_typeintegertrue無none
renew_product_idintegertrue無none
order_idintegertrue無none
feenumbertrue無none
currencystringtrue無none
before_expired_atstring,nullfalse無none
after_expired_atstring,nullfalse無none
before_remaininteger(int64)true無none
after_remaininteger(int64)true無none
trigger_typeintegertrue無0=到期前，1=流量不足
statusintegertrue無1=成功，2=已撤銷，3=失敗
revoke_atstring,nullfalse無none
revoke_remarkstringtrue無none
created_atstringtrue無none
updated_atstringtrue無none

列舉值

屬性值
trigger_type0
trigger_type1
status1
status2
status3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

屬性

名稱類型必填限制描述
typestringtrue無none
start_atstringtrue無none
end_atstringtrue無none
target_expired_atstringtrue無none
timezonestringtrue無none

列舉值

屬性值
typecurrent
typenext

MonthlyRenewalItem

{
  "id": 0,
  "user_product_id": 1,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "title": "string",
  "expired_at": "string",
  "target_expired_at": "string",
  "renew_days": 1,
  "unit_month_price": 0,
  "pay_fee": 0,
  "currency": "string",
  "bandwidth": 0,
  "bandwidth_mbsp": 0,
  "concurrency": 0,
  "ip": "string",
  "country_code": "string",
  "paid_at": "string",
  "refunded_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

屬性

名稱類型必填限制描述
idintegerfalse無歷史帳單明細 ID
user_product_idintegertrue無none
product_idintegertrue無none
product_typeintegertrue無none
parent_product_typeintegertrue無none
titlestringtrue無none
expired_atstringtrue無none
target_expired_atstringtrue無none
renew_daysintegertrue無none
unit_month_pricenumberfalse無none
pay_feenumbertrue無none
currencystringtrue無none
bandwidthintegerfalse無none
bandwidth_mbspnumberfalse無頻寬換算值
concurrencyintegerfalse無none
ipstringfalse無靜態 IP 套餐返回
country_codestringfalse無靜態 IP 套餐返回
paid_atstring,nullfalse無none
refunded_atstring,nullfalse無none
created_atstringfalse無none
updated_atstringfalse無none

InvoiceRecord

{
  "id": 1,
  "invoice_no": "string",
  "invoice_amount": 0,
  "invoice_download_url": "string",
  "status": 0,
  "remark": "string",
  "order_ids": [
    0
  ],
  "created_at": 0,
  "invoice_info": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "role_type": 1,
    "invoice_type": 0
  }
}

屬性

名稱類型必填限制描述
idintegertrue無none
invoice_nostringtrue無none
invoice_amountnumbertrue無none
invoice_download_urlstringtrue無none
statusintegertrue無none
remarkstringtrue無none
order_ids[integer]true無none
created_atintegertrue無Unix 時間戳
invoice_infoanytrue無none

oneOf

名稱類型必填限制描述
» anonymousobjectfalse無none
»» invoice_codestringtrue無none
»» namestringtrue無none
»» org_namestringtrue無none
»» role_typeintegertrue無none
»» invoice_typeintegertrue無none

xor

名稱類型必填限制描述
» anonymousnullfalse無none

列舉值

屬性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

PayCheckData

{
  "trade_no": "string",
  "pm_id": 0,
  "pay_method": 0,
  "trade_type": "string",
  "country_code": "string",
  "currency": "string",
  "goods_fee": 0,
  "discount_fee": 0,
  "handling_fee": 0,
  "pay_fee": 0,
  "total_fee": 0,
  "pay_method_info": {
    "id": 0,
    "type": 0,
    "title": "string",
    "group": "string",
    "handling_rate": 0,
    "handling_fee": 0,
    "handling_fee_currency": "usd",
    "handling_fee_converted": 0
  },
  "origin": {
    "pm_id": 0,
    "pay_method": 0,
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0
  }
}

屬性

名稱類型必填限制描述
trade_nostringtrue無none
pm_idintegertrue無none
pay_methodintegertrue無none
trade_typestringtrue無none
country_codestringtrue無none
currencystringtrue無none
goods_feenumbertrue無none
discount_feenumbertrue無none
handling_feenumbertrue無none
pay_feenumbertrue無none
total_feenumbertrue無none
pay_method_infoanytrue無none

oneOf

名稱類型必填限制描述
» anonymousobjectfalse無none
»» idintegertrue無none
»» typeintegertrue無none
»» titlestringtrue無none
»» groupstringtrue無none
»» handling_ratenumbertrue無none
»» handling_feenumbertrue無none
»» handling_fee_currencystringtrue無none
»» handling_fee_convertednumbertrue無none

xor

名稱類型必填限制描述
» anonymousnullfalse無none

continued

名稱類型必填限制描述
originobjecttrue無none
» pm_idintegertrue無none
» pay_methodintegertrue無none
» goods_feenumbertrue無none
» discount_feenumbertrue無none
» handling_feenumbertrue無none
» pay_feenumbertrue無none
» total_feenumbertrue無none