NSocks

Hỗ trợ quản lý tài khoản cá nhân, tài nguyên đại lý và lập hóa đơn nhóm thông qua tiền tố OpenAPI của trang web.

Phương thức xác thực dựa trên định nghĩa bảo mật của từng thao tác:

apiKeyAuth: Truyền khóa API cá nhân hoặc nhóm của bạn bằng cách truy vấn tham số app_key; hệ thống phụ trợ cũng hỗ trợ các tham số key, appkey, openid và các tham số trong phần thân yêu cầu POST.
bearerAuth: Ủy quyền: Bearer <JWT> Đây được dùng cho mã thông báo đăng nhập web. Không sử dụng Khóa API làm JWT.
Khóa API của nhóm được liên kết với một nhóm cố định; đối với các giao diện hỗ trợ không gian nhóm, team_id có thể được bỏ qua, nhưng nếu được truyền vào một cách rõ ràng, nó phải nhất quán với nhóm được liên kết với Khóa.
Các API chỉ hỗ trợ không gian cá nhân sẽ từ chối khóa API nhóm; các hoạt động nhóm vẫn tuân theo quyền truy cập tài nguyên của các thành viên nắm giữ khóa.

Phản hồi JSON bao gồm code, msg, data và request_id. code=200 cho biết thao tác thành công; HTTP 200 cũng có thể mang mã lỗi. Thông báo sẽ khác nhau tùy thuộc vào ngôn ngữ yêu cầu; khách hàng nên sử dụng mã để xác định kết quả. Một số giao diện xuất cũng hỗ trợ văn bản, CSV hoặc XML; xem định nghĩa thao tác để biết chi tiết. Các trường số lượng, lưu lượng, ngày tháng và phân trang tuân theo lược đồ giao diện tương ứng.

URL cơ sở: "https://api.nsocks.com"

Xác thực

Xác thực HTTP, lược đồ: bearer

Khóa API (apiKeyAuth2)
- Tên tham số: app_key, đầu vào: truy vấn. Khóa API cá nhân hoặc nhóm. Tham số truy vấn được khuyến nghị là app_key; nó cũng tương thích với key/appkey/openid và các phần thân yêu cầu POST. Khóa nhóm chỉ có thể truy cập các giao diện được hỗ trợ liên kết với nhóm.

Quản lý khóa API

Lấy danh sách khóa API

GET /ep/api-keys

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	không có
» tin nhắn	chuỗi	đúng	không có	không có
» request_id	chuỗi	đúng	không có	không có
» dữ liệu	đối tượng	đúng	không có	không có
»» danh sách	[UserApiKeyMetadata]	đúng	không có	không có
»»» id	số nguyên	đúng	không có	ID khóa API
»»» api_key	chuỗi	true	không có	Tạo phản hồi với khóa đầy đủ; sử dụng giá trị ẩn danh trong danh sách nhóm
»»» team_user_id	integer	true	none	Khóa nhóm: ID thành viên thực tế; Khóa cá nhân: 0
»»» nhận xét	chuỗi	đúng	không có	Nhận xét
»»» trạng thái	số nguyên	đúng	không có	0=đã tắt, 1=đã bật
»»» created_at	chuỗi	true	không có	Thời gian tạo
»»» updated_at	chuỗi ¦null	false	không có	Thời gian cập nhật
»» tổng	số nguyên	đúng	không có	không có
»» trang	số nguyên	đúng	không có	không có
»» trangKích thước	số nguyên	đúng	không	không

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1

Tạo khóa API thông qua phương thức POST

POST /ep/api-keys/create

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» nhận xét	nội dung	chuỗi	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Trả về toàn bộ Khóa API sau khi giao dịch thành công, chỉ một lần duy nhất	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1

Kích hoạt khóa API bằng phương thức POST.

POST /ep/api-keys/enable

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
thân thể	thân thể	Quản lý yêu cầu APIKey	Có	Không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

POST Vô hiệu hóa khóa API

POST /ep/api-keys/disable

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
thân thể	thân thể	Quản lý yêu cầu APIKey	Có	Không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Yêu cầu POST Xóa khóa API

POST /ep/api-keys/delete

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
thân thể	thân thể	Quản lý yêu cầu APIKey	Có	Không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Gửi yêu cầu POST để sửa đổi khóa API. Ghi chú

POST /ep/api-keys/update-remark

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» id	body	integer	is	none
» nhận xét	nội dung	chuỗi	có	không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Quản lý nhóm

ĐĂNG Tạo nhóm

POST /ep/team/create

Các tham số yêu cầu thân

