Trường tùy chỉnh Campaign

API quản lý trường tùy chỉnh trong chiến dịch gọi.

Lấy tất cả trường (không phân trang)

GET[URL]/api/campaignCall/customField/getAllNoPage?vbot_id={vbot_id}&project_code={project_code}&key_search={key_search}

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Tham số

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
key_search	String	Từ khóa tìm kiếm

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": [
    {
      "id": 1,
      "cfname": "sample string 2",
      "cfkey": "sample string 3",
      "description": "sample string 4",
      "cftype": "sample string 5",
      "is_required": true
    },
    {
      "id": 1,
      "cfname": "sample string 2",
      "cfkey": "sample string 3",
      "description": "sample string 4",
      "cftype": "sample string 5",
      "is_required": true
    }
  ]
}

Lấy tất cả trường (không phân trang)

GET[URL]/api/campaignCall/customField/getAll?vbot_id={vbot_id}&project_code={project_code}&key_search={key_search}&page={page}&size={size}

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Tham số

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
key_search	String	Từ khóa tìm kiếm
page	Int	Số trang
size	Int	Số lượng trên 1 trang

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": [
    {
      "id": 1,
      "cfname": "sample string 2",
      "cfkey": "sample string 3",
      "description": "sample string 4",
      "cftype": "sample string 5",
      "is_required": true
    },
    {
      "id": 1,
      "cfname": "sample string 2",
      "cfkey": "sample string 3",
      "description": "sample string 4",
      "cftype": "sample string 5",
      "is_required": true
    }
  ]
}

Lấy số lượng trường tùy chỉnh

GET[URL]/api/campaignCall/customField/countAll?vbot_id={vbot_id}&project_code={project_code}&key_search={key_search}

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Tham số

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
key_search	String	Từ khóa tìm kiếm

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin
data	Int	Dữ liệu trả về

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": 4
}

Lấy chi tiết trường tùy chỉnh

GET[URL]/api/campaignCall/customField/getDetail?vbot_id={vbot_id}&project_code={project_code}&id={id}

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Tham số

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
id	Int	ID

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": {
    "id": 1,
    "cfname": "sample string 2",
    "cfkey": "sample string 3",
    "description": "sample string 4",
    "cftype": "sample string 5",
    "is_required": true
  }
}

Kiểm tra tên trường

GET[URL]/api/campaignCall/customField/checkName?vbot_id={vbot_id}&project_code={project_code}&name={name}

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Tham số

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
name	String	Tên

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin
data	Bool	Dữ liệu trả về

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": true
}

Kiểm tra key trường

GET[URL]/api/campaignCall/customField/checkKey?vbot_id={vbot_id}&project_code={project_code}&key={key}

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Tham số

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
key	String	Từ khóa tìm kiếm

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin
data	Bool	Dữ liệu trả về

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": true
}

Thêm trường tùy chỉnh

POST[URL]/api/campaignCall/customField/insert

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Body

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
description	String	Mô tả
cfname	String
cfkey	String
cftype	String
is_required	Bool

Ví dụ request

json

{
  "vbot_id": "sample string 1",
  "project_code": "sample string 2",
  "description": "sample string 3",
  "cfname": "sample string 4",
  "cfkey": "sample string 5",
  "cftype": "sample string 6",
  "is_required": true
}

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin
data	Int	Dữ liệu trả về

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": 4
}

Xóa trường tùy chỉnh

POST[URL]/api/campaignCall/customField/delete

Header

Tham số	Giá trị
Authorization	Bearer `access_token`

Body

Tham số	Kiểu	Mô tả
vbot_id	String	VBotID khách hàng
project_code	String	Mã nhóm
id	Int	ID

Ví dụ request

json

{
  "vbot_id": "sample string 1",
  "project_code": "sample string 2",
  "id": 3
}

Response

Tham số	Kiểu	Mô tả
status	Int	Mã trạng thái (1: Thành công, 0: Thất bại)
error	Int	Mã lỗi
message	String	Thông tin
data	Bool	Dữ liệu trả về

Ví dụ response

json

{
  "status": 1,
  "error": 2,
  "message": "sample string 3",
  "data": true
}

Trường tùy chỉnh Campaign ​

Lấy tất cả trường (không phân trang) ​

Lấy tất cả trường (không phân trang) ​

Lấy số lượng trường tùy chỉnh ​

Lấy chi tiết trường tùy chỉnh ​

Kiểm tra tên trường ​

Kiểm tra key trường ​

Thêm trường tùy chỉnh ​

Xóa trường tùy chỉnh ​

Trường tùy chỉnh Campaign

Lấy tất cả trường (không phân trang)

Lấy tất cả trường (không phân trang)

Lấy số lượng trường tùy chỉnh

Lấy chi tiết trường tùy chỉnh

Kiểm tra tên trường

Kiểm tra key trường

Thêm trường tùy chỉnh

Xóa trường tùy chỉnh