{
  "name": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» tên	nội dung	chuỗi	Có	Tên đội

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

Lấy danh sách các nhóm hiện đang được người dùng truy cập.

GET /ep/team/list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

Thông tin chi tiết về đội ngũ GET

GET /ep/team/detail

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

Gửi yêu cầu đổi tên nhóm.

POST /ep/team/update-name

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» tên	nội dung	chuỗi	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

POST giải tán đội bóng

POST /ep/team/dissolve

Chức năng này chỉ có thể được gọi bởi quản trị viên cấp cao nhất của nhóm. Tên trong yêu cầu phải trùng khớp chính xác với tên hiện tại của nhóm. Giao diện này thực thi xác minh thứ cấp: nó trả về mã = 348 nếu người dùng không ở trong trạng thái đáng tin cậy 15 phút. Người gọi nên lấy mã xác minh theo các phương thức có sẵn trong dữ liệu phản hồi, sau đó thử lại với verify_type và verify_code. Nó có thể được gọi nhiều lần để tiếp tục quá trình giải thể chưa hoàn tất.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» tên	nội dung	chuỗi	Có	Xác nhận tên đội, phải giống hệt tên đội hiện tại
» verify_type	body	string	No	Xác thực hai yếu tố; được gửi cùng với verify_code khi cần xác minh
» verify_code	body	string	No	Mã xác thực hai yếu tố; tùy chọn nếu thiết bị đang ở trạng thái tin cậy 15 phút

Giá trị liệt kê

Thuộc tính	Giá trị
» xác minh_loại	điện thoại
» xác minh_loại	email
» xác minh_loại	wechat
» verify_type	totp

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

Truy vấn GET để lấy trạng thái giải tán nhóm.

GET /ep/team/dissolve-status

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

Tài sản của đội

Nhận thông tin về gói dành cho đội

GET /ep/team/product-info

Trả về bản tóm tắt gói cho không gian tài nguyên của nhóm được chỉ định, với các trường nhất quán với các trường gói trong /web_v1/user/info. Thông tin cá nhân, số dư hoặc mã số định danh nội bộ của quản trị viên nhóm sẽ không được trả lại. Để biết chi tiết về các gói điểm, vui lòng sử dụng /web_v1/credit/info.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Danh sách tài sản của nhóm GET

GET /ep/team/assets

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

NHẬN các nguồn lực cá nhân có thể được đưa vào nhóm.

GET /ep/team/assets/personal-candidates

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

CHUYỂN GIAO TÀI SẢN CÁ NHÂN CHO NHÓM

POST /ep/team/assets/move-in

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» user_product_id	nội dung	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Tài sản của nhóm POST được trả lại cho các cá nhân.

POST /ep/team/assets/move-out

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» user_product_id	nội dung	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Ví nhóm

GET truy vấn ví nhóm

GET /ep/team/wallet/detail

Cần có quyền VIEW_BILLING. Ví nhóm tách biệt với số dư cá nhân của quản trị viên cấp cao và các thành viên.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Truy vấn GET lịch sử giao dịch ví nhóm

GET /ep/team/wallet/records

Cần có quyền VIEW_BILLING. Số tiền giao dịch luôn dương, và sự thay đổi về số tiền được thể hiện bằng trường hướng.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
hướng	0
hướng	1
loại giao dịch	1
loại giao dịch	2
loại giao dịch	3
loại giao dịch	4
loại giao dịch	5

Số dư cá nhân đã được chuyển vào ví nhóm.

POST /ep/team/wallet/transfer-in

Chỉ quản trị viên cấp cao của nhóm mới có quyền TRANSFER_BALANCE. Việc chuyển tiền sẽ tự động trừ vào số dư nạp tiền cá nhân của họ và cộng vào ví nhóm; số tiền được chuyển không được tính vào total_recharge_fee và không thể chuyển ngược lại vào số dư cá nhân.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» số lượng	cơ thể	số (gấp đôi)	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Số dư của nhóm POST đã được chuyển lại vào tài khoản cá nhân.

POST /ep/team/wallet/transfer-out

Chức năng này chỉ có thể được gọi bởi quản trị viên cấp cao đã đăng nhập. Nó tự động trừ tiền từ ví nhóm và tăng số dư nạp tiền của cá nhân; nó không thay đổi tổng số tiền nạp của nhóm hoặc cá nhân. Chức năng này có thể được sử dụng để thu hồi số dư từ các nhóm đã giải thể, nhưng không thể được gọi bởi các nhóm đã giải thể.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» số tiền	nội dung	số (double)	Có	Không được vượt quá số dư hiện có của đội

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Thành viên nhóm

Danh sách thành viên nhóm GET

GET /ep/team/members

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3

Danh sách thống nhất thành viên nhóm GET

GET /ep/team/people

Trả về danh sách thành viên hợp lệ; quản trị viên cấp cao và quản trị viên cũng sẽ thấy các lời mời đang chờ xử lý. Trạng thái lời mời khác chỉ được lưu giữ trong danh sách lịch sử lời mời.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại bản ghi	thành viên
loại bản ghi	lời mời
loại_mời	0
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	0
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1

Bài đăng Điều chỉnh vai trò thành viên

POST /ep/team/members/update-role

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» team_member_id	nội dung	số nguyên	có	không
» vai trò	cơ thể	số nguyên	có	không

Giá trị liệt kê

Thuộc tính	Giá trị
» vai trò	2
» vai trò	3

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3

ĐĂNG bài viết Xóa thành viên nhóm

POST /ep/team/members/remove

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» team_member_id	nội dung	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; data.status=3 khi logic nghiệp vụ thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3

ĐĂNG BÀI - Rời nhóm

POST /ep/team/members/leave

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; data.status=2 khi logic nghiệp vụ thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3

Thư mời đội

ĐĂNG Tạo lời mời nhóm

POST /ep/team/invitations/create

Lời mời được tạo dựa trên người dùng đã đăng ký, địa chỉ email hoặc số điện thoại. Khi địa chỉ email hoặc số điện thoại trùng khớp với người dùng trên trang web này, phản hồi sẽ được chuẩn hóa thành invite_type=1. Phần giao diện người dùng có thể gửi mẫu đường dẫn tương đối của URL lời mời từ trang web này, và máy chủ sẽ chỉ đơn giản thay thế bằng mã thông báo lời mời dùng một lần. Nếu người dùng chưa đăng ký đăng ký bằng số điện thoại được mời hoặc hoàn tất xác minh bằng địa chỉ email được mời, máy chủ sẽ liên kết lời mời vẫn còn hiệu lực với người dùng mới, xoay vòng mã thông báo và chỉ gửi lại một tin nhắn trong ứng dụng chưa đọc; mã thông báo cũ trong email hoặc SMS ban đầu sau đó sẽ trở nên không hợp lệ. Nếu lời mời qua email chưa được liên kết tự động, tài khoản hiện tại được đăng ký bằng địa chỉ email được mời có thể nhận trực tiếp mà không cần chờ xác minh email.

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "user@example.com",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» loại lời mời	nội dung	số nguyên	Có	1=Người dùng đã đăng ký, 2=Email, 3=Số điện thoại di động
» vai trò	nội dung	số nguyên	Có	2 = Quản trị viên, 3 = Thành viên thường
» user_id	nội dung	số nguyên	Không	Bắt buộc nếu invite_type=1
» email	nội dung	chuỗi (email)	Không	Bắt buộc nếu invite_type=2
» mã_quốc_gia	nội_thân	số_tử	Không	Bắt buộc nếu invite_type=3
» điện thoại	nội dung	chuỗi	Không	Bắt buộc nếu invite_type=3
» invitation_url_template	body	string	No	Đây là mẫu đường dẫn tương đối được định nghĩa bởi giao diện người dùng của trang web; nó phải bắt đầu bằng một dấu / duy nhất, không được chứa tên miền hoặc dấu xuống dòng, và chỉ được chứa một chỗ giữ chỗ .
»ẩn danh	cơ thể	đối tượng	không	không có
»» loại lời mời	nội dung	bất kỳ	không	không có
»ẩn danh	cơ thể	đối tượng	không	không có
»» loại lời mời	nội dung	bất kỳ	không	không có
»ẩn danh	cơ thể	đối tượng	không	không có
»» loại lời mời	nội dung	bất kỳ	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» loại lời mời	1
» loại lời mời	2
» loại mời	3
» vai trò	2
» vai trò	3

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã phản hồi, mã 200 cho biết giao dịch thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4
email	đang chờ xử lý
email	thất bại
email	bỏ qua
tin nhắn SMS	đang chờ xử lý
tin nhắn SMS	thất bại
tin nhắn SMS	đã bỏ qua
site_inner_message	created
site_inner_message	exists
site_inner_message	thất bại

Danh sách khách mời của nhóm GET

GET /ep/team/invitations

Chỉ quản trị viên cấp cao hoặc quản trị viên của nhóm mới có quyền truy cập; các lời mời đang chờ xử lý đã hết hạn sẽ được cập nhật trạng thái là hết hạn trước khi được khôi phục.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	TeamPublicId	Có	Nhận diện công khai đội nhóm
trang	truy vấn	số nguyên	Không	Số trang, bắt đầu từ 1
kích thước trang	truy vấn	số nguyên	không	số trang trên mỗi trang

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

Nhận thư mời tham gia nhóm xem trước

GET /ep/team/invitations/preview

Lời mời xem trước ẩn danh được gửi bằng mã mời dùng một lần; mã số định danh của lời mời không được sử dụng trong liên kết.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
invitation_token	query	string	Yes	Một mã token dùng một lần dạng văn bản thuần không rỗng được mang trong liên kết mời

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

Gửi lại thông báo mời tham gia nhóm

POST /ep/team/invitations/resend

Hãy gửi lại lời mời thông qua kênh phân phối ban đầu; người dùng đã đăng ký cũng sẽ nhận được tin nhắn trong ứng dụng. Việc gửi lại sẽ xoay vòng mã thông báo và tất cả các liên kết mời trước đó sẽ ngay lập tức trở nên không hợp lệ.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» invitation_id	nội dung	số nguyên	Có	ID lời mời

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4
email	đang chờ xử lý
email	thất bại
email	bỏ qua
tin nhắn SMS	đang chờ xử lý
tin nhắn SMS	thất bại
tin nhắn SMS	đã bỏ qua
site_inner_message	created
site_inner_message	exists
site_inner_message	thất bại

ĐĂNG Chấp nhận lời mời tham gia nhóm

POST /ep/team/invitations/accept

Người dùng hiện đang đăng nhập chấp nhận lời mời bằng cách sử dụng mã thông báo mời dùng một lần (invitation_token), mã này phải khớp với mục tiêu của lời mời và thuộc về trang web mà lời mời hướng đến; không cần phải truyền tham số team_id.

Các tham số yêu cầu thân

{
  "invitation_token": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» invitation_token	body	string	Có	Mã mời dùng một lần dạng văn bản thuần

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; nếu logic nghiệp vụ thành công, `data` là một đối tượng thành viên.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3

BÀI ĐĂNG - Từ chối lời mời tham gia nhóm

POST /ep/team/invitations/reject

Người dùng hiện đang đăng nhập sử dụng mã thông báo mời dùng một lần (invitation_token) để từ chối các lời mời trùng khớp với danh tính của họ; không cần thiết phải có mã định danh nhóm (team_id).

Các tham số yêu cầu thân

{
  "invitation_token": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» invitation_token	body	string	Có	Mã mời dùng một lần dạng văn bản thuần

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; data.status=2 khi logic nghiệp vụ thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

ĐĂNG Hủy lời mời tham gia nhóm

POST /ep/team/invitations/cancel

Để hủy các lời mời đang chờ xử lý trong một nhóm cụ thể, người điều hành phải có quyền mời vai trò mục tiêu đó.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	nội dung	TeamPublicId	Có	Mã định danh công khai của nhóm, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» invitation_id	nội dung	số nguyên	Có	ID lời mời

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; data.status=3 khi logic nghiệp vụ thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

Quản lý điểm

Nhận thông tin về gói điểm

GET /web_v1/credit/info

Truy vấn tóm tắt các gói điểm cho không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS; giao diện này hỗ trợ trạng thái đăng nhập, Khóa API cá nhân và Khóa API nhóm.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc truyền dưới dạng chuỗi rỗng; Khóa API nhóm có thể được bỏ qua, nhưng phải khớp với Khóa khi được truyền vào

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao dịch HTTP thành công; khi giao dịch thành công, dữ liệu bao gồm số điểm tích lũy, tổng số điểm, số điểm còn lại, thời gian đặt lại và trạng thái tự động bổ sung.	Nội tuyến

Cấu trúc dữ liệu trả về

Gửi yêu cầu để thiết lập tự động cộng điểm khi số dư còn lại.

POST /web_v1/credit/update-auto-supplement

Thiết lập này cho phép tự động bổ sung dung lượng tài nguyên hiện có khi đăng nhập. Không gian nhóm yêu cầu quyền USE_OWNER_PAYMENT_CAPABILITIES và hiện chỉ có quản trị viên cấp cao của nhóm mới có thể truy cập; không gian nhóm bị tắt theo mặc định.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» trạng thái	nội dung	số nguyên	Có	0 = Tắt, 1 = Bật

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi giao dịch thành công, data.status sẽ hiển thị trạng thái bật/tắt được cập nhật.	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy bản ghi tiêu thụ điểm

GET /web_v1/credit/consumption-logs

Trạng thái đăng nhập hoặc Khóa API cho phép truy vấn phân trang các bản ghi mức tiêu thụ điểm không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, được hiểu theo múi giờ của trang web
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, được hiểu theo múi giờ của trang web
loại_tiêu_dụng	truy_vấn	chuỗi	Không	Loại_tiêu_dụng

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi logic nghiệp vụ thành công, dữ liệu bao gồm danh sách, trang, kích thước trang, tổng số lượng và tổng số trang.	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy điểm Đặt lại bản ghi

GET /web_v1/credit/reset-logs

Trạng thái đăng nhập hoặc Khóa API: Truy vấn từng trang về các bản ghi đặt lại điểm cho không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; sau khi giao dịch thành công, dữ liệu bao gồm các bản ghi đặt lại điểm và thông tin phân trang.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận số liệu thống kê điểm thông qua GET

GET /web_v1/credit/stats

Trạng thái đăng nhập hoặc Khóa API để truy vấn số liệu thống kê điểm của không gian tài nguyên hiện tại được tổng hợp theo loại tiêu thụ. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, được hiểu theo múi giờ của trang web
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, được hiểu theo múi giờ của trang web

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; khi logic nghiệp vụ thành công, dữ liệu sẽ bao gồm by_type và total.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận thống kê điểm hàng ngày

GET /web_v1/credit/daily-stats

Truy vấn trạng thái đăng nhập hoặc Khóa API để xem mức tiêu thụ tín dụng hàng ngày của không gian tài nguyên hiện tại, mặc định là 7 ngày gần nhất. Các thành viên nhóm thông thường chỉ thấy mức tiêu thụ thực tế của riêng họ; quản trị viên, quản trị viên cấp cao và các thành viên tài chính có quyền VIEW_BILLING sẽ thấy toàn bộ dữ liệu của nhóm. Nhật ký nhóm đối với các thành viên không có hồ sơ tiêu thụ trước đó chỉ hiển thị cho chế độ xem đầy đủ. Truy vấn Khóa API có thể chứa tối đa 31 ngày dương lịch (bao gồm cả ngày bắt đầu và ngày kết thúc), với ngày bắt đầu không muộn hơn ngày kết thúc.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, mặc định là 6 ngày trước
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, mặc định là hôm nay
loại_tiêu_dụng	truy_vấn	chuỗi	Không	Loại_tiêu_dụng_tùy_chọn
điền_khoảng_trống	truy vấn	số nguyên	Không	Điền vào các ngày bị thiếu

Giá trị liệt kê

Thuộc tính	Giá trị
điền_khoảng_trống	0
điền_khoảng_trống	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi giao dịch thành công, dữ liệu sẽ bao gồm số liệu thống kê hàng ngày và tóm tắt.	Nội tuyến

Cấu trúc dữ liệu trả về

NHẬN Thống kê điểm theo giờ

GET /web_v1/credit/hourly-stats

Truy vấn trạng thái đăng nhập hoặc Khóa API để lấy thông tin về mức tiêu thụ tín dụng theo giờ của không gian tài nguyên hiện tại, mặc định là 7 ngày gần nhất. Không gian nhóm yêu cầu quyền VIEW_BILLING. Truy vấn Khóa API có thể chứa tối đa 31 ngày dương lịch (bao gồm cả ngày bắt đầu và ngày kết thúc), và ngày bắt đầu không được muộn hơn ngày kết thúc.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, mặc định là 6 ngày trước
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, mặc định là hôm nay
loại_tiêu_dụng	truy_vấn	chuỗi	Không	Loại_tiêu_dụng_tùy_chọn
điền vào chỗ trống	truy vấn	số nguyên	Không	Điền vào số giờ bị thiếu

Giá trị liệt kê

Thuộc tính	Giá trị
điền_khoảng_trống	0
điền_khoảng_trống	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi giao dịch thành công, dữ liệu sẽ bao gồm số liệu thống kê theo giờ và tóm tắt.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận thông tin về gói điểm

GET /ep/credit/info

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc truyền dưới dạng chuỗi rỗng; Khóa API nhóm có thể được bỏ qua, nhưng phải khớp với Khóa khi được truyền vào

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao dịch HTTP thành công; khi giao dịch thành công, dữ liệu bao gồm số điểm tích lũy, tổng số điểm, số điểm còn lại, thời gian đặt lại và trạng thái tự động bổ sung.	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy bản ghi tiêu thụ điểm

GET /ep/credit/consumption-logs

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, được hiểu theo múi giờ của trang web
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, được hiểu theo múi giờ của trang web
loại_tiêu_dụng	truy_vấn	chuỗi	Không	Loại_tiêu_dụng

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi logic nghiệp vụ thành công, dữ liệu bao gồm danh sách, trang, kích thước trang, tổng số lượng và tổng số trang.	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy điểm Đặt lại bản ghi

GET /ep/credit/reset-logs

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; sau khi giao dịch thành công, dữ liệu bao gồm các bản ghi đặt lại điểm và thông tin phân trang.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận số liệu thống kê điểm thông qua GET

GET /ep/credit/stats

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, được hiểu theo múi giờ của trang web
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, được hiểu theo múi giờ của trang web

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; khi logic nghiệp vụ thành công, dữ liệu sẽ bao gồm by_type và total.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận thống kê điểm hàng ngày

GET /ep/credit/daily-stats

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, mặc định là 6 ngày trước
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, mặc định là hôm nay
loại_tiêu_dụng	truy_vấn	chuỗi	Không	Loại_tiêu_dụng_tùy_chọn
điền_khoảng_trống	truy vấn	số nguyên	Không	Điền vào các ngày bị thiếu

Giá trị liệt kê

Thuộc tính	Giá trị
điền_khoảng_trống	0
điền_khoảng_trống	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi giao dịch thành công, dữ liệu sẽ bao gồm số liệu thống kê hàng ngày và tóm tắt.	Nội tuyến

Cấu trúc dữ liệu trả về

NHẬN Thống kê điểm theo giờ

GET /ep/credit/hourly-stats

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày_bắt_đầu	truy vấn	chuỗi(ngày)	Không	Ngày bắt đầu, mặc định là 6 ngày trước
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Ngày kết thúc, mặc định là hôm nay
loại_tiêu_dụng	truy_vấn	chuỗi	Không	Loại_tiêu_dụng_tùy_chọn
điền vào chỗ trống	truy vấn	số nguyên	Không	Điền vào số giờ bị thiếu

Giá trị liệt kê

Thuộc tính	Giá trị
điền_khoảng_trống	0
điền_khoảng_trống	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi giao dịch thành công, dữ liệu sẽ bao gồm số liệu thống kê theo giờ và tóm tắt.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhật ký hoạt động Xcrawl

Lấy danh sách các tác vụ gần đây của Xcrawl.

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

Đăng nhập để truy vấn danh sách và tóm tắt các nhiệm vụ riêng lẻ trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS; thành viên thông thường chỉ có thể xem các nhiệm vụ được tạo bởi thông tin đăng nhập của chính họ, trong khi quản trị viên và quản trị viên cấp cao có thể xem tất cả các nhiệm vụ của nhóm.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có
điểm cuối	truy vấn	chuỗi	Không	Loại điểm cuối
trạng thái	truy vấn	chuỗi	không	không có
thời_gian_bắt_đầu	truy_vấn	chuỗi	Không	Thời_gian_múi_giờ_người_dùng, định_dạng_Ymd_H:i:s
end_time	query	string	No	Thời gian theo múi giờ của người dùng, bao gồm cả ranh giới kết thúc
url	truy vấn	chuỗi	Không	URL đích hoặc mã định danh trình thu thập dữ liệu
job_id	truy vấn	chuỗi	Không	Tiền tố ID nhiệm vụ

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	đang chờ xử lý
trạng thái	đang thu thập dữ liệu
trạng thái	đã hoàn thành
trạng thái	thất bại

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; nếu giao dịch thành công, dữ liệu sẽ bao gồm danh sách phân trang và siêu dữ liệu.	Nội tuyến

Cấu trúc dữ liệu trả về

Yêu cầu GET để truy xuất kết quả thu thập dữ liệu Xcrawl.

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

Đăng nhập để truy vấn Kết quả Thu thập dữ liệu cho tác vụ được chỉ định trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS và xác minh quyền sở hữu tác vụ dựa trên phạm vi thông tin xác thực mà thành viên có thể xem.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
job_id	truy vấn	chuỗi	Có	ID nhiệm vụ

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Giao thức HTTP thành công; khi hoạt động nghiệp vụ thành công, dữ liệu bao gồm job_id và crawl_result.	Nội tuyến

Cấu trúc dữ liệu trả về

GET Truy xuất thông tin chi tiết và nhật ký tác vụ Xcrawl.

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

Đăng nhập để truy vấn chi tiết của một tác vụ cụ thể và kết quả của nó trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS và xác minh quyền sở hữu tác vụ dựa trên phạm vi thông tin xác thực hiển thị cho mỗi thành viên.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
job_id	truy vấn	chuỗi	Có	ID nhiệm vụ
trang	truy vấn	số nguyên	không	số trang kết quả phụ thu thập dữ liệu/dữ liệu
kích thước trang	truy vấn	số nguyên	Không	Số trang cho kết quả phụ thu thập dữ liệu/dữ liệu

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thành công HTTP; khi giao dịch thành công, dữ liệu bao gồm công việc và các chi tiết thay đổi theo điểm cuối.	Nội tuyến

Cấu trúc dữ liệu trả về

Yêu cầu GET để truy xuất dữ liệu từ URL cho số liệu thống kê tổng hợp.

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

Trạng thái đăng nhập tổng hợp các tác vụ thu thập dữ liệu của không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS, và kết quả tuân theo phạm vi thông tin xác thực mà thành viên có thể xem được.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
giới hạn	truy vấn	số nguyên	Không	Trả về số lượng mục; 0 trả về danh sách rỗng

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; nếu logic nghiệp vụ thành công, data.list sẽ chứa kết quả tổng hợp của trình thu thập dữ liệu.	Nội tuyến

Cấu trúc dữ liệu trả về

Phương thức GET dùng để truy xuất danh sách các tác vụ thu thập dữ liệu gần đây theo từng đợt.

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

Đăng nhập để truy vấn danh sách và tóm tắt các tác vụ xử lý hàng loạt trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS; thành viên thông thường chỉ có thể xem các tác vụ được tạo bởi thông tin đăng nhập của chính họ, trong khi quản trị viên và quản trị viên cấp cao có thể xem tất cả các tác vụ của nhóm.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có
điểm cuối	truy vấn	chuỗi	Không	Loại điểm cuối, thường là batch_scrape
trạng thái	truy vấn	chuỗi	không	không có
thời_gian_bắt_đầu	truy_vấn	chuỗi	Không	Thời_gian_múi_giờ_người_dùng, định_dạng_Ymd_H:i:s
end_time	query	string	No	Thời gian theo múi giờ của người dùng, bao gồm cả ranh giới kết thúc
batch_id	query	string	no	Tiền tố ID tác vụ hàng loạt

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	đang chờ xử lý
trạng thái	đang thu thập dữ liệu
trạng thái	đã hoàn thành
trạng thái	thất bại

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; nếu giao dịch thành công, dữ liệu sẽ bao gồm danh sách phân trang và siêu dữ liệu.	Nội tuyến

Cấu trúc dữ liệu trả về

Yêu cầu GET để truy xuất thông tin chi tiết và nhật ký của các tác vụ thu thập dữ liệu web theo lô.

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

Trạng thái đăng nhập truy vấn kết quả của một nhóm tác vụ cụ thể và các mục con của chúng trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS và xác minh quyền sở hữu tác vụ dựa trên phạm vi thông tin xác thực mà thành viên có thể xem.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
batch_id	query	string	Yes	Mã ID tác vụ hàng loạt
trang	truy vấn	số nguyên	không	số trang mục con
page_size	query	integer	no	Số lượng mục con trên mỗi trang

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; khi logic nghiệp vụ thành công, dữ liệu sẽ bao gồm chi tiết về công việc và tác vụ theo lô.	Nội tuyến

Cấu trúc dữ liệu trả về

Quản lý tài khoản đại lý

Lấy danh sách tài khoản proxy

GET /ep/whitelist-account/list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc truyền dưới dạng chuỗi rỗng; khóa nhóm có thể được bỏ qua, nhưng phải khớp với khóa khi được truyền vào

Quay lại ví dụ

200 Phản hồi

{
  "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
      }
    ]
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	Mã phản hồi	false	none	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» id	số nguyên	false	không có	Số tài khoản
»»» tên người dùng	chuỗi	false	không có	Tên tài khoản ủy quyền
»»» mật khẩu	chuỗi	false	không có	Mật khẩu tài khoản ủy quyền
»»» created_at	chuỗi	false	không có	Thời gian thêm
»»» nhận xét	chuỗi	sai	không có	Nhận xét
»»» loại sản phẩm	loại sản phẩm	false	none	Loại gói cước: 9 Gói lưu lượng truy cập dân cư động, 11 Gói IP dân cư động, 14 Gói IP trung tâm dữ liệu tĩnh, 25 Gói IP dân cư tĩnh
»»» usage_flow	integer	false	none	Luồng sử dụng, tính bằng KB
»»» limit_flow	integer	false	none	Giới hạn lưu lượng tùy chỉnh: tối đa 102400 GB, 0 nghĩa là không giới hạn
»»» trạng thái	số nguyên	false	không có	Trạng thái đã bật: 1 đã bật, 0 đã tắt

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm	9
loại_sản_phẩm	11
loại_sản_phẩm	14
loại_sản_phẩm	25

Có thể thiết lập giới hạn lưu lượng truy cập cho tài khoản proxy phát hiện POST.

POST /ep/whitelist-account/check

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» tài khoản	nội dung	chuỗi	Không	Truyền tên tài khoản khi chỉnh sửa tài khoản ủy quyền hiện có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
isAgent	0
là Đặc vụ	1

Lấy thông tin về hạn mức và số lượng đã sử dụng của tài khoản phụ proxy động.

GET /ep/whitelist-account/child-account

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Thêm tài khoản proxy.

POST /ep/whitelist-account/add

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Mật khẩu tài khoản. Vui lòng điền theo định dạng tên người dùng:mật khẩu. Chỉ hỗ trợ số và chữ cái cho tài khoản và mật khẩu. Không cho phép ký tự đặc biệt hoặc khoảng trắng. Phân tách tài khoản và mật khẩu bằng dấu hai chấm. Hỗ trợ thêm hàng loạt. Phân tách các tài khoản ủy quyền bằng dấu phẩy (,).
» nhận xét	nội dung	chuỗi	Không	Mô tả tài khoản ủy quyền
» loại sản phẩm	nội dung	loại sản phẩm	Không	Loại gói cước: Gói lưu lượng truy cập dân cư động 9, Gói IP dân cư động 11, Gói IP trung tâm dữ liệu tĩnh 14, Gói IP dân cư tĩnh 25

Giá trị liệt kê

Thuộc tính	Giá trị
» loại sản phẩm	9
» loại sản phẩm	11
» loại sản phẩm	14
» loại_sản_phẩm	25

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

ĐĂNG bài viết Xóa tài khoản đại lý

POST /ep/whitelist-account/delete

Xin lưu ý rằng việc xóa là không thể đảo ngược và dữ liệu đã sử dụng không thể khôi phục. Quá trình xóa mất khoảng 5 phút, trong thời gian đó phí vẫn có thể được áp dụng.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái. Hỗ trợ các thao tác hàng loạt, với các tài khoản ủy quyền được phân tách bằng dấu phẩy (,).

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

VÔ HIỆU HÓA TÀI KHOẢN PROCENT

POST /ep/whitelist-account/disable

Sau khi vô hiệu hóa, sẽ có thời gian chờ khoảng 5 phút, trong thời gian đó vẫn có thể phát sinh phí.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái. Hỗ trợ các thao tác hàng loạt, với các tài khoản ủy quyền được phân tách bằng dấu phẩy (,).

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Kích hoạt tài khoản Proxy

POST /ep/whitelist-account/enable

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái. Hỗ trợ các thao tác hàng loạt, với các tài khoản ủy quyền được phân tách bằng dấu phẩy (,).

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Gửi yêu cầu POST để thay đổi mật khẩu của tài khoản proxy.

POST /ep/whitelist-account/change-password

Vui lòng lưu ý rằng sẽ có thời gian chờ 5 phút sau khi bạn thực hiện thay đổi. Trong thời gian này, mật khẩu cũ vẫn có thể hoạt động bình thường.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái.
» mật khẩu	nội dung	chuỗi	Có	Mật khẩu mới cho tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Gửi yêu cầu POST để chỉnh sửa ghi chú tài khoản đại lý

POST /ep/whitelist-account/change-remark

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái.
» nhận xét	nội dung	chuỗi	Có	Ghi chú mới cho tài khoản ủy quyền, tối đa 32 ký tự tiếng Trung hoặc 64 ký tự tiếng Anh.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Gửi yêu cầu POST để sửa đổi giới hạn lưu lượng truy cập của tài khoản proxy.

POST /ep/whitelist-account/change-limit

Xin lưu ý rằng số liệu thống kê lưu lượng truy cập có thể bị chậm trễ đến 5 phút, có nghĩa là lưu lượng truy cập thực tế có thể vượt quá giới hạn này.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	Có	Tài khoản ủy quyền, chỉ hỗ trợ số và chữ cái.
» giới hạn	thân	số nguyên	Không	Giới hạn lưu lượng truy cập, đơn vị: GB, 0 nghĩa là không giới hạn

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Đăng bài viết Tạo tài khoản proxy nhanh chóng

POST /ep/whitelist-account/quick-add

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» loại sản phẩm	thân máy	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Trả về tài khoản và mật khẩu mới sau khi giao dịch thành công	Trực tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	không có
» tin nhắn	chuỗi	sai	không có	không có
» request_id	chuỗi	false	không có	không có
» dữ liệu	bất kỳ	sai	không có	không có

một trong

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
»»ẩn danh	đối tượng	sai	không có	không có
»»» tên người dùng	chuỗi	đúng	không có	không có
»»» mật khẩu	chuỗi	đúng	không có	không có

xor

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
»»ẩn danh	null	false	không có		không có

Gửi yêu cầu POST để sửa đổi giới hạn lưu lượng truy cập hàng ngày của tài khoản proxy.

POST /ep/whitelist-account/change-daily-limit

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» tài khoản	nội dung	chuỗi	có	không
» giới hạn hàng ngày	nội dung	số nguyên	Không	Đơn vị: GB

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Gửi yêu cầu POST để sửa đổi thông tin tài khoản đại lý

POST /ep/whitelist-account/change

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» tài khoản	nội dung	chuỗi	có	không
» mật khẩu	nội dung	chuỗi	không	không có
» nhận xét	nội dung	chuỗi	không	không có
» giới hạn	nội dung	số nguyên	Không	Tổng giới hạn dữ liệu, tính bằng GB
» giới hạn_hàng_ngày	nội dung	số nguyên	Không	Giới hạn dữ liệu hàng ngày, tính bằng GB
» trạng thái	nội dung	số nguyên	không	không có
» udp	thân	số nguyên	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1
» udp	0
» udp	1

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Phương thức POST làm mới bộ nhớ đệm xác thực tài khoản proxy trong không gian tài nguyên hiện tại.

POST /ep/whitelist-account/refresh

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Lấy hạn mức tài khoản đại lý cho loại sản phẩm được chỉ định

GET /ep/whitelist-account/quota

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
loại_sản_phẩm	truy vấn	số_nguyên	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	không có
» tin nhắn	chuỗi	sai	không có	không có
» request_id	chuỗi	false	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» cách sử dụng	số nguyên	đúng	không có	không có
»» giới hạn	số nguyên	đúng	không có	không có
»» mở rộng	số nguyên	đúng	không có	không có

Nhận hạn mức tài khoản đại lý cho tất cả các loại sản phẩm.

GET /ep/whitelist-account/quotas

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	không có
» tin nhắn	chuỗi	sai	không có	không có
» request_id	chuỗi	false	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» loại sản phẩm	số nguyên	sai	không có	không có
»»» giới hạn	số nguyên	sai	không có	không có
»»» cách sử dụng	số nguyên	sai	không có	không có

Gửi yêu cầu POST để sửa đổi thông tin tài khoản đại lý

POST /ep/proxy-account/change

Thay đổi mật khẩu tài khoản proxy, ghi chú, giới hạn lưu lượng truy cập, giới hạn lưu lượng truy cập hàng ngày, trạng thái kích hoạt hoặc công tắc UDP.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» tài khoản	nội dung	chuỗi	là	tên tài khoản ủy quyền
» mật khẩu	nội dung	chuỗi	Không	Mật khẩu mới, 6-16 ký tự gồm số hoặc chữ cái; nếu không gửi, mật khẩu sẽ không được thay đổi
» nhận xét	nội dung	chuỗi	Không	Ghi chú mới
» giới hạn	nội dung	số nguyên	Không	Dung lượng dữ liệu tối đa, tính bằng GB, 0 biểu thị không giới hạn
» giới hạn hàng ngày	nội dung	số nguyên	Không	Giới hạn dữ liệu hàng ngày tính bằng GB, 0 biểu thị không giới hạn
» trạng thái	nội dung	số nguyên	Không	Trạng thái đã bật
» UDP	nội dung	số nguyên	Không	UDP hỗ trợ chuyển mạch, chỉ có hiệu lực đối với các loại gói 14, 16, 21 và 25

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1
» udp	0
» udp	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

GET tạo thông tin kết nối proxy

GET /ep/whitelist-account/format

Hỗ trợ khóa API cá nhân và nhóm. Chỉ trả về các tài khoản proxy được ủy quyền trong không gian tài nguyên hiện tại, hỗ trợ các loại gói 9, 11 và 12. JSON/XML trả về một danh sách có cấu trúc các khóa tài khoản; txt/csv trả về một chuỗi được nối ở định dạng f.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
ac	truy vấn	số nguyên	Có	ID tài khoản hoặc tên người dùng của đại lý; tài khoản tham số tương thích
ae	truy vấn	chuỗi	không	không có
st	truy vấn	chuỗi	không	không có
ct	truy vấn	chuỗi	không	không có
lf	truy vấn	số nguyên	không	không có
n	truy vấn	số nguyên	không	không có
f	truy vấn	số nguyên	Không	Chỉ ảnh hưởng đến định dạng chuỗi ghép của các tệp txt/csv
loại	truy vấn	chuỗi	không	không có
lb	truy vấn	chuỗi	không	không có
ep	truy vấn	chuỗi	không	không có
team_id	truy vấn	ResourceSpaceId Không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
f	1
f	2
f	3
f	4
f	5
kiểu	json
loại	xml
loại	txt
loại	csv

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}]
  },
  "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>

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Kết nối HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết kết nối thành công. WebV1SuccessResponse

Danh sách trắng IP

Lấy danh sách IP được phép

GET /ep/proxy-ip/list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
loại_sản_phẩm	truy vấn	số_nguyên	Không	Số_loại_gói

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» địa chỉ IP	chuỗi	false	không có	Danh sách trắng IP
»»» nhận xét	chuỗi	sai	không có	Nhận xét
»»» loại sản phẩm	số nguyên	false	không có	Loại bao bì
»»» created_at	chuỗi	false	không có	Thời gian tạo

Thêm địa chỉ IP vào danh sách trắng (PET)

POST /ep/proxy-ip/add

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» ips	body	string	Có	Danh sách trắng các địa chỉ IP cần thêm, nhiều địa chỉ IP được phân cách bằng dấu phẩy hoặc xuống dòng
» nhận xét	nội dung	chuỗi	Không	Nhận xét
» loại_sản_phẩm	nội_thân	số_nguyên	Không	Số_loại_gói
» user_product_id	nội dung	số nguyên	Không	ID gói người dùng, bắt buộc nếu loại gói là 11

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Gửi yêu cầu POST để xóa địa chỉ IP khỏi danh sách trắng.

POST /ep/proxy-ip/delete

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» app_key	body	string	No	Khóa xác thực
» ips	body	string	Có	Các địa chỉ IP được đưa vào danh sách trắng cần xóa, nhiều địa chỉ IP được phân cách bằng dấu phẩy
» verify_type	body	string	No	Loại xác thực: điện thoại, email, wechat, totp
» verify_code	body	string	No	Mã xác minh

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	null	false	không có	không có

Gửi yêu cầu POST để sửa đổi địa chỉ IP; ghi chú danh sách trắng

POST /ep/white-ip/change-remark

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» địa chỉ IP	nội dung	chuỗi (IPv4)	có	không
» nhận xét	nội dung	chuỗi	có	không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Phương thức POST làm mới địa chỉ IP của không gian tài nguyên hiện tại và bộ nhớ đệm xác thực danh sách trắng.

POST /ep/white-ip/refresh

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Lấy hạn mức danh sách trắng IP cho loại sản phẩm được chỉ định

GET /ep/white-ip/quota

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
loại_sản_phẩm	truy vấn	số_nguyên	có	không

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Nhận hạn mức danh sách trắng IP cho tất cả các loại sản phẩm

GET /ep/white-ip/quotas

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Trích xuất IP

Số lần trích xuất IP theo ngày

GET /ep/user-extract-ip/days

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
ngày bắt đầu	truy vấn	chuỗi (ngày)	Không	Mặc định: 6 ngày trước
ngày_kết_thúc	truy vấn	chuỗi(ngày)	Không	Mặc định: Hôm nay
loại_sản_phẩm	truy vấn	số_nguyên	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm	9
loại_sản_phẩm	17
loại_sản_phẩm	22

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	không có
» tin nhắn	chuỗi	sai	không có	không có
» request_id	chuỗi	false	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» số lượng	số nguyên	đúng	không có	không có
»»» ngày	chuỗi (ngày)	đúng	không có	không có

Lấy thông tin địa chỉ IP

GET /ep/ip/v3

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Có thể bỏ qua Khóa đội; khóa đội phải khớp với đội được liên kết với khóa đó.
app_key	truy vấn	chuỗi (mật khẩu)	Có	Khóa truy cập
cc	truy vấn	chuỗi	Không	Quốc gia hoặc khu vực
trạng thái	truy vấn	chuỗi	Không	Tỉnh hoặc Bang
thành phố	truy vấn	chuỗi	Không	thành phố
định dạng	truy vấn	chuỗi	Không	Lấy định dạng
lb	truy vấn	chuỗi	Không	Dấu phân cách, chỉ hợp lệ cho định dạng văn bản
num	truy vấn	số	Không	Số lượng mục cần truy xuất
cuộc sống	truy vấn	số	Không	Giữ khoảng thời gian - phút
ep	truy vấn	chuỗi	Không	Mạng proxy

Giá trị liệt kê

Thuộc tính	Giá trị
tập	chúng tôi
ep	hk
ep	de

Quay lại ví dụ

200 Phản hồi

{
  "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"
      ]
    ]
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[bất kỳ]	sai	không có	không có

Tải xuống danh sách thành phố khu vực động V4

GET /ep/ip/dcl4

Việc truy xuất danh sách thành phố theo tên người dùng yêu cầu xác thực đăng nhập, và tài khoản phải thuộc về người dùng hiện tại.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
tên người dùng	truy vấn	chuỗi	là	Tên người dùng tài khoản ủy quyền

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» bộ nhớ đệm	boolean	false	none	Cho dù nó đến từ bộ nhớ đệm hay không
»» danh sách	[đối tượng]	false	không có	không có
»»» Thành phố	chuỗi	false	không có	thành phố
»»» Khu vực	chuỗi	false	không có	Vùng
»»» Tiểu bang	chuỗi	false	không có	Tiểu bang/Tỉnh

Tải xuống danh sách động các tiểu bang/tỉnh V4

GET /ep/ip/dsl4

Việc truy xuất danh sách các tiểu bang/tỉnh theo tên người dùng yêu cầu xác thực đăng nhập, và tài khoản phải thuộc về người dùng hiện tại.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
tên người dùng	truy vấn	chuỗi	là	Tên người dùng tài khoản ủy quyền

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» bộ nhớ đệm	boolean	false	none	Cho dù nó đến từ bộ nhớ đệm hay không
»» danh sách	[đối tượng]	false	không có	không có
»»» Thành phố	chuỗi	false	không có	thành phố
»»» Khu vực	chuỗi	false	không có	Vùng
»»» Tiểu bang	chuỗi	false	không có	Tiểu bang/Tỉnh

Tải xuống Danh sách tích hợp thành phố khu vực/tỉnh động V4

GET /ep/ip/dal4

Truy xuất danh sách hợp nhất các tiểu bang/tỉnh và thành phố theo tên người dùng, được nhóm theo khu vực. Cần xác thực đăng nhập và tài khoản phải thuộc về người dùng hiện tại.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
tên người dùng	truy vấn	chuỗi	là	Tên người dùng tài khoản ủy quyền

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	sai	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» bộ nhớ đệm	boolean	false	none	Cho dù nó đến từ bộ nhớ đệm hay không
»» danh sách	[đối tượng]	false	không có	Danh sách các vùng
»»» Khu vực	chuỗi	false	không có	Mã vùng
»»» các tiểu bang	[đối tượng]	false	không có	Danh sách các tiểu bang/tỉnh
»»»» Bang	chuỗi	false	không có	Tên Bang/Tỉnh
»»»» các thành phố	[chuỗi]	false	không có	Danh sách các thành phố

Danh sách thành phố

GET /ep/ip/dynamic-citys

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	danh sách
»»» name_zh_cn	chuỗi	false	không có	Tên quốc gia hoặc khu vực
»»» tên_tiếng Anh	chuỗi	false	không có	Tên quốc gia hoặc khu vực
»»» mã lục địa	chuỗi	false	không có	Mã lục địa
»»» mã_quốc_gia	chuỗi	false	không có	mã_quốc_gia_hoặc_vùng
»»» mục	[đối tượng]	sai	không có	Tỉnh hoặc Bang
»»»» thành phố	chuỗi	false	không có	Tên thành phố
»»»» trạng thái	chuỗi	false	không có	Mã tên tỉnh hoặc tiểu bang
»»»» mã lục địa	chuỗi	false	không có	Mã lục địa
»»»» mã_quốc_gia	chuỗi	false	không có	mã_quốc_gia_hoặc_vùng

Tìm kiếm thành phố

GET /ep/ip/dynamic-citys/search

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
mã_quốc_gia	truy vấn	chuỗi	Có	Mã quốc gia hoặc khu vực
trạng thái	truy vấn	chuỗi	là	mã tiểu bang hoặc tỉnh

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[chuỗi]	false	không có	danh sách

Lấy danh sách tiểu bang

GET /ep/ip/dynamic-states

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	danh sách
»»» name_zh_cn	chuỗi	false	không có	Tên quốc gia hoặc khu vực
»»» tên_tiếng Anh	chuỗi	false	không có	Tên quốc gia hoặc khu vực
»»» mã lục địa	chuỗi	false	không có	Mã lục địa
»»» mã_quốc_gia	chuỗi	false	không có	mã_quốc_gia_hoặc_vùng
»»» mục	[đối tượng]	sai	không có	Tỉnh hoặc Bang
»»»» trạng thái	chuỗi	false	không có	Mã tên tỉnh hoặc tiểu bang
»»»» mã lục địa	chuỗi	false	không có	Mã lục địa
»»»» mã_quốc_gia	chuỗi	false	không có	mã_quốc_gia_hoặc_vùng

Tìm kiếm theo tiểu bang/tỉnh

GET /ep/ip/dynamic-states/search

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
mã_quốc_gia	truy vấn	chuỗi	Có	Mã quốc gia hoặc khu vực

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[chuỗi]	false	không có	danh sách

Gửi yêu cầu POST để lấy danh sách các địa chỉ IP tĩnh được gán cho các trung tâm dữ liệu.

POST /ep/ip/get-datacenter-assign-ip-list

Đã lỗi thời, khuyến nghị sử dụng. /openapi/user-product/datacenter-isp-ip-listĐể đảm bảo khả năng tương thích với các máy khách cũ, API này sử dụng phương thức POST, nhưng tất cả các tham số bộ lọc đều được đọc từ truy vấn.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc truyền dưới dạng chuỗi rỗng; khóa nhóm có thể được bỏ qua, nhưng phải khớp với khóa khi được truyền vào
khu vực	truy vấn	chuỗi	Không	Mã quốc gia/vùng
trạng thái	truy vấn	số nguyên	Không	0 = tất cả, 1 = hợp lệ, 2 = đã hết hạn
trade_no	query	string	No	Order number
created_at	query	array[string]	No	Khoảng thời gian tạo; phải cung cấp cả thời gian bắt đầu và kết thúc.

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy danh sách các địa chỉ IP tĩnh đã mua.

GET /ep/ip/get-static-ip

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
mã_quốc_gia	truy vấn	chuỗi	Không	Mã quốc gia hoặc khu vực
loại_sản_phẩm	truy_vấn	số	Không	Loại sản phẩm, 25: Địa chỉ IP tĩnh cho hộ gia đình, 14: Địa chỉ IP trung tâm dữ liệu
trade_no	query	string	No	Lọc theo số đơn hàng
trang	truy vấn	số	Không	Số trang
kích thước	truy vấn	số lượng	Không	Số lượng trên mỗi trang
trạng thái	truy vấn	số	Không	Trạng thái, 1: Hợp lệ, 2: Không hợp lệ, 3: Sắp hết hạn, 4: Đang bảo trì

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm	14
loại_sản_phẩm	25
trạng thái	1 - 2 - 3 - 4

Quay lại ví dụ

200 Phản hồi

{}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	không có	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy số lượng địa chỉ IP tĩnh có sẵn trong các khu vực đang bán.

GET /ep/ip/static-ip-region

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
ISP	truy vấn	số nguyên	Không	Bộ lọc ISP, không lọc nếu không được cung cấp (ngoại trừ các trang 1/4/5, mặc định là 1)
asn	truy vấn	số nguyên	Không	Có trả về dữ liệu được nhóm theo ASN hay không
độc quyền	truy vấn	số nguyên	Không	Có tính toán tồn kho theo phương pháp độc quyền hay không

Mô tả chi tiết

Nhà cung cấp dịch vụ Internet (ISP): Lọc nội dung bởi ISP; không lọc nếu không có thông tin nào được tải lên (ngoại trừ các trang 1/4/5, mặc định là 1).

Giá trị	Mô tả
0	Địa chỉ IP tĩnh cho Trung tâm dữ liệu (IDC)
1	Địa chỉ IP tĩnh dành cho hộ gia đình (Nhà cung cấp dịch vụ Internet)

asn: Có trả về dữ liệu nhóm ASN hay không

Giá trị	Mô tả
0	Không trả về dữ liệu được nhóm theo ASN (mặc định)
1	Trả về dữ liệu nhóm ASN

Độc quyền: Liệu hàng tồn kho có được tính là hàng độc quyền hay không.

Giá trị	Mô tả
0	Thống kê dựa trên người dùng/nhóm chia sẻ hiện tại (mặc định)
1	Loại trừ tất cả các địa chỉ IP đã được chỉ định và chỉ tính số lượng hàng tồn kho khả dụng

Giá trị liệt kê

Thuộc tính	Giá trị
nhà cung cấp dịch vụ internet	0
nhà cung cấp dịch vụ internet	1
asn	0
asn	1
độc quyền	0
độc quyền	1

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55
      }
    ]
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» mã	chuỗi	đúng	không có	Mã quốc gia hoặc khu vực
»»» số	số nguyên	đúng	không có	số lượng

Yêu cầu GET truy xuất host_pool. Các quốc gia/vùng lãnh thổ được hỗ trợ.

GET /ep/host-pool/regions

Truy vấn danh sách các quốc gia/vùng lãnh thổ được hỗ trợ bởi trang web hiện tại của dịch vụ host_pool.

Giao diện này được thiết kế cho các trường hợp địa chỉ IP trung tâm dữ liệu được trích xuất ngẫu nhiên dựa trên các điểm lưu lượng truy cập, và chỉ tính quốc gia/vùng của kho địa chỉ IP trung tâm dữ liệu hiện có cho trang web hiện tại.

Quay lại ví dụ

200 Phản hồi

{
  "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"
      }
    ]
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái, 200 Thành công
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» mã	chuỗi	đúng	không có	Mã quốc gia hoặc khu vực, ISO 3166-1 alpha-2
»»» số	số nguyên	đúng	không có	Số lượng địa chỉ IP trung tâm dữ liệu khả dụng cho trang web hiện tại
»»» tên_zh_cn	chuỗi	false	không có	Tên tiếng Trung của quốc gia hoặc khu vực
»»» name_en	chuỗi	false	không có	Tên quốc gia hoặc khu vực bằng tiếng Anh
»»» cờ vuông	chuỗi	false	không có	URL hình ảnh cờ vuông

Truy vấn nhật ký lưu lượng truy cập

Bài đăng Tóm tắt lưu lượng truy cập gần đây theo ngày

POST /ep/user-usage-flow/days

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» ngày	cơ thể	số nguyên	không	không có
» loại sản phẩm	thân máy	số nguyên	không	không có
» tên người dùng	nội dung	chuỗi	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Lịch sử sử dụng lưu lượng truy cập của tài khoản proxy POST

POST /ep/user-usage-flow/username-total

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

POST xuất dữ liệu sử dụng hàng tháng của tài khoản proxy

POST /ep/user-usage-flow/export-csv

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

Quay lại ví dụ

200 Phản hồi

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Tệp CSV được mã hóa GBK	chuỗi

Kiểm tra tổng dung lượng dữ liệu cho phép và dung lượng dữ liệu còn lại.

GET /ep/user-usage-flow/flow-total

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
đơn vị	truy vấn	chuỗi	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
đơn vị	KB
đơn vị	MB
đơn vị	GB
đơn vị	TB
đơn vị	PB

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
đơn vị	KB
đơn vị	MB
đơn vị	GB
đơn vị	TB
đơn vị	PB

Nhận bảng giá hàng ngày

GET /ep/user-usage-flow/rate-graph

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
bắt đầu	truy vấn	chuỗi (ngày)	không	không có
kết thúc	truy vấn	chuỗi (ngày)	không	không có
tên người dùng	truy vấn	chuỗi	không	không có
user_product_id	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Thống kê lưu lượng truy cập bộ nhớ đệm hàng ngày

GET /ep/user-usage-flow/cache-total

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
thời gian bắt đầu	truy vấn	chuỗi	không	không có
thời_gian_kết_thúc	truy_vấn	chuỗi	không	không có
loại_sản_phẩm	truy vấn	số_nguyên	không	không có
tên người dùng	truy vấn	chuỗi	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận bản tóm tắt dữ liệu sử dụng theo ngày

GET /ep/user-usage-flow/total

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
app_key	truy vấn	chuỗi (mật khẩu)	Có	Khóa xác thực
start_time	query	string(Ymd H:i:s)	No	Thời gian bắt đầu, chính xác đến từng giây. Xin lưu ý rằng có độ trễ lên đến 5 phút trong quá trình ghi nhật ký. Mặc định là trong vòng 7 ngày.
end_time	query	string(Ymd H:i:s)	No	Thời gian kết thúc, chính xác đến từng giây. Xin lưu ý rằng có độ trễ lên đến 5 phút trong quá trình ghi nhật ký. Mặc định là thời gian hiện tại.
tên người dùng	truy vấn	chuỗi	Không	Tên tài khoản phụ. Mặc định là truy vấn tất cả các tài khoản; bạn có thể chỉ định một tài khoản phụ. Xin lưu ý rằng nếu bạn thêm một tài khoản phụ có cùng tên, truy vấn này sẽ trả về tất cả các bản ghi sử dụng của cùng một tài khoản proxy.
loại_sản_phẩm	truy vấn	số	Không	Loại_gói

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» ngày	chuỗi	false	không có	ngày
»»» lưu lượng	số nguyên	false	không có	Mức tiêu thụ lưu lượng, tính bằng KB

Nhật ký Proxy

Lấy số liệu thống kê truy cập proxy IP của máy khách

GET /ep/http-t-dom/list-v2

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
thời gian bắt đầu	truy vấn	chuỗi (ngày)	không	không có
thời_gian_kết_thúc	truy_vấn	chuỗi(ngày)	không	không có
xuất khẩu	truy vấn	chuỗi	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
xuất	csv

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Thống kê JSON;`export=csv` Trả về một tập tin CSV	chuỗi

Tỷ lệ phần trăm yêu cầu GET từ địa chỉ IP của máy khách

GET /ep/http-t-dom/client-ip-proportion

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
thời gian bắt đầu	truy vấn	chuỗi (ngày)	không	không có
thời_gian_kết_thúc	truy_vấn	chuỗi(ngày)	không	không có
xuất khẩu	truy vấn	chuỗi	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
xuất	csv

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Kết quả phần trăm JSON;`export=csv` Trả về một tập tin CSV	chuỗi

Hóa đơn gia hạn hàng tháng

Nhận hóa đơn gia hạn tóm tắt tháng hiện tại

GET /ep/monthly-renewal-bill

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại	hiện tại
loại	tiếp theo

POST Kiểm tra tóm tắt đơn đặt hàng gia hạn hàng tháng

POST /ep/monthly-renewal-bill/check

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
thân thể	thân thể	Yêu cầu gia hạn hàng tháng	Có	Không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại	hiện tại
loại	tiếp theo

ĐĂNG Tạo đơn đặt hàng gia hạn tóm tắt hàng tháng

POST /ep/monthly-renewal-bill/create

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
thân thể	thân thể	Yêu cầu gia hạn hàng tháng	Có	Không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận bản tóm tắt hàng tháng về lịch sử gia hạn hóa đơn.

GET /ep/monthly-renewal-bill/history

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trade_no	truy vấn	chuỗi	không	không có
ngày bắt đầu	truy vấn	chuỗi (ngày)	không	không có
ngày_kết_thúc	truy vấn	chuỗi(ngày)	không	không có
trang	truy vấn	số nguyên	không	không có
kích thước	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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": [null]
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Quản lý hóa đơn

Lấy thông tin chi tiết tiêu đề hóa đơn

GET /ep/user-invoice/info

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
mã_hóa_đơn	truy vấn	chuỗi	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "user@example.com",
    "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_vai_trò	1
loại_vai_trò	2
loại_hóa_đơn	0
loại_hóa_đơn	1
loại_hóa_đơn	2

Bài đăng Tạo hoặc chỉnh sửa tiêu đề hóa đơn

POST /ep/user-invoice/create

Các tham số yêu cầu thân

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "user@example.com",
  "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
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	bất kỳ	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Yêu cầu thành công, dữ liệu là null	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy danh sách tiêu đề hóa đơn

GET /ep/user-invoice/list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_vai_trò	1
loại_vai_trò	2
loại_hóa_đơn	0
loại_hóa_đơn	1
loại_hóa_đơn	2

Gửi yêu cầu POST để xóa tiêu đề hóa đơn

POST /ep/user-invoice/delete

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» mã_hóa_đơn	nội_thân	chuỗi	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Yêu cầu thành công, dữ liệu là null	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy danh sách hồ sơ hóa đơn

GET /ep/user-invoice/record-list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trạng thái	truy vấn	số nguyên	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_vai_trò	1
loại_vai_trò	2
loại_hóa_đơn	0
loại_hóa_đơn	1
loại_hóa_đơn	2

Gửi yêu cầu hóa đơn

POST /ep/user-invoice/submit

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» mã_hóa_đơn	nội_thân	chuỗi	có	không
» order_ids	nội dung	[số nguyên]	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Yêu cầu hủy hóa đơn POST

POST /ep/user-invoice/cancel

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» invoice_id	body	integer	is	none
» lý do	cơ thể	chuỗi	không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Yêu cầu thành công, dữ liệu là null	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận số liệu thống kê về số tiền hóa đơn

GET /ep/user-invoice/statistics

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy danh sách các đơn hàng có thể lập hóa đơn

GET /ep/user-invoice/invoiceable-orders

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Yêu cầu thông tin gói hàng

Danh sách gói hàng đã mua

GET /ep/user-product/list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
app_key	truy vấn	chuỗi (mật khẩu)	Có	Khóa xác thực
trade_no	query	string	No	Số đơn hàng. Vui lòng nhập đầy đủ số đơn hàng. Tìm kiếm mờ không được hỗ trợ.
trang	truy vấn	số	Không	Phân trang, mặc định: 1
kích thước	truy vấn	số lượng	Không	Số lượng mục hiển thị trên mỗi trang, mặc định: 20
loại_sản_phẩm	truy vấn	số	Không	Loại_gói

Quay lại ví dụ

200 Phản hồi

{
  "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
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu tới	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	đúng	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	đúng	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	[đối tượng]	false	không có	không có
»»» id	số nguyên	false	không có	Số gói hàng
»»» created_at	chuỗi	false	không có	Thời gian có hiệu lực của gói
»»» expired_at	chuỗi	false	không có	Ngày hết hạn của gói dữ liệu. Dữ liệu sẽ không khả dụng sau khi gói hết hạn.
»»» loại sản phẩm	loại sản phẩm	false	none	Loại gói cước: 9 Gói lưu lượng truy cập dân cư động, 11 Gói IP dân cư động, 14 Gói IP trung tâm dữ liệu tĩnh, 25 Gói IP dân cư tĩnh
»»» trade_no	chuỗi	false	không có	Số giao dịch đơn hàng
»»» thứ tự	đối tượng	sai	không có	không có
»»»» created_at	chuỗi	false	không có	Thời gian tạo đơn hàng
»»»» pay_at	chuỗi	false	không có	Thời gian thanh toán đơn hàng
»»»» tiêu đề	chuỗi	false	không có	Mô tả đơn hàng
»» trang	số nguyên	đúng	không có	Trang hiện tại
»» kích thước trang	số nguyên	false	không có	Kích thước trang
»» tổng số lượng	số nguyên	false	không có	Tổng số bản ghi
»» total_page	integer	false	none	Tổng số trang

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm	9
loại_sản_phẩm	11
loại_sản_phẩm	14
loại_sản_phẩm	25

Lấy tóm tắt dữ liệu gói người dùng

GET /ep/user-product/summary

Thu thập thông tin tóm tắt thống kê về các gói cước của người dùng, bao gồm tổng số tiền, số tiền còn hiệu lực, số tiền sắp hết hạn và số tiền đã hết hạn.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
app_key	truy vấn	chuỗi (mật khẩu)	Có	Khóa xác thực
product_type	query	integer	No	Loại sản phẩm, chỉ hỗ trợ 9 (gói lưu lượng truy cập động) và 12 (gói lưu lượng truy cập IDC dài hạn)

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm	9
loại_sản_phẩm	12

Quay lại ví dụ

200 Phản hồi

{
  "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
  }
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» mã	số nguyên	false	không có	Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ, 156 Tài khoản chưa được xác minh
» msg	chuỗi	false	không có	Thông báo trạng thái
» dữ liệu	đối tượng	sai	không có	không có
»» tổng	số nguyên	false	không có	Tổng lưu lượng truy cập/dung lượng IP (đơn vị: KB)
»» tổng số lượng	số nguyên	false	không có	Tổng số gói hàng
»» hiệu quả	số nguyên	sai	không có	Lượng còn lại hiệu quả (đơn vị: KB)
»» effective_count	integer	false	none	Số lượng gói hàng hiệu quả
»» tổng hiệu quả	số nguyên	false	không có	Tổng hiệu quả (đơn vị: KB)
»» effective_used	integer	false	none	Dữ liệu sử dụng hiệu quả (tính bằng KB)
»» tạm thời	số nguyên	false	không có	Tổng số lượng sắp hết hạn (hết hạn trong vòng 7 ngày, đơn vị: KB)
»» temporary_count	integer	false	none	Số lượng gói hàng sắp hết hạn (hết hạn trong vòng 7 ngày)
»» đã hết hạn	số nguyên	false	không có	Số lượng đã hết hạn (tính bằng KB)
»» expired_count	integer	false	none	Số lượng gói hàng đã hết hạn
»» đã sử dụng	số nguyên	false	không có	Tổng số KB đã sử dụng

Danh sách địa chỉ IP tĩnh POST

POST /ep/user-product/datacenter-isp-ip-list

Các tham số yêu cầu thân

{
  "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"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» trạng thái	nội dung	số nguyên	không	không có
» trang	nội dung	số nguyên	không	không có
» kích thước	thân	số nguyên	không	không có
» user_product_id	nội dung	số nguyên	không	không có
» mã quốc gia	nội dung	chuỗi	không	không có
» loại sản phẩm	thân máy	số nguyên	không	không có
» địa chỉ IP	nội dung	chuỗi (IPv4)	không	không có
» tự động gia hạn	nội dung	số nguyên	không	không có
» gia hạn hỗ trợ	nội dung	số nguyên	không	không có
» số ngày còn lại	nội dung	số nguyên	không	không có
» limit_days	body	integer	no	none
» sắp xếp	nội dung	chuỗi	không	không có
» nhận xét	nội dung	chuỗi	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» tự động gia hạn	0
» tự động gia hạn	1
» gia hạn hỗ trợ	0
» gia hạn hỗ trợ	1
» sắp xếp	exp_asc
» sắp xếp	exp_desc

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Gửi yêu cầu xóa các gói đã hết hạn.

POST /ep/user-product/delete

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» id	body	integer	is	none

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

POST Xóa hàng loạt các gói đã hết hạn

POST /ep/user-product/batch-delete

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [1]
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» id	nội dung	[số nguyên]	có	không

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Gửi yêu cầu POST để chỉnh sửa ghi chú gói hàng

POST /ep/user-product/change-remark

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» id	body	integer	is	none
» nhận xét	nội dung	chuỗi	có	không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Thiết lập hàng loạt POST cho bộ chuyển mạch UDP IP tĩnh

POST /ep/user-product/set-ip-udp

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [1],
  "udp": 0
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» id	nội dung	[số nguyên]	có	không
» udp	thân	số nguyên	là	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» udp	0
» udp	1

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Quản lý gói hàng

Gửi yêu cầu POST để thay đổi địa chỉ IP tĩnh của nhà cung cấp dịch vụ Internet (ISP) trung tâm dữ liệu.

POST /ep/user-product/change-datacenter-isp-ip

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» id	nội dung	số nguyên	là	ID gói người dùng
» mã_quốc_gia	nội_thân	chuỗi	Không	Mã quốc gia/vùng đích; nếu không được cung cấp, mã quốc gia/vùng của địa chỉ IP hiện tại sẽ được sử dụng trước.
» ip	nội dung	chuỗi	Không	Bộ lọc tiền tố IP mục tiêu

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy bản ghi thay đổi địa chỉ IP tĩnh

GET /ep/user-product/ip-change-log

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Cài đặt POST để thiết lập công tắc tự động gia hạn cho một gói cước duy nhất

POST /ep/user-product/set-auto-renewal

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» user_product_id	nội dung	số nguyên	có	không
» trạng thái	nội dung	số nguyên	Không	0 = bị vô hiệu hóa, 1 = được kích hoạt

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Thiết lập hàng loạt POST để tự động gia hạn gói đăng ký

POST /ep/user-product/batch-set-auto-renewal

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [1],
  "status": 0
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» user_product_ids	nội dung	[số nguyên]	có	không
» trạng thái	nội dung	số nguyên	Không	0 = bị vô hiệu hóa, 1 = được kích hoạt

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công; kết quả xử lý được trả về độc lập cho từng gói	Trực tuyến

Cấu trúc dữ liệu trả về

Phương thức POST thiết lập các tham số tự động gia hạn mặc định cho loại sản phẩm.

POST /ep/user-product/set-auto-renewal-default-config

Ít nhất một trong các tham số days_before_expire, traffic_threshold và refreshal_cycle_days phải được đáp ứng; giá trị 0 cho biết cấu hình tương ứng được đặt lại.

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» loại sản phẩm	thân máy	số nguyên	có	không
» ngày_trước_hết_hạn	nội dung	số nguyên	không	không có
» traffic_threshold	body	integer	No	Unit: GB, supported only on 9/12/24
» renewal_cycle_days	body	integer	No	Chỉ hỗ trợ cho chu kỳ 11/14/16/25 ngày và phải là chu kỳ sản phẩm hiện tại.
»ẩn danh	cơ thể	đối tượng	không	không có
»ẩn danh	cơ thể	đối tượng	không	không có
»ẩn danh	cơ thể	đối tượng	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» loại sản phẩm	9
» loại sản phẩm	11
» loại sản phẩm	12
» loại sản phẩm	14
» loại sản phẩm	16
» loại_sản_phẩm	24
» loại_sản_phẩm	25

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Yêu cầu thành công, dữ liệu là null	Nội tuyến

Cấu trúc dữ liệu trả về

Yêu cầu POST truy xuất các tham số tự động gia hạn mặc định cho loại sản phẩm.

POST /ep/user-product/get-auto-renewal-default-config

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» product_type	body	integer	No	Nếu không được chỉ định, tất cả các loại được hỗ trợ sẽ được trả về

Giá trị liệt kê

Thuộc tính	Giá trị
» loại sản phẩm	9
» loại sản phẩm	11
» loại sản phẩm	12
» loại sản phẩm	14
» loại sản phẩm	16
» loại_sản_phẩm	24
» loại_sản_phẩm	25

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": "[",
        "days_before_expire": 0,
        "source": "[",
        "renewal_cycle": {},
        "traffic_threshold": 0,
        "traffic_source": "["
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm	9
loại_sản_phẩm	11
loại_sản_phẩm	12
loại_sản_phẩm	14
loại_sản_phẩm	16
loại_sản_phẩm	24
loại_sản_phẩm	25
nguồn	người dùng
nguồn	hệ thống
nguồn	người dùng
nguồn	hệ thống
nguồn_lưu_lượng	người_dùng
nguồn_lưu_lượng	hệ_thống

Gửi yêu cầu POST để truy xuất cấu hình tự động gia hạn và xem trước thông tin gia hạn cho một gói cước duy nhất.

POST /ep/user-product/get-auto-renewal

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» user_product_id	nội dung	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
đơn vị thời gian	ngày
đơn vị thời gian	giờ
trạng thái	0
trạng thái	1

Gửi yêu cầu POST để truy xuất bản ghi thực thi gia hạn tự động.

POST /ep/user-product/auto-renewal-logs

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» user_product_id	nội dung	số nguyên	Không	Nếu không được chỉ định, hãy truy vấn tất cả các bản ghi trong không gian hiện tại
» trang	nội dung	số nguyên	không	không có
» kích thước	thân	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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": "[",
        "status": "[",
        "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
loại_kích_ứng	0
loại_kích_ứng	1
trạng thái	1
trạng thái	2
trạng thái	3

Quản lý đơn hàng

Lấy danh sách đơn hàng

GET /ep/order/list

Các đơn đặt hàng trong không gian nhóm cũng hiển thị thông tin người tạo, cho biết thành viên thực sự đã đặt hàng; quản trị viên và quản trị viên cấp cao có thể xem thông tin liên hệ đầy đủ, trong khi các vai trò khác nhận được thông tin liên hệ được ẩn danh.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId	Không	Mã định danh không gian tài nguyên theo thứ tự; không gian cá nhân có thể được bỏ qua hoặc có thể truyền một chuỗi rỗng
số_trang	truy vấn	số_nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có
trade_no	query	string	No	Order number
thời_gian_bắt_đầu	truy_vấn	chuỗi (ngày-giờ)	Không	Thời gian bắt đầu (bao gồm), ví dụ: 2024-01-01 00:00:00
thời_gian_kết_thúc	truy_vấn	chuỗi (ngày-giờ)	Không	Thời_gian_kết_thúc (không bao gồm)
trạng thái	truy vấn	số nguyên	Không	Trạng thái đơn hàng
loại_sản_phẩm	truy vấn	số_nguyên	Không	Loại_sản_phẩm
hóa đơn	truy vấn	số nguyên	Không	Trạng thái hóa đơn: 0 Không hạn chế, 1 Hóa đơn đã phát hành, -1 Hóa đơn chưa phát hành (có thể phát hành lại)
pay_fee_status	query	integer	No	Lọc theo số tiền dài/ngắn: 1. Trả thừa 2. Trả thiếu

Mô tả chi tiết

Trạng thái: Trạng thái đơn hàng

Trạng thái	Mô tả
0	Đang chờ thanh toán
1	Đã thanh toán
2	Chưa thanh toán sau khi thời gian chờ bị hủy
3	Đã nhận được tiền hoàn trả

product_type: Loại sản phẩm

Loại sản phẩm	Mô tả
3	Nạp tiền vào tài khoản
9	Gói dữ liệu linh hoạt
11	Gói Thời gian Toàn cầu Động V2
12	Gói lưu lượng IDC dài hạn
13	Gói lưu lượng IP tĩnh dành cho hộ gia đình
14	Gói IP tĩnh cho Trung tâm dữ liệu
15	Gói dữ liệu dài hạn của nhà cung cấp dịch vụ Internet
16	Gói dữ liệu tĩnh
17	Gói số lượng IP động
18	trình thu thập dữ liệu web
19	Gia hạn địa chỉ IP tĩnh
20	Thay đổi hạn mức IP tĩnh
21	Gói lưu lượng tĩnh v2
24	Gói bổ sung lưu lượng truy cập tĩnh
25	Gói IP tĩnh dành cho nhà ở
26	Thay thế đơn hàng - Một số kênh thanh toán yêu cầu người dùng nhập thủ công số tiền, chẳng hạn như tiền ảo. Nếu thiếu tiền, bạn cần liên hệ với dịch vụ khách hàng để thực hiện thanh toán thay thế thông qua sản phẩm này.
27	Rắn
28	Video

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
loại_sản_phẩm	3
loại_sản_phẩm	9
loại_sản_phẩm	11
loại_sản_phẩm	12
loại_sản_phẩm	14
loại_sản_phẩm	16
loại_sản_phẩm	17
loại_sản_phẩm	18
loại_sản_phẩm	19
loại_sản_phẩm	21
loại_sản_phẩm	24
loại_sản_phẩm	25
loại_sản_phẩm	26
loại_sản_phẩm	27
loại_sản_phẩm	28
hóa đơn	-1
hóa đơn	0
hóa đơn	1
trạng thái phí thanh toán	1
trạng thái phí thanh toán	2

Quay lại ví dụ

200 Phản hồi

{
  "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": {}
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Thành công	Trực tuyến

Cấu trúc dữ liệu trả về

POST Tạo đơn hàng

POST /ep/order/create

Do có nhiều gói sản phẩm khác nhau và mỗi gói có cấu hình khác nhau, vui lòng điền các thông số theo tình huống thực tế của bạn. Việc điền thông tin không chính xác có thể dẫn đến việc tạo đơn hàng không thành công.

Ví dụ:

Gia hạn địa chỉ IP tĩnh

{
    "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 接口获取
  }

Mua địa chỉ IP tĩnh dành cho nhà ở

{
  "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编号可选）
}

Mua IP trung tâm dữ liệu tĩnh

{
  "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编号可选）
}

Mua lưu lượng truy cập dân cư năng động

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
}

Mua lưu lượng truy cập xoay vòng tĩnh

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
}

Mua lưu lượng truy cập không giới hạn động

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID, // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  "product_sku_bandwidth_id": 带宽规格ID,
  "product_sku_concurrency_id": 并发规格ID
}

Nạp tiền vào tài khoản

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID, // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  "recharge_amount": 充值金额
}

Các tham số yêu cầu thân

{
  "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
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» pid	body	integer	Có	ID gói, từ trường id được trả về bởi giao diện /openapi/product
» upids	body	string	No	Danh sách ID gói gia hạn (phân cách bằng dấu phẩy), từ trường id được trả về bởi API /openapi/user-product/list hoặc /openapi/ip/get-static-ip
» số lượng	nội dung	số	Không	Số lượng gói hàng mới mua
» pm_id	nội dung	số nguyên	Có	ID phương thức thanh toán, từ trường id được trả về bởi API /openapi/payment/list hoặc /openapi/payment/groups
» region_list	body	string	No	Vui lòng chỉ định khu vực, số lượng và số ASN khi mua địa chỉ IP tĩnh. Định dạng: Khu vực, Số lượng, ASN
» coupon_sn	nội dung	chuỗi	Không	Mã phiếu giảm giá
» use_invitation_registration_discount	body	boolean	No	Có sử dụng mã giảm giá đăng ký lời mời hay không
» renew_duration	body	integer	No	Thời gian gia hạn - tùy chọn cho địa chỉ IP tĩnh
» product_sku_bandwidth_id	nội dung	số nguyên	Không	Gói 11: ID gói băng thông
» product_sku_concurrency_id	nội dung	số nguyên	Không	Gói 11: ID gói đồng thời
» product_sku_duration_id	nội dung	số nguyên	Không	Loại gói=11 Bắt buộc: ID thông số thời lượng
» etd	thân	số nguyên	Không	Hệ số nhân thời gian, lấy từ gói extension_of_time_days, 2 biểu thị số ngày × 2, giá tăng
» recharge_amount	body	integer	No	Gói 3: Số tiền nạp

Quay lại ví dụ

200 Phản hồi

{
  "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": "user@example.com",
      "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Tạo thành công	Nội tuyến

Cấu trúc dữ liệu trả về

ĐĂNG Hủy đơn hàng

POST /ep/order/close

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» trade_no	body	string	yes	none

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Nhận thông tin chi tiết đơn hàng

GET /ep/order/info

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trade_no	query	string	yes	none

Quay lại ví dụ

200 Phản hồi

{
  "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": null,
      "org_name": null,
      "first_name": null,
      "last_name": null,
      "phone": null,
      "email": null,
      "role_type": null,
      "vat_id": null,
      "address_country": null,
      "address_city": null,
      "address_line1": null,
      "address_line2": null,
      "address_postal_code": null
    }
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng tiếp tục kiểm tra mã trong phần thân phản hồi.	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy thông tin chi tiết đơn hàng V2

GET /ep/order/info-v2

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
order_id	truy vấn	chuỗi	Có	ID đơn hàng được mã hóa phía máy khách

Quay lại ví dụ

200 Phản hồi

{
  "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": null,
      "org_name": null,
      "first_name": null,
      "last_name": null,
      "phone": null,
      "email": null,
      "role_type": null,
      "vat_id": null,
      "address_country": null,
      "address_city": null,
      "address_line1": null,
      "address_line2": null,
      "address_postal_code": null
    }
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	HTTP thành công; dữ liệu đơn hàng có thể kèm theo mã lỗi nghiệp vụ nếu đơn hàng đã được thanh toán hoặc hủy	Nội tuyến

Cấu trúc dữ liệu trả về

Gửi yêu cầu POST để phát hành lại hóa đơn cho các đơn hàng cũ.

POST /ep/order/reissue-invoice

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» trade_no_list	nội dung	[chuỗi]	có	không

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Kiểm tra trước khi đặt hàng POST

POST /ep/order/check

Chức năng này được gọi trước khi tạo đơn hàng để xem trước giá cả, chiết khấu, chi tiết gia hạn IP, v.v., và không thực sự tạo ra đơn hàng. Các tham số và /openapi/order/create Hoàn toàn nhất quán.

Các tham số yêu cầu thân

{
  "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
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» pid	nội dung	số nguyên	Có	ID gói
» upids	nội dung	chuỗi	Không	Gia hạn IP: Danh sách ID gói người dùng, phân tách bằng dấu phẩy
» số tiền	nội dung	số nguyên	Không	Số lượng mua
» pm_id	nội dung	số nguyên	Có	ID phương thức thanh toán
» region_list	body	string	Không	Mua IP tĩnh theo vùng + số lượng, định dạng: ID vùng, số lượng
» coupon_sn	nội dung	chuỗi	Không	Mã phiếu giảm giá
» renew_duration	body	string	No	Thời hạn gia hạn IP: 1m = 1 tháng, 2m = 2 tháng, em = cuối tháng tiếp theo
» product_sku_bandwidth_id	nội dung	số nguyên	Không	Loại gói=11 Bắt buộc: ID thông số băng thông
» product_sku_concurrency_id	nội dung	số nguyên	Không	Loại gói=11 Bắt buộc: ID đặc tả đồng thời
» product_sku_duration_id	nội dung	số nguyên	Không	Loại gói=11 Bắt buộc: ID thông số thời lượng
» etd	thân	số nguyên	Không	Hệ số nhân thời lượng, lấy từ gói extension_of_time_days
» recharge_amount	body	number	No	Loại gói cước=3 Bắt buộc: Số tiền nạp

Giá trị liệt kê

Thuộc tính	Giá trị
» renew_duration	1m
» thời gian gia hạn	2 phút
» gia hạn_thời_gian	em

Quay lại ví dụ

200 Phản hồi

{
  "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": {}
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Kiểm tra sơ bộ thành công	Trực tuyến

Cấu trúc dữ liệu trả về

Quản lý thanh toán

Gửi yêu cầu POST để bắt đầu thanh toán đơn hàng

POST /ep/pay

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trade_no	query	string	yes	none
pm_id	truy vấn	số nguyên	không	không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Gửi yêu cầu POST để bắt đầu thanh toán cho các đơn hàng chưa thanh toán được đặt ở phần quản trị.

POST /ep/pay/index-choose

Các tham số yêu cầu thân

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» team_id	body	any	No	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân và trả về chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự
»»ẩn danh	nội dung	chuỗi	không	không có
»»ẩn danh	nội dung	TeamPublicId	Không	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ bao gồm các chữ cái ASCII và số; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
» trade_no	body	string	yes	none
» phương thức thanh toán	nội dung	số nguyên	không	không có
» pm_id	nội dung	số nguyên	không	không có
» loại giao dịch	nội dung	chuỗi	không	không có

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Thao tác thành công	Không có

Xác minh thanh toán POST và xem trước phí

POST /ep/pay/pay-check

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trade_no	query	string	yes	none
pm_id	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "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": null,
      "type": null,
      "title": null,
      "group": null,
      "handling_rate": null,
      "handling_fee": null,
      "handling_fee_currency": null,
      "handling_fee_converted": null
    },
    "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Yêu cầu thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Các yêu cầu GET trực tiếp hiển thị trang thanh toán trực tuyến.

GET /ep/pay/web-direct-pay

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
team_id	truy vấn	ResourceSpaceId Không	không có
trade_no	query	string	yes	none
pm_id	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

"string"

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	Trang thanh toán HTML	chuỗi

Phương thức GET được sử dụng để truy xuất danh sách các phương thức thanh toán.

GET /ep/payment/list

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
trade_no	query	string	No	Số đơn hàng - Có thể được truyền vào khi cần phương thức thanh toán cụ thể cho một số đơn hàng
tiền tệ	truy vấn	chuỗi	không	đơn vị tiền tệ

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Đã truy xuất thành công	Nội tuyến

Cấu trúc dữ liệu trả về

Phương thức GET được sử dụng để truy xuất danh sách các phương thức thanh toán.

GET /ep/payment/groups

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
trade_no	query	string	No	Số đơn hàng - Có thể được truyền vào khi cần phương thức thanh toán cụ thể cho một số đơn hàng

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [null],
        "items": [null]
      }
    ]
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI Đã truy xuất thành công	Nội tuyến

Cấu trúc dữ liệu trả về

tiếp thị

Nhận tỷ lệ tiền thưởng nạp tiền

GET /ep/activity/balance-recharge-gift-ratio

Tỷ lệ tiền thưởng nạp tiền

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	OK	Nội tuyến

Cấu trúc dữ liệu trả về

sản phẩm

Lấy danh sách sản phẩm

GET /ep/product

Lấy danh sách các gói dịch vụ hiện có trên trang web hiện tại và lọc theo loại, thời hạn hiệu lực và các tiêu chí khác.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
loại	truy vấn	số nguyên	Không	Loại gói, xem mô tả liệt kê Product.type. Trả về tất cả các loại nếu không được chỉ định.
parent_product_type	query	integer	No	Loại gói cha, chỉ hợp lệ khi loại=19 (gia hạn IP), được sử dụng để lọc các dòng sản phẩm: 14=Trung tâm dữ liệu 25=Khu dân cư
time_days	query	any	No	Lọc theo thời gian hiệu lực tính bằng ngày, hỗ trợ giá trị đơn hoặc mảng, ví dụ: 30 / [30,90,365]
show_type	query	any	No	Hiển thị bộ lọc theo loại, hỗ trợ giá trị đơn hoặc mảng

Mô tả chi tiết

Loại: Loại bao bì, xem mô tả kiểu liệt kê Product.type. Nếu không được chỉ định, tất cả các loại sẽ được trả về.

Giá trị liệt kê

Thuộc tính	Giá trị
loại_sản_phẩm_cha	14
loại_sản_phẩm_cha	25

Quay lại ví dụ

200 Phản hồi

{
  "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": [null]
      },
      "sku": {
        "bandwidth_list": [null],
        "duration_list": [null],
        "concurrency_list": [null]
      }
    }
  ],
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI	OK	Nội tuyến

Cấu trúc dữ liệu trả về

Quản lý tài khoản

Nhận tổng quan về tài khoản cá nhân

GET /ep/account/profile

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Truy cập để kiểm tra số dư cá nhân và lịch sử giao dịch.

GET /ep/wallet/change-list

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
re_type	truy vấn	số nguyên	không	không có
loại giao dịch	truy vấn	số nguyên	không	không có
loại_số_dương	truy vấn	số_nguyên	không	không có
trang	truy vấn	số nguyên	không	không có
kích thước trang	truy vấn	số nguyên	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
re_type	0
re_type	1

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Xuất nhật ký

POST Tạo tác vụ xuất nhật ký Proxy

POST /ep/user-usage-flow-log-export/create

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; không hỗ trợ Khóa API nhóm. Thời gian bắt đầu phải sớm hơn thời gian kết thúc và khoảng thời gian không được vượt quá 31 ngày; mỗi người dùng chỉ được phép thực hiện một tác vụ xuất dữ liệu và giới hạn nhật ký là 5 triệu mục.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» thời gian bắt đầu	nội dung	số nguyên	Có	Dấu thời gian Unix bắt đầu, giây
» thời_gian_kết_thúc	nội_thân	số_nguyên	Có	Dấu_thời_gian_kết_thúc Unix, giây
» loại	nội dung	chuỗi	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» loại	động
» loại	nhóm máy chủ

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Lấy thông tin chi tiết về tác vụ xuất nhật ký truy vấn

GET /ep/user-usage-flow-log-export/detail

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
task_id	truy vấn	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	đang chờ xử lý
trạng thái	đang xử lý
trạng thái	đã hoàn thành
trạng thái	thất bại
trạng thái	đã hủy
trạng thái	không có dữ liệu

Lấy nhật ký truy vấn để xuất danh sách tác vụ

GET /ep/user-usage-flow-log-export/list

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
trang	truy vấn	số nguyên	không	không có
kích thước	truy vấn	số nguyên	không	không có

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	đang chờ xử lý
trạng thái	đang xử lý
trạng thái	đã hoàn thành
trạng thái	thất bại
trạng thái	đã hủy
trạng thái	không có dữ liệu

Phương thức POST hủy bỏ một tác vụ xuất nhật ký chưa được thực thi.

POST /ep/user-usage-flow-log-export/cancel

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; không hỗ trợ Khóa API nhóm. Chỉ có thể hủy các tác vụ trong hàng đợi chờ; các tác vụ đã thực hiện không thể bị hủy.

Các tham số yêu cầu thân

{
  "task_id": 1
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» task_id	nội dung	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

phiếu giảm giá

Gửi yêu cầu POST để nhận danh sách phiếu giảm giá cá nhân của bạn.

POST /ep/user-coupon/list

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Các tham số yêu cầu thân

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

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	không	không có
» trạng thái	nội dung	số nguyên	không	không có
» trang	nội dung	số nguyên	không	không có
» kích thước	thân	số nguyên	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1
» trạng thái	2

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

ĐĂNG để xem chi tiết phiếu giảm giá cá nhân

POST /ep/user-coupon/info

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Các tham số yêu cầu thân

{
  "id": 1
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» id	body	integer	is	none

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Quản lý thông báo

Nhận thông báo truy vấn trang web

GET /ep/notify/list

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
trang	truy vấn	số nguyên	không	không có
kích thước	truy vấn	số nguyên	không	không có
đọc	truy vấn	số nguyên	không	không có
loại	truy vấn	số nguyên	không	không có

Giá trị liệt kê

Thuộc tính	Giá trị
đọc	0
đọc	1

Quay lại ví dụ

200 Phản hồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái đọc	0
trạng thái đọc	1

Truy cập để xem chi tiết thông báo trên trang web.

GET /ep/notify/detail

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
id	truy vấn	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

{
  "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"
}

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái đọc	0
trạng thái đọc	1

POST đánh dấu các thông báo trên trang web là đã đọc.

POST /ep/notify/read

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Các tham số yêu cầu thân

{
  "id": 1
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» id	body	integer	is	none

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Đánh dấu hàng loạt thông báo nội bộ là đã đọc

POST /ep/notify/batch-read

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Các tham số yêu cầu thân

{
  "ids": [1]
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» id	nội dung	[số nguyên]	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Cấu hình kênh thông báo truy vấn GET

GET /ep/user-notify

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Nhận email thông báo truy vấn

GET /ep/user-notification-email/list

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

kịch bản thông báo truy vấn GET

GET /ep/user-notification-email/scenes

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Truy vấn GET cho các kịch bản đăng ký email

GET /ep/user-notification-email/email-scenes

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
id	truy vấn	số nguyên	có	không

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Cấu hình proxy

Truy vấn GET, chuyển đổi bộ nhớ đệm của đại lý cá nhân

GET /ep/proxy-cache/status

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1

Thiết lập POST, chuyển đổi bộ nhớ đệm của tác nhân cá nhân

POST /ep/proxy-cache/change

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Các tham số yêu cầu thân

{
  "status": 0
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» trạng thái	nội dung	số nguyên	có	không

Giá trị liệt kê

Thuộc tính	Giá trị
» trạng thái	0
» trạng thái	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Truy vấn GET, chuyển mạch UDP proxy cá nhân

GET /ep/user-proxy-config/udp

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
đã bật	0
đã bật	1

Gửi yêu cầu POST để thiết lập công tắc UDP proxy cá nhân

POST /ep/user-proxy-config/udp

Chỉ hỗ trợ trạng thái đăng nhập không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Các tham số yêu cầu thân

{
  "udp": 0
}

Tham số yêu cầu

Tên	Địa điểm	Loại	Bắt buộc	Mô tả
cơ thể	cơ thể	vật thể	có	không có
» udp	thân	số nguyên	là	không có

Giá trị liệt kê

Thuộc tính	Giá trị
» udp	0
» udp	1

Quay lại ví dụ

200 Phản hồi

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

Trả về kết quả

Mã trạng thái	Ý nghĩa mã trạng thái	Giải thích	Mô hình dữ liệu
200	ĐƯỢC RỒI HTTP thành công; vui lòng kiểm tra mã nghiệp vụ, mã 200 cho biết thành công.	Nội tuyến

Cấu trúc dữ liệu trả về

Giá trị liệt kê

Thuộc tính	Giá trị
đã bật	0
đã bật	1

Mô hình dữ liệu

Quản lý yêu cầu APIKey

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

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
team_id	ResourceSpaceId	false	none		Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền một chuỗi rỗng khi yêu cầu không gian cá nhân và trả về một chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 chữ số
id	số nguyên	đúng	không có		ID khóa API

Hồ sơ tài khoản API mở

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	đúng	không có	ID người dùng
tên người dùng	chuỗi	đúng	không có	Tên người dùng
biệt danh	chuỗi	đúng	không có	biệt danh
email	chuỗi	đúng	không có	liên kết email
số dư	chuỗi	đúng	không có	Số dư nạp tiền, chuỗi thập phân
số_dư_quà_tặng	chuỗi	đúng	không	Số dư quà tặng hiện tại, chuỗi thập phân
đơn vị tiền tệ	chuỗi	đúng	không có	Đơn vị tiền tệ của trang web
ngôn ngữ	chuỗi	đúng	không	Ngôn ngữ người dùng, được sử dụng khi chưa được cấu hình
múi giờ	chuỗi	đúng	không	Múi giờ người dùng, được sử dụng khi chưa được cấu hình

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
re_type	integer	false	none	0 chi tiêu, 1 thu nhập
loại giao dịch	số nguyên	sai	không có	Loại giao dịch
loại_số_dương	số_nguyên	sai	không có	Loại_số_dương
phí	chuỗi	false	không có	Số tiền thay đổi, đơn vị tiền tệ của trang web

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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	false	không có		Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
user_id	integer	false	none		Chi tiết API trả về
thời gian bắt đầu	chuỗi	false	không có		Ymd H:i:s; ngày không theo RFC 3339
thời_gian_kết_thúc	chuỗi	false	không có		Ymd H:i:s; ngày không theo RFC 3339
trạng thái	chuỗi	sai	không có		không có
kích thước_tệp	số_nguyên	null	false	không có
số_đếm_bản_ghi	số_nguyên_tử	null	false	không có
created_at	string	false	none		Ymd H:i:s; ngày không theo RFC 3339
completed_at	chuỗi	false	không có		Ymd H:i:s; ngày không theo RFC 3339
file_url	chuỗi	false	không có		Thông tin chi tiết được API trả về sau khi hoàn thành
download_url	chuỗi	false	không có		Trả về liên kết tải xuống đã được ký, có hiệu lực trong 24 giờ sau khi hoàn tất
thông báo lỗi	chuỗi	false	không có		API chi tiết có thể trả về một giá trị khi thất bại

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	đang chờ xử lý
trạng thái	đang xử lý
trạng thái	đã hoàn thành
trạng thái	thất bại
trạng thái	đã hủy
trạng thái	không có dữ liệu

Mã giảm giá OpenAPI

{
  "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
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	false	không có		Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
coupon_id	integer	false	none		Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
kiểu dữ liệu	số nguyên	false	không có		Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
trạng thái	số nguyên	sai	không có		Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
nguồn	số nguyên	sai	không có		Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
tiêu đề	chuỗi	sai	không có		không có
title_en	chuỗi	false	không có		không có
mô tả	chuỗi	sai	không có		không có
description_en	chuỗi	false	không có		không có
start_amount	string¦null	false	none		none
start_amount_usd	chuỗi¦null	false	không có		không có
start_amount_hkd	chuỗi¦null	false	không có		không có
khoản_giảm_giá	chuỗi ¦null	false	không có		không có
khoản_giảm_giá_USD	chuỗi ¦null	false	không có		không có
deduction_amount_hkd	string¦null	false	none		none
tỷ_giá_giảm_giá	chuỗi	null	false	không có
discount_ceiling_amount	string¦null	false	none		none
discount_ceiling_amount_usd	string¦null	false	none		none
discount_ceiling_amount_hkd	string¦null	false	none		none
created_at	string¦null	false	none		Ymd H:i:s
effect_at	string¦null	false	none		Ymd H:i:s
expired_at	string¦null	false	none		Ymd H:i:s
used_at	string¦null	false	none		Ymd H:i:s
loại_sản_phẩm	chuỗi	null	false	không có
dấu_thời_gian_tạo	số_nguyên	null	false	không có
effect_timestamp	integer¦null	false	none		none
expired_timestamp	integer¦null	false	none		none
used_timestamp	integer¦null	false	none		none
is_expired	boolean	false	none		Giao diện danh sách trả về

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
tiêu đề	chuỗi	sai	không có	không có
nội dung	chuỗi	false	không có	Nội dung được hiển thị theo ngôn ngữ yêu cầu
kiểu dữ liệu	số nguyên	false	không có	Các giá trị trong cơ sở dữ liệu có thể được chuyển đổi thành chuỗi
trạng thái đọc	số nguyên	sai	không có	không có
created_at	string	false	none	Ymd H:i:s; ngày không theo RFC 3339
dấu_thời_gian_tạo	số_nguyên	false	không có	không có

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái đọc	0
trạng thái đọc	1

loại sản phẩm

Các loại gói cước: Gói 9 lưu lượng truy cập dân cư động, Gói 11 địa chỉ IP dân cư động, Gói 14 địa chỉ IP trung tâm dữ liệu tĩnh, Gói 25 địa chỉ IP dân cư tĩnh.

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	số nguyên	false	không có		Loại gói: Gói lưu lượng truy cập dân cư động 9, IP dân cư động 11, IP trung tâm dữ liệu tĩnh 14, IP dân cư tĩnh 25

Giá trị liệt kê

Thuộc tính	Giá trị
ẩn danh	9
ẩn danh	11
ẩn danh	14
ẩn danh	25

apiKey

"pa$$word"

Khóa API; được truyền qua apiKeyAuth hoặc dưới dạng tham số yêu cầu trong phần khai báo thao tác.

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	chuỗi (mật khẩu)	false	không có		Khóa API; được truyền bằng apiKeyAuth hoặc dưới dạng tham số yêu cầu được khai báo trong câu lệnh thao tác

Mã phản hồi

Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	số nguyên	false	không có		Mã trạng thái: 200 Thành công, 3 Khóa ứng dụng không hợp lệ

Thông báo phản hồi

"success"

tin nhắn phản hồi

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	chuỗi	false	không có		thông báo phản hồi

Phản hồi thành công

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

tài sản

Không có

Phản hồi lỗi

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

tài sản

Không có

WebV1SuccessResponse

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

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
mã	số nguyên	đúng	không có		không có
tin nhắn	chuỗi	đúng	không có		không có
dữ liệu	đối tượng	null	true	không có
request_id	chuỗi	true	không có		ID theo dõi yêu cầu

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
mã	số nguyên	đúng	không có		Mã lỗi nghiệp vụ

không

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
»ẩn danh	bất kỳ	sai	không có		không có

tiếp tục

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
thông báo	chuỗi	đúng	không có		Mô tả lỗi
dữ liệu	đối tượng	null	true	không có
request_id	chuỗi	true	không có		ID theo dõi yêu cầu

TeamPublicId

"A1b2C3d4E5f6"

Mã định danh công khai của nhóm bắt đầu bằng một chữ cái ASCII, và các ký tự còn lại chỉ bao gồm các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	chuỗi	false	không có		Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; không được cấp làm khóa chính số trong cơ sở dữ liệu

ResourceSpaceId

"A1b2C3d4E5f6"

Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền chuỗi rỗng khi yêu cầu không gian cá nhân, và phản hồi bằng chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 ký tự.

tài sản

một trong

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	chuỗi	false	không có		không có

xor

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	TeamPublicId	false	none		Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.

Đội

{
  "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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	TeamPublicId	đúng	không có		Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
tên	chuỗi	đúng	không có		Tên đội
super_admin_user_id	integer	true	none		ID người dùng quản trị viên cấp cao
trạng thái	số nguyên	đúng	không có		Trạng thái đội: 0 = bị vô hiệu hóa, 1 = được kích hoạt, 2 = đang giải tán, 3 = đã giải tán
current_role	integer	null	true	none
dissolving_at	string¦null	true	none		Thời gian bắt đầu hòa tan
dissolved_at	string¦null	true	none		Thời gian hoàn thành quá trình hòa tan
created_at	string	true	none		Thời gian tạo
updated_at	chuỗi	true	không có		Thời gian cập nhật

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
vai trò hiện tại	1
vai trò hiện tại	2
vai trò hiện tại	3
vai trò hiện tại	4
vai trò hiện tại	null

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
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	đúng	không có		ID gói người dùng
user_id	integer	true	none		ID người dùng của chủ sở hữu tài nguyên
team_id	ResourceSpaceId	true	none		Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền một chuỗi rỗng khi yêu cầu không gian cá nhân và trả về một chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 chữ số
team_user_id	integer	true	none		ID người dùng thành viên thực tế
product_id	integer	true	none		Mã sản phẩm
loại_sản_phẩm	số_nguyên	đúng	không có		Loại_sản_phẩm
loại_sản_phẩm_cha	số_nguyên	đúng	không		Loại_sản_phẩm_cha
trạng thái	số nguyên	đúng	không có		Trạng thái gói hàng
tổng_số_tiền	số_nguyên_64	đúng	không có		Tổng số tiền
còn lại	số nguyên (int64)	đúng	không có		Số lượng còn lại
băng thông	số nguyên	false	không có		Băng thông (Mbps); chỉ được trả về cho product_type=19 hoặc 11
đồng thời	số nguyên	false	không có		Số lượng đồng thời; chỉ trả về nếu product_type=11
expired_at	chuỗi	null	true	không có
created_at	string	true	none		Thời gian tạo
ip	chuỗi	false	không có		Địa chỉ IP tĩnh; chỉ được trả về cho product_type=19
mã_quốc_gia	chuỗi	false	không có		Mã_quốc_gia_của_IP_tĩnh; chỉ được trả về nếu product_type=19
tên_quốc_gia	chuỗi	false	không có		Địa chỉ IP tĩnh: Tên quốc gia; chỉ trả về nếu product_type=19
asn	chuỗi	false	không có		ASN IP tĩnh; chỉ trả về nếu product_type=19
cổng	số nguyên	false	không có		Cổng proxy IP tĩnh; chỉ trả về nếu product_type=19

Thông tin sản phẩm nhóm

{
  "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
}

Các trường thống kê gói hàng nhất quán với /web_v1/user/info; các bản ghi hủy, hoàn tiền hoặc xóa tạm thời không được bao gồm trong bản tóm tắt; ngoại trừ team_id và product_types, chỉ các trường tương ứng với các loại sản phẩm được trang web hiện tại hỗ trợ mới được trả về.

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
team_id	TeamPublicId	đúng	không có	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
product_types	[integer]	true	none	Không gian tài nguyên nhóm chưa bị hủy hoặc xóa tạm thời và trang web hiện tại hỗ trợ các loại gói sau
product_residence_remain_count	integer(int64)	false	none	Lưu lượng truy cập còn lại loại 9
product_residence_total_count	integer(int64)	false	none	Type 9 Total Flow
pdrue2_timestamp	integer(int64)	false	none	Nhập 11 Thời gian hết hạn mới nhất; 0 nếu không có gói nhóm nào khả dụng
còn lại	số nguyên	sai	không có	Loại 17 Số lượng còn lại
tổng_số_lượng	số_nguyên	false	không có	Loại 17 Tổng số lượng
scraping_remain	integer(int64)	false	none	Type 18 Số lượng còn lại
scraping_total_amount	integer(int64)	false	none	Type 18 Tổng số lần quét
scraping_timestamp	chuỗi	false	không có	Nhập 18 Thời gian hết hạn mới nhất; "-" nếu không có gói nào khả dụng
scraping_timestamp2	integer(int64)	false	none	Type 18 Latest expiration timestamp
common_scraping_remain	integer(int64)	false	none	Loại 29 Số lần thử còn lại
common_scraping_total_amount	integer(int64)	false	none	Type 29 Tổng số lần quét
common_scraping_timestamp	chuỗi	false	không có	Nhập 29 Thời gian hết hạn mới nhất; "-" nếu không có gói nào khả dụng
common_scraping_timestamp2	integer(int64)	false	none	Type 29 Latest expiration timestamp
pdidcr_count	integer	false	none	Loại 12 Số lượng gói hợp lệ
pdidcr_total	integer	false	none	Loại 12 Tổng số gói hàng
pdidcr_traffic_remain	integer(int64)	false	none	Lưu lượng truy cập còn lại loại 12
pdidcr_traffic_total	integer(int64)	false	none	Loại 12 Tổng lưu lượng truy cập
p_sitai_ip_count	số nguyên	false	không có	Loại 13 Số lượng địa chỉ IP hợp lệ
p_sitai_ip	số nguyên	false	không có	Loại 13 Số lượng gói hợp lệ
p_sitai_ip_total	integer	false	none	Loại 13 Tổng số gói hàng
p_sitai_remain	integer(int64)	false	none	Loại 13/24 Băng thông còn lại
p_sitai_total	integer(int64)	false	none	Loại 13/24 Tổng lưu lượng
pdidc_count	integer	false	none	Loại 14 Số lượng gói hợp lệ
pdidc_total	integer	false	none	Loại 14 Tổng số gói hàng
pdidc_ip_count	integer	false	none	Loại 14 Số lượng địa chỉ IP hợp lệ
pdidc_ip_all_count	integer	false	none	Loại 14 Tổng số địa chỉ IP
pdispr_count	integer	false	none	Loại 15 Số lượng gói hợp lệ
pdispr_total	integer	false	none	Loại 15 Tổng số gói hàng
pdispr_traffic_remain	integer(int64)	false	none	Lưu lượng truy cập còn lại loại 15
pdispr_traffic_total	integer(int64)	false	none	Loại 15 Tổng lưu lượng truy cập
product_datacenter_isp_traffic_ip_count	integer	false	none	Loại 16 Số lượng địa chỉ IP hợp lệ
product_datacenter_isp_traffc_ip	integer	false	none	Loại 16 Số lượng gói hợp lệ; chính tả tương thích về mặt lịch sử
product_datacenter_isp_traffc_ip_total	integer	false	none	Loại 16 Tổng số gói; chính tả tương thích về mặt lịch sử
product_datacenter_isp_traffic_ip	integer	false	none	Loại 16 Số lượng gói hợp lệ
product_datacenter_isp_traffic_ip_total	integer	false	none	Loại 16 Tổng số gói tin
product_datacenter_isp_traffc_remain	integer(int64)	false	none	Loại 16/24 Lưu lượng truy cập còn lại; chính tả tương thích với lịch sử
product_datacenter_isp_traffc_total	integer(int64)	false	none	Loại 16/24 Tổng lưu lượng truy cập; chính tả tương thích với lịch sử
product_datacenter_isp_traffic_remain	integer(int64)	false	none	Loại 16/24 Lưu lượng truy cập còn lại
product_datacenter_isp_traffic_total	integer(int64)	false	none	Type 16/24 Total traffic
product_datacenter_isp_ip	integer	false	none	Nhập 21 hoặc 25 Số lượng gói hợp lệ
product_datacenter_isp_ip_total	integer	false	none	Tổng số gói hàng (loại 21 hoặc 25)
product_datacenter_isp_ip_count	integer	false	none	Nhập 21 hoặc 25 Số lượng địa chỉ IP hợp lệ
product_datacenter_isp_ip_all_count	integer	false	none	Nhập 21 hoặc 25 Tổng số địa chỉ IP
product_datacenter_isp_ip_traffic_remain	integer(int64)	false	none	Loại 21 tương ứng với Loại 24: Lưu lượng truy cập còn lại
product_datacenter_isp_ip_traffic_total	integer(int64)	false	none	Loại 21 tương ứng với Tổng lưu lượng Loại 24
product_agent_residence_remain_count	integer(int64)	false	none	Lưu lượng truy cập còn lại loại 22
product_agent_residence_total_count	integer(int64)	false	none	Type 22 Total traffic
product_serp_remain	integer(int64)	false	none	Số lượng còn lại (Loại 27)
product_serp_total	integer(int64)	false	none	Type 27 Total count
product_serp_timestamp	chuỗi	false	không có	Nhập 27 Thời gian hết hạn mới nhất; "-" nếu không có gói nào khả dụng
product_serp_timestamp2	integer(int64)	false	none	Type 27 Latest expiration timestamp
product_video_remain	integer(int64)	false	none	Loại 28 Băng thông còn lại
product_video_total	integer(int64)	false	none	Type 28 Total video stream
product_video_timestamp	chuỗi	false	không có	Nhập 28 Thời gian hết hạn mới nhất; "-" nếu không có gói nào
product_video_timestamp2	integer(int64)	false	none	Type 28 Latest expiration timestamp

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

Ví nhóm được tách biệt với số dư cá nhân của quản trị viên cấp cao; số tiền sử dụng đơn vị tiền tệ mặc định của trang web hiện tại và có tối đa 4 chữ số thập phân.

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
team_id	TeamPublicId	đúng	không có	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
số dư	số (double)	đúng	không có	Số dư hiện có của đội
tổng_phí_nạp_tiền	số_gấp_đôi	đúng	không có	Số dư nạp tiền nhóm chưa sử dụng hiện tại, không bao gồm chuyển khoản số dư cá nhân
updated_at	chuỗi	true	không có	Thời gian ví được thay đổi lần cuối

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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	đúng	không có	không có
team_id	TeamPublicId	đúng	không có	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
operator_user_id	integer	true	none	Người vận hành, khoản hoàn tiền hệ thống là 0
người sáng tạo	TeamCreator	sai	không có	không có
hướng	số nguyên	đúng	không có	0 = chi tiêu, 1 = thu nhập
loại giao dịch	số nguyên	đúng	không	1=Nạp tiền vào tài khoản, 2=Chuyển từ số dư cá nhân, 3=Sử dụng số dư, 4=Hoàn tiền hoặc khấu trừ hoàn tiền nạp tiền, 5=Chuyển lại vào số dư cá nhân
số tiền	số (double)	đúng	không có	Số tiền thay đổi này, hướng được chỉ định bởi hướng
after_balance	number(double)	true	none	Số dư ví nhóm đã cập nhật
link_id	integer	true	none	ID đơn hàng liên kết; ID người dùng được sử dụng khi chuyển số dư cá nhân
request_id	chuỗi	đúng	không có	không có
nhận xét	chuỗi	đúng	không có	không có
created_at	chuỗi	true	không có	không có

Giá trị liệt kê

Thuộc tính	Giá trị
hướng	0
hướng	1
loại giao dịch	1
loại giao dịch	2
loại giao dịch	3
loại giao dịch	4
loại giao dịch	5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
user_id	integer	true	none	ID người dùng của nhà điều hành; thao tác hệ thống là 0
display_name	string	true	none	Hiển thị tên theo thứ tự biệt danh, tên người dùng, email và số điện thoại
biệt danh	chuỗi	đúng	không có	không có
tên người dùng	chuỗi	đúng	không có	không có
email	chuỗi	đúng	không có	Đây là giá trị đã được ẩn danh từ góc nhìn của người không phải quản trị viên
điện thoại	chuỗi	đúng	không có	Đây là giá trị đã được ẩn danh từ góc nhìn của người không phải quản trị viên

Nhóm phản hồi

{
  "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	đối tượng	sai	không có		không có
» dữ liệu	Đội	sai	không có		không có

TeamListResponse

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

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	Đội]	đúng	không có	không có
»» tổng	số nguyên	đúng	không có	không có
»» trang	số nguyên	đúng	không có	không có
»» kích thước trang	số nguyên	đúng	không có	không có

TeamMemberListResponse

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

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	Thành viên nhóm]	đúng	không có	không có
»» tổng	số nguyên	đúng	không có	không có
»» trang	số nguyên	đúng	không có	không có
»» kích thước trang	số nguyên	đúng	không có	không có

NhómNgườiDanhSáchPhảnHồi

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "[",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": "[",
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": "[",
        "role": "[",
        "status": "[",
        "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	Người đồng đội]	đúng	không có	không có
»» tổng	số nguyên	đúng	không có	không có
»» trang	số nguyên	đúng	không có	không có
»» kích thước trang	số nguyên	đúng	không có	không có

Nhóm phản hồi tài sản

{
  "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	đối tượng	sai	không có		không có
» dữ liệu	TeamAsset	sai	không có		không có

NhómThôngTinSảnPhẩmPhảnHồi

{
  "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	đối tượng	sai	không có		không có
» dữ liệu	Thông tin sản phẩm nhóm	false	none		Các trường thống kê gói hàng nhất quán với /web_v1/user/info; các bản ghi hủy, hoàn tiền hoặc xóa tạm thời không được bao gồm trong bản tóm tắt; ngoại trừ team_id và product_types, chỉ các trường tương ứng với các loại sản phẩm được trang web hiện tại hỗ trợ mới được trả về.

Nhóm phản hồi ví

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

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	đối tượng	sai	không có		không có
» dữ liệu	TeamWallet	false	none		Ví nhóm, tách biệt với số dư cá nhân của quản trị viên cấp cao; số tiền sử dụng đơn vị tiền tệ mặc định hiện tại của trang web, với tối đa 4 chữ số thập phân.

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {},
        "direction": "[",
        "transaction_type": "[",
        "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	TeamWalletRecord]	đúng	không có	không có
»» tổng	số nguyên	đúng	không có	không có
»» trang	số nguyên	đúng	không có	không có
»» kích thước trang	số nguyên	đúng	không có	không có

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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	TeamAsset]	đúng	không có	không có
»» tổng	số nguyên	đúng	không có	không có
»» trang	số nguyên	đúng	không có	không có
»» kích thước trang	số nguyên	đúng	không có	không có

Siêu dữ liệu Khóa API Người dùng

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	đúng	không có		ID khóa API
api_key	chuỗi	true	không có		Tạo phản hồi với khóa đầy đủ; sử dụng giá trị ẩn danh trong danh sách nhóm
team_user_id	integer	true	none		Khóa nhóm: ID thành viên thực tế; Khóa cá nhân: 0
nhận xét	chuỗi	đúng	không có		Ghi chú
trạng thái	số nguyên	đúng	không có		0 = bị vô hiệu hóa, 1 = được kích hoạt
created_at	string	true	none		Thời gian tạo
updated_at	chuỗi	null	false	không có

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1

Thông tin hóa đơn

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "user@example.com",
  "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
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
mã_hóa_đơn	chuỗi	false	không có	không có
tên	chuỗi	sai	không có	không có
tên_tổ_chức	chuỗi	false	không có	không có
tên	chuỗi	false	không có	không có
họ	chuỗi	false	không có	không có
điện thoại	chuỗi	sai	không có	không có
email	chuỗi (email)	false	không có	không có
loại_vai_trò	số_nguyên	sai	không có	không có
loại_hóa_đơn	số_tử	sai	không có	không có
mã số thuế	chuỗi	false	không có	không có
mã số thuế	chuỗi	false	không có	không có
quốc gia địa chỉ	chuỗi	false	không có	không có
địa chỉ_thành_phố	chuỗi	false	không có	không có
address_line1	chuỗi	false	không có	không có
address_line2	chuỗi	false	không có	không có
mã_bưu_chính_địa_chỉ	chuỗi	false	không có	không có
tên_ngân_hàng	chuỗi	sai	không có	không có
tài khoản ngân hàng	chuỗi	false	không có	không có
is_def	boolean	false	none	none

Giá trị liệt kê

Thuộc tính	Giá trị
loại_vai_trò	1
loại_vai_trò	2
loại_hóa_đơn	0
loại_hóa_đơn	1
loại_hóa_đơn	2

Yêu cầu gia hạn hàng tháng

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

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
team_id	ResourceSpaceId	false	none		Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền một chuỗi rỗng khi yêu cầu không gian cá nhân và trả về một chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 chữ số
user_product_ids	any	true	none		Mảng ID gói sản phẩm của người dùng, cũng tương thích với chuỗi phân cách bằng dấu phẩy

một trong

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
»ẩn danh	[số nguyên]	false	không có		không có

xor

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
»ẩn danh	chuỗi	false	không có		không có

tiếp tục

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
user_coupon_id	integer	false	none		none
coupon_sn	chuỗi	false	không có		không có

Lời mời nhóm

{
  "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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	đúng	không có		ID lời mời
team_id	TeamPublicId	đúng	không có		Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
inviter_user_id	integer	true	none		ID người dùng người mời
invitee_user_id	integer	true	none		ID người dùng được mời, 0 nếu không có người dùng đã đăng ký nào khớp
invite_type	integer	true	none		Loại lời mời: 1=người dùng đã đăng ký, 2=email, 3=số điện thoại
invite_country_code	integer	true	none		Mã quốc gia hoặc khu vực cho số điện thoại di động; 0 cho lời mời qua số điện thoại cố định
invite_target	chuỗi	true	không có		Mục tiêu mời tiêu chuẩn; người dùng đã đăng ký là user:{user_id}
loại_giao_hàng	số_tích	đúng	không		Kênh_giao_hàng_ban_đầu: 1=người_dùng_đã_đăng_ký, 2=email, 3=số_điện_thoại; kênh ban đầu được giữ nguyên khi email hoặc số điện thoại trùng khớp với người dùng đã đăng ký.
vai trò	số nguyên	đúng	không có		Vai trò mục tiêu: 2 = Quản trị viên, 3 = Thành viên thường
trạng thái	số nguyên	đúng	không có		Trạng thái lời mời: 0 = Đang chờ, 1 = Đã chấp nhận, 2 = Bị từ chối, 3 = Đã hủy, 4 = Hết hạn
accepted_by_user_id	integer	true	none		ID người dùng được chấp nhận, 0 nếu không có người dùng nào được chấp nhận
expired_at	chuỗi	true	không có		Thời gian hết hạn, định dạng YYYY-MM-DD HH:mm:ss
accepted_at	chuỗi	null	true	không có
rejected_at	chuỗi	null	true	không có
cancelled_at	chuỗi	null	true	không có
created_at	string	true	none		Thời gian tạo, định dạng YYYY-MM-DD HH:mm:ss

Giá trị liệt kê

Thuộc tính	Giá trị
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

Thành viên nhóm

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
team_member_id	integer	true	none	ID thành viên
team_id	TeamPublicId	đúng	không có	Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
user_id	integer	true	none	ID người dùng thành viên
vai trò	số nguyên	đúng	không có	Vai trò: 1 = Quản trị viên cấp cao, 2 = Quản trị viên, 3 = Thành viên thường, 4 = Thành viên đóng phí
trạng thái	số nguyên	đúng	không có	Trạng thái thành viên: 0 = bị vô hiệu hóa, 1 = được kích hoạt, 2 = đã thoát, 3 = đã bị xóa
joined_at	string¦null	true	none	Thời gian tham gia, định dạng YYYY-MM-DD HH:mm:ss
biệt danh	chuỗi	đúng	không có	biệt danh thành viên
tên người dùng	chuỗi	đúng	không có	tên người dùng thành viên

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3

Người đồng đội

{
  "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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
record_type	string	true	none		Loại bản ghi; member biểu thị các thành viên đang hoạt động, invitation biểu thị các lời mời đang chờ xử lý
record_id	integer	true	none		ID thành viên hoặc ID lời mời
team_id	TeamPublicId	đúng	không có		Mã định danh nhóm công khai, bắt đầu bằng một chữ cái ASCII, các ký tự còn lại chỉ chứa các chữ cái và số ASCII; sẽ không có khóa chính số nào được cấp cho cơ sở dữ liệu.
user_id	integer	true	none		ID người dùng, 0 đối với người dùng được mời nhưng chưa đăng ký
inviter_user_id	integer	true	none		ID người mời, bản ghi thành viên là 0
invite_type	integer	true	none		Loại lời mời, bản ghi thành viên là 0
invite_country_code	integer	true	none		Mã quốc gia hoặc vùng của số điện thoại di động; 0 đối với hồ sơ thành viên
invite_target	chuỗi	true	không có		Mục tiêu mời, bản ghi thành viên là một chuỗi rỗng
loại_giao_hàng	số_nguyên	đúng	không có		Kênh_giao_hàng_ban_đầu, bản ghi thành viên là 0
vai trò	số nguyên	đúng	không có		Vai trò: 1 = Quản trị viên cấp cao, 2 = Quản trị viên, 3 = Thành viên thường, 4 = Thành viên đóng phí
trạng thái	số nguyên	đúng	không có		thành viên được cố định ở mức 1, lời mời được cố định ở mức 0
display_name	string	true	none		Hiển thị tên thống nhất, theo thứ tự biệt danh, tên người dùng, email và số điện thoại; thông tin liên hệ từ góc nhìn của các thành viên thông thường sử dụng các giá trị ẩn danh.
biệt danh	chuỗi	đúng	không có		Biệt danh của thành viên hoặc người dùng được mời đã đăng ký
tên người dùng	chuỗi	đúng	không có		Tên người dùng của thành viên hoặc người được mời đã đăng ký
email	chuỗi	đúng	không có		Địa chỉ email; Quản trị viên cấp cao và quản trị viên trả về giá trị đầy đủ, trong khi thành viên thông thường trả về giá trị ẩn danh được đánh dấu bằng dấu sao
điện thoại	chuỗi	đúng	không có		Số điện thoại di động; Quản trị viên cấp cao và quản trị viên trả về giá trị đầy đủ, trong khi các thành viên thông thường trả về giá trị ẩn danh được đánh dấu bằng dấu sao
joined_at	chuỗi	null	true	không có
expired_at	chuỗi	null	true	không có
created_at	string	true	none		Ghi lại thời gian tạo, ở định dạng YYYY-MM-DD HH:mm:ss

Giá trị liệt kê

Thuộc tính	Giá trị
loại bản ghi	thành viên
loại bản ghi	lời mời
loại_mời	0
loại_mời	1
loại_mời	2
loại_mời	3
loại_giao_hàng	0
loại_giao_hàng	1
loại_giao_hàng	2
loại_giao_hàng	3
vai trò	1
vai trò	2
vai trò	3
vai trò	4
trạng thái	0
trạng thái	1

Phản hồi lời mời nhóm

{
  "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	đối tượng	sai	không có		không có
» dữ liệu	Lời mời nhóm	sai	không có		không có

Phản hồi của thành viên nhóm

{
  "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	đối tượng	sai	không có		không có
» dữ liệu	Thành viên nhóm	sai	không có		không có

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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» lời mời	Lời mời nhóm	đúng	không có	không có
»» invitation_token	chuỗi	đúng	không có	Mã mời dạng văn bản thuần túy, chỉ dành riêng cho việc tương thích với các khách hàng hiện có; khách hàng mới nên sử dụng invitation_url trực tiếp.
»» URL lời mời	chuỗi (uri)	true	không có	Liên kết xử lý phía giao diện người dùng chứa mã thông báo lời mời
»» kênh thông báo	Kênh thông báo lời mời nhóm	đúng	không có	không có

Kênh thông báo lời mời nhóm

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
email	chuỗi	false	không có	Kết quả kênh email
sms	chuỗi	false	không có	Kết quả kênh SMS
site_inner_message	chuỗi	false	không có	Kết quả của các kênh nhắn tin nội bộ

Giá trị liệt kê

Thuộc tính	Giá trị
email	đang chờ xử lý
email	thất bại
email	bỏ qua
tin nhắn SMS	đang chờ xử lý
tin nhắn SMS	thất bại
tin nhắn SMS	đã bỏ qua
site_inner_message	created
site_inner_message	exists
site_inner_message	thất bại

TeamInvitationPreviewResponse

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

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» tên_đội	chuỗi	đúng	không có	Tên_đội
»» vai trò	số nguyên	đúng	không có	Vai trò mục tiêu
»» trạng thái	số nguyên	đúng	không có	Trạng thái lời mời
»» expired_at	chuỗi	true	không có	Thời gian hết hạn, định dạng YYYY-MM-DD HH:mm:ss

Giá trị liệt kê

Thuộc tính	Giá trị
vai trò	2
vai trò	3
trạng thái	0
trạng thái	1
trạng thái	2
trạng thái	3
trạng thái	4

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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» lời mời	Lời mời nhóm	đúng	không có	không có
»» URL lời mời	chuỗi (uri)	true	không có	Liên kết xử lý lời mời mới; liên kết cũ không hợp lệ
»» kênh thông báo	Kênh thông báo lời mời nhóm	đúng	không có	không có

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": "[",
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": "[",
        "role": "[",
        "status": "[",
        "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"
}

tài sản

tất cả

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
ẩn danh	WebV1SuccessResponse	sai	không có		không có

Và

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
ẩn danh	đối tượng	sai	không có	không có
» dữ liệu	đối tượng	sai	không có	không có
»» danh sách	Thư mời đội]	đúng	không có	không có
»» tổng	số nguyên	đúng	không có	Tổng số lời mời
»» trang	số nguyên	đúng	không có	Số trang hiện tại
»» kích thước trang	số nguyên	đúng	không	Số trang thực tế trên mỗi trang

Người dùng

{
  "id": 0,
  "email": "user@example.com",
  "phone": "string",
  "balance": 0.1,
  "status": 0,
  "is_real_name": true,
  "created_at": "2019-08-24T14:15:22Z"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	không có
email	chuỗi (email)	false	không có	không có
điện thoại	chuỗi	sai	không có	không có
số dư	số (dạng thập phân)	sai	không có	không có
trạng thái	số nguyên	sai	không có	không có
is_real_name	boolean	false	none	none
created_at	chuỗi (ngày giờ)	false	không có	không có

Đặt hàng

{
  "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": "user@example.com",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	Mã đơn hàng
trade_no	chuỗi	false	không có	Số đơn hàng nội bộ
out_trade_no	chuỗi	false	không có	Số lệnh bên ngoài
product_id	integer	false	none	Mã gói hàng
product_type	integer	false	none	Loại bao bì, xem liệt kê loại sản phẩm
số tiền	số nguyên	sai	không có	Số lượng mua
đơn giá	số (float)	false	không có	đơn giá
total_fee	number(float)	false	none	Tổng giá trị đơn hàng (không bao gồm giảm giá, bao gồm phí xử lý)
goods_fee	number(float)	false	none	Giá hàng hóa (bao gồm chiết khấu, không bao gồm phí xử lý)
phí_thanh_toán	số_thập_phân	false	không_có	Số tiền thanh toán thực tế (bao gồm chiết khấu và phí xử lý)
phí_giảm_giá	số_thập_hợp	false	không có	Số_tiền_giảm_giá
phí xử lý	số (float)	false	không có	phí xử lý
phí_hoàn_tiền	số_thống_thực	false	không có	số_tiền_hoàn_tiền
pm_id	số nguyên	false	không có	ID phương thức thanh toán (từ /openapi/payment/list)
pm_title	chuỗi	false	không có	Tên phương thức thanh toán
pm_logo	chuỗi	false	không có	URL logo phương thức thanh toán
trạng thái	số nguyên	sai	không có	Trạng thái đơn hàng
tiêu đề	chuỗi	false	không có	Tiêu đề gói
chi tiết	chuỗi	sai	không có	Mô tả gói hàng
region_desc	chuỗi	false	không có	Mô tả đặc tả vùng
pay_at	chuỗi (ngày giờ)	false	không có	thời gian thanh toán
dấu_thời_gian_thanh_toán	số_nguyên	false	không có	dấu_thời_gian_thanh_toán
created_at	chuỗi (ngày giờ)	false	không có	Thời gian tạo
pay_fee_status	integer	false	none	Trạng thái thanh toán: 0 Bình thường, 1 Thanh toán thừa (thanh toán dư), 2 Thanh toán thiếu
hóa đơn	đối tượng	sai	không có	Thông tin hóa đơn (chỉ áp dụng cho đơn đặt hàng thanh toán trực tuyến)
» tên	chuỗi	false	không có	Họ và tên đầy đủ
» tên_tổ_chức	chuỗi	false	không có	Tên_công_ty
» tên	chuỗi	false	không có	không có
» họ	chuỗi	false	không có	không có
» điện thoại	chuỗi	sai	không có	không có
» email	chuỗi (email)	false	không có	không có
» loại_vai_trò	số_tử	false	không có	1 người, 2 công ty
» vat_id	chuỗi	false	không có	Mã số thuế
» địa chỉ_quốc gia	chuỗi	false	không có	không có
» địa chỉ_thành_phố	chuỗi	false	không có	không có
» address_line1	chuỗi	false	không có	không có
» address_line2	chuỗi	false	không có	không có
» mã_bưu_chính_địa_chỉ	chuỗi	false	không có	không có

Kết quả kiểm tra đơn hàng

{
  "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"
      }
    }
  ]
}

Kết quả kiểm tra trước khi đặt hàng

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
product_id	integer	false	none	Mã gói hàng
số lượng	số nguyên	sai	không có	số lượng
phí_giảm_giá	số_thập_hợp	false	không có	Số_tiền_giảm_giá
tổng_phí	số_thống_thực	false	không có	Tổng số tiền đơn hàng
phí_thanh_toán	số_thập_phân	false	không có	Số_tiền_thực_tế_đã_thanh_toán
loại_sản_phẩm	số_nguyên	sai	không có	Loại_gói
tiêu đề	chuỗi	false	không có	Tiêu đề gói
chi tiết	chuỗi	sai	không có	Mô tả gói hàng
ip_result	[object]	false	none	Kết quả gia hạn lô IP (chỉ trả về khi gia hạn IP)
» địa chỉ IP	chuỗi	sai	không có	không có
» giá	số (dạng thập phân)	false	không có	không có
» mã_quốc_gia	chuỗi	false	không có	không có
» thời gian hiện tại	chuỗi (ngày giờ)	false	không có	không có
» thời gian gia hạn	chuỗi (ngày giờ)	false	không có	không có
» quốc gia	đối tượng	sai	không có	không có
»» tên_zh_cn	chuỗi	false	không có	không có
»» cờ	chuỗi	false	không có	URL cờ vòng
»» cờ vuông	chuỗi	false	không có	URL cờ vuông

Sản phẩm

{
  "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
      }
    ]
  }
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	ID gói hàng
tiêu đề	chuỗi	false	không có	Tiêu đề chính của gói
loại	số nguyên	sai	không có	Loại gói
show_type	integer	false	none	Loại hiển thị: 1 Bình thường 2 Đề xuất giá trị cao 3 Không có sẵn để mua (cần tùy chỉnh) 4 Dùng thử
trạng thái	số nguyên	false	không có	Trạng thái: 1 được liệt kê, 0 bị xóa khỏi danh sách
giá	số (dạng thập phân)	false	không có	Giá tính bằng Nhân dân tệ
usd_price	number(float)	false	none	Giá bằng Đô la Mỹ
price_hkd	number(float)	false	none	Giá Đô la Hồng Kông
giá_gốc	số_thập_hợp	false	không có	Giá_gốc (CNY)
giá_USD_ban_đầu	số_thống_thực	false	không có	giá_ban_đầu (USD)
original_price_hkd	number(float)	false	none	Giá gốc (HKD)
giá_địa_phương	số_thập_phân	false	không có	Giá_địa_phương (phụ thuộc vào_loại_tiền_dùng_ưu_dụng)
giá_gốc_địa_phương	số_thập_phân	false	không có	Giá gốc được bản địa hóa (phụ thuộc vào loại_tiền_dùng_ưu_dụng)
preferred_currency	string	false	none	Loại tiền tệ ưu tiên hiển thị, ví dụ như USD / CNY / HKD
support_currencies	string	false	none	Danh sách các loại tiền tệ được hỗ trợ, phân cách bằng dấu phẩy, ví dụ: USD, CNY
flow_value	number(float)	false	none	Dung lượng dữ liệu mặc định (GB) cho gói dữ liệu của bạn
flow_give	số (float)	false	none	Dữ liệu quà tặng (GB)
tặng số dư	số (float)	false	không có	Số tiền thưởng nạp tiền
giá trị_số_dư	số_thập phân	false	không có	Số_tiền_nạp
time_validity	number(float)	false	none	Thời hạn hiệu lực mặc định cho các gói dữ liệu
time_price	number(float)	false	none	Giá mỗi địa chỉ IP cho các gói dữ liệu
time_days	integer	false	none	Thời hạn hiệu lực tính bằng ngày, ví dụ: 30/90/180/365
mẹo 1	chuỗi	sai	không có	Giải thích thẻ 1
mẹo 2	chuỗi	sai	không có	Giải thích thẻ 2
giới thiệu	[chuỗi]	sai	không có	Danh sách mô tả văn bản
region_list_id	integer	false	none	ID khu vực
renew_product_list	chuỗi	false	không có	Danh sách ID sản phẩm có thể gia hạn (phân cách bằng dấu phẩy)
parent_product_type	integer	false	none	Loại gói cha (hợp lệ khi type=19): 14 hoặc 25
tổng_số_tồn_kho	số_nguyên	false	không_giới_hạn	Tổng số hàng tồn kho, 0 biểu thị không giới hạn
remain_count	integer	false	none	Số lượng hàng tồn kho còn lại
extension_of_time_days	[integer]	false	none	Danh sách các hệ số nhân thời lượng; trống hoặc chỉ chứa 1 cho biết không được hỗ trợ
time_days_price_rate	number(float)	false	none	Hệ số giá dựa trên thời gian, giá × (1 + (bội số - 1) × tỷ lệ)
mô tả	đối tượng	sai	không có	Thông tin mô tả gói hàng
» phụ đề	chuỗi	false	không có	Phụ đề
» giá trị dòng chảy	số (float)	false	không có	không có
» flow_give	số (float)	false	không có	không có
» balance_give	số (float)	false	không có	không có
» thời gian hiệu lực	số (float)	false	không có	không có
» time_price	số (float)	false	không có	không có
» mẹo 1	chuỗi	sai	không có	không có
» mẹo 2	chuỗi	sai	không có	không có
» giới thiệu	[chuỗi]	sai	không có	không có
sku	object	false	none	Tham số đặc tả (được trả về khi type=11)
» bandwidth_list	[object]	false	none	Danh sách thông số băng thông
»» id	số nguyên	false	không có	không có
»» giá trị	số nguyên	sai	không có	Giá trị băng thông (Mbps)
»» giá	số (dạng thập phân)	false	không có	không có
»» giá_usd	số (float)	false	không có	không có
»» price_hkd	số (float)	false	không có	không có
» duration_list	[object]	false	none	Danh sách thông số thời lượng
»» id	số nguyên	false	không có	không có
»» giá trị	số nguyên	false	không có	Thời lượng (ngày)
»» giá	số (dạng thập phân)	false	không có	không có
»» giá_usd	số (float)	false	không có	không có
»» price_hkd	số (float)	false	không có	không có
» concurrency_list	[object]	false	none	Danh sách đặc tả đồng thời
»» id	số nguyên	false	không có	không có
»» giá trị	số nguyên	false	không có	Đồng thời
»» giá	số (dạng thập phân)	false	không có	không có
»» giá_usd	số (float)	false	không có	không có
»» price_hkd	số (float)	false	không có	không có

Địa chỉ IP trắng

{
  "id": 0,
  "ip": "string",
  "remark": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	không có
địa chỉ IP	chuỗi	sai	không có	không có
nhận xét	chuỗi	sai	không có	không có
created_at	chuỗi (ngày giờ)	false	không có	không có

Tài khoản danh sách trắng

{
  "id": 0,
  "username": "string",
  "limit": 0,
  "used": 0,
  "status": 0
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	không có
tên người dùng	chuỗi	sai	không có	không có
giới hạn	số nguyên	sai	không có	không có
đã sử dụng	số nguyên	sai	không có	không có
trạng thái	số nguyên	sai	không có	không có

Phiếu giảm giá

{
  "id": 0,
  "name": "string",
  "code": "string",
  "discount": 0.1,
  "expire_time": "2019-08-24T14:15:22Z"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	không có
tên	chuỗi	sai	không có	không có
mã	chuỗi	sai	không có	không có
giảm giá	số (dạng thập phân)	sai	không có	không có
thời_gian_hết_hạn	chuỗi (ngày-giờ)	false	không có	không có

Bài báo

{
  "id": 0,
  "title": "string",
  "content": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	không có
tiêu đề	chuỗi	sai	không có	không có
nội dung	chuỗi	sai	không có	không có
created_at	chuỗi (ngày giờ)	false	không có	không có

Đánh số trang

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
tổng	số nguyên	sai	không có	không có
số_trang	số_nguyên	sai	không có	không có
kích thước trang	số nguyên	false	không có	không có
tổng số trang	số nguyên	false	không có	không có

Cấu hình tự động gia hạn

{
  "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"
}

Ảnh chụp cấu hình tự động gia hạn cho một gói cước duy nhất

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	false	không có	không có
user_id	integer	false	none	none
team_id	ResourceSpaceId	false	none	Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền một chuỗi rỗng khi yêu cầu không gian cá nhân và trả về một chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 chữ số
team_user_id	integer	false	none	none
loại_sản_phẩm	số_nguyên	sai	không có	không có
left_traffic	integer	false	none	Trường đã lỗi thời
left_days	integer	false	none	Trường đã lỗi thời
user_product_id	integer	false	none	none
product_id	integer	false	none	Trường đã lỗi thời
trạng thái	số nguyên	sai	không có	0 = bị vô hiệu hóa, 1 = được kích hoạt
tiền tệ	chuỗi	sai	không có	không có
giá_đã_thỏa_đổi	số lượng	sai	không có	tổng giá đã thỏa thuận
giá_băng_lượng_đã_thỏa_nhật	số	sai	không có	Giá đơn vị băng thông đã thỏa thuận cho Gói 11
agreed_concurrency_price	number	false	none	Giá xử lý đồng thời đã thỏa thuận cho Gói 11
bandwidth_id	integer	false	none	none
concurrency_id	integer	false	none	none
thời gian	số nguyên	false	không có	Thời gian gia hạn, tính bằng ngày
renew_product_id	integer	false	none	none
ngày_trước_hết_hạn	số nguyên	false	không có	không có
traffic_threshold	integer	false	none	Ngưỡng lưu lượng truy cập, giá trị trong cơ sở dữ liệu tính bằng KB
loại_sản_phẩm_cha	số_nguyên	sai	không có	không có
created_at	chuỗi	false	không có	không có
updated_at	chuỗi	false	không có	không có

Giá trị liệt kê

Thuộc tính	Giá trị
trạng thái	0
trạng thái	1

Nhật ký gia hạn tự động

{
  "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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	đúng	không có		không có
user_id	integer	true	none		none
team_id	ResourceSpaceId	true	none		Mã định danh không gian tài nguyên công cộng; bỏ qua team_id hoặc truyền một chuỗi rỗng khi yêu cầu không gian cá nhân và trả về một chuỗi rỗng khi phản hồi không gian cá nhân; số 0 và chuỗi "0" đều không hợp lệ, không gian nhóm sử dụng mã định danh nhóm công cộng gồm 6-12 chữ số
team_user_id	integer	true	none		none
config_id	integer	true	none		none
user_product_id	integer	true	none		none
loại sản phẩm	số nguyên	đúng	không có		không có
renew_product_id	integer	true	none		none
order_id	integer	true	none		none
phí	số	đúng	không có		không có
tiền tệ	chuỗi	đúng	không có		không có
trước_hết_hạn_tại	chuỗi	null	false	không có
sau_hết_hạn	chuỗi	null	false	không có
before_remain	integer(int64)	true	none		none
after_remain	integer(int64)	true	none		none
loại_kích_ứng	số_tích_nguyên	đúng	không		0 = trước khi hết hạn, 1 = lưu lượng truy cập không đủ
trạng thái	số nguyên	đúng	không có		1=Thành công, 2=Đã hủy, 3=Thất bại
revoke_at	chuỗi ¦null	false	không có		không có
revoke_remark	chuỗi	đúng	không có		không có
created_at	chuỗi	true	không có		không có
updated_at	chuỗi	đúng	không có		không có

Giá trị liệt kê

Thuộc tính	Giá trị
loại_kích_ứng	0
loại_kích_ứng	1
trạng thái	1
trạng thái	2
trạng thái	3

Đợt gia hạn hàng tháng

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
kiểu	chuỗi	đúng	không có	không có
bắt đầu lúc	chuỗi	đúng	không có	không có
kết thúc tại	chuỗi	đúng	không có	không có
target_expired_at	chuỗi	đúng	không có	không có
múi giờ	chuỗi	đúng	không có	không có

Giá trị liệt kê

Thuộc tính	Giá trị
loại	hiện tại
loại	tiếp theo

Mục gia hạn hàng tháng

{
  "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"
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
id	số nguyên	false	không có		ID chi tiết thanh toán lịch sử
user_product_id	integer	true	none		none
product_id	integer	true	none		none
loại sản phẩm	số nguyên	đúng	không có		không có
loại_sản_phẩm_cha	số_nguyên	đúng	không có		không có
tiêu đề	chuỗi	đúng	không có		không có
hết hạn vào	chuỗi	đúng	không có		không có
target_expired_at	chuỗi	đúng	không có		không có
gia hạn_ngày	số nguyên	đúng	không có		không có
đơn_hàng_tháng_giá	số lượng	sai	không có		không có
phí_thanh_toán	số	đúng	không có		không có
tiền tệ	chuỗi	đúng	không có		không có
băng thông	số nguyên	sai	không có		không có
bandwidth_mbsp	số	false	không có		giá trị chuyển đổi băng thông
đồng thời	số nguyên	sai	không có		không có
ip	chuỗi	false	không có		Trả về gói IP tĩnh
mã_quốc_gia	chuỗi	false	không có		Trả về gói IP tĩnh
paid_at	chuỗi	null	false	không có
refunded_at	chuỗi ¦null	false	không có		không có
created_at	chuỗi	false	không có		không có
updated_at	chuỗi	false	không có		không có

Hồ sơ hóa đơn

{
  "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
  }
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	số nguyên	đúng	không có	không có
số_hóa_đơn	chuỗi	đúng	không có	không có
số tiền hóa đơn	số	đúng	không có	không có
URL tải xuống hóa đơn	chuỗi	đúng	không có	không có
trạng thái	số nguyên	đúng	không có	không có
nhận xét	chuỗi	đúng	không có	không có
order_ids	[số nguyên]	true	không có	không có
created_at	integer	true	none	Unix timestamp
thông tin hóa đơn	bất kỳ	đúng	không có	không có

một trong

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
»ẩn danh	đối tượng	sai	không có	không có
»» mã_hóa_đơn	chuỗi	đúng	không có	không có
»» tên	chuỗi	đúng	không có	không có
»» tên_tổ_chức	chuỗi	đúng	không có	không có
»» loại_vai_trò	số_tử	đúng	không	không
»» loại hóa đơn	số nguyên	đúng	không có	không có

xor

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
»ẩn danh	null	false	không có		không có

Giá trị liệt kê

Thuộc tính	Giá trị
loại_vai_trò	1
loại_vai_trò	2
loại_hóa_đơn	0
loại_hóa_đơn	1
loại_hóa_đơn	2

Dữ liệu phiếu lương

{
  "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
  }
}

tài sản

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
trade_no	chuỗi	đúng	không có	không có
pm_id	số nguyên	đúng	không có	không có
phương thức thanh toán	số nguyên	đúng	không có	không có
loại_giao_dịch	chuỗi	đúng	không có	không có
mã_quốc_gia	chuỗi	đúng	không có	không có
tiền tệ	chuỗi	đúng	không có	không có
phí hàng hóa	số lượng	đúng	không có	không có
phí_giảm_giá	số	đúng	không có	không có
phí xử lý	số	đúng	không có	không có
phí_thanh_toán	số	đúng	không có	không có
tổng_phí	số lượng	đúng	không có	không có
thông_tố_phương_thức_thanh_toán	bất_kỳ	đúng	không	không

một trong

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
»ẩn danh	đối tượng	sai	không có	không có
»» id	số nguyên	đúng	không có	không có
»» kiểu	số nguyên	đúng	không có	không có
»» tiêu đề	chuỗi	đúng	không có	không có
»» nhóm	chuỗi	đúng	không có	không có
»» tỷ lệ xử lý	số	đúng	không có	không có
»» phí xử lý	số	đúng	không có	không có
»» xử lý phí tiền tệ	chuỗi	đúng	không có	không có
»» phí xử lý đã chuyển đổi	số	đúng	không có	không có

xor

Tên	Loại	Bắt buộc	Ràng buộc	Tên tiếng Trung	Mô tả
»ẩn danh	null	false	không có		không có

tiếp tục

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
nguồn gốc	đối tượng	đúng	không có	không có
» pm_id	số nguyên	đúng	không có	không có
» phương thức thanh toán	số nguyên	đúng	không có	không có
» phí hàng hóa	số lượng	đúng	không có	không có
» phí giảm giá	số	đúng	không có	không có
» phí xử lý	số	đúng	không có	không có
» phí trả phí	số	đúng	không có	không có
» tổng_phí	số lượng	đúng	không có	không có