REST API文档

高级配置-系统管理

全局变量

参数说明
realm指定 GLOBAL，不可修改
k参数名
v参数值
disabled是否启动；0-是 1-否，不填默认是
created_at创建时间
updated_at更新时间
deleted_at删除时间

查看全局变量

  • 请求 URL： /api/globals

  • 请求方式： GET

  • Body 信息：无

  • 返回值：

  • curl 示例:

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/globals

{
	"rowCount": 62,
	"page": 1,
	"pageCount": 2,
	"data": [
		{
			"ref_id": 0,
			"realm": "GLOBAL",
			"created_at": "2022-05-16 09:51:32",
			"id": 891,
			"updated_at": "2022-05-16 09:51:32",
			"k": "video_mute_png",
			"deleted_at": "",
			"disabled": 0,
			"v": "$${images_dir}/default-mute.png"
		},
		{
			"ref_id": 0,
			"realm": "GLOBAL",
			"created_at": "2022-05-16 09:51:32",
			"id": 892,
			"updated_at": "2022-05-16 09:51:32",
			"k": "video_no_avatar_png",
			"deleted_at": "",
			"disabled": 0,
			"v": "$${images_dir}/default-avatar.png"
		}
		...
	]
}

新增全局变量

  • 请求 URL： /api/globals
  • 请求方式： POST
  • Body 信息：
{
  "k": "c",
  "v": "%(2000,4000,440,480)"
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"k": "c","v": "%(2000,4000,440,480)"}' \
-H "Content-Type: application/json" http://192.168.1.100:8081/api/globals
  • 返回值：
{
  "data": 1753,
  "code": 200,
  "message": "success"
}

修改全局变量某参数

  • 请求 URL： /api/globals/$id
  • 请求方式： PUT
  • Body 信息：
{
  "k": "ca-ring",
  "v": "%(2000,4000,440,480)"
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"k": "ca-ring","v": "%(2000,4000,440,480)"}' \
http://192.168.1.100:8081/api/globals/1753
  • 返回值：
{
  "data": "1753",
  "message": "success",
  "code": 200
}

删除指定全局变量

  • 请求 URL： /api/globals/$id

  • 请求方式： DELETE

  • Body 信息：无

  • 示例:

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE http://192.168.1.100:8081/api/globals/1753
  • 返回值：
{
  "message": "success",
  "data": "1753",
  "code": 200
}

参数

参数说明
realm不同的模块对应的值不同，已初始化的数据不要轻易修改
k参数名
v参数值
disabled是否启动；0-是 1-否，不填默认是
created_at创建时间
updated_at更新时间
deleted_at删除时间

查看参数详细信息

  • 请求 URL： /api/params
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[
	{
		"updated_at": "2025-08-19 08:52:04",
		"created_at": "2025-08-19 08:52:04",
		"disabled": 0,
		"id": 1,
		"realm": "REALMS",
		"v": "All Realmes",
		"k": "REALMS",
		"deleted_at": ""
	},
	{
		"updated_at": "2025-08-19 08:52:04",
		"created_at": "2025-08-19 08:52:04",
		"disabled": 0,
		"id": 2,
		"realm": "REALMS",
		"v": "Modules",
		"k": "MODULES",
		"deleted_at": ""
	}
  ...
]
  • curl 示例:
curl -X GET 'http://localhost:8080/api/params'

查看指定参数详细信息

  • 请求 URL： /api/params/:id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"v": "All Realmes",
	"id": 1,
	"deleted_at": "",
	"created_at": "2025-08-19 08:52:04",
	"disabled": 0,
	"k": "REALMS",
	"realm": "REALMS",
	"updated_at": "2025-08-19 08:52:04"
}
  • curl 示例:
curl -X GET 'http://localhost:8080/api/params/1'

查看所有系统参数

  • 请求 URL： /api/params/realm
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"data": [
		{
			"realm": "cURL",
			"id": "1"
		},
		{
			"realm": "XUNFEI-TTS",
			"id": "2"
		}
		...
	],
	"rowCount": 63,
	"page": 1,
	"pageCount": 2
}
  • curl 示例:
curl -XGET -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/params/realm

查看指定域参数

  • 请求 URL： /api/params/realm/$realm
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"rowCount": 17,
	"pageCount": 1,
	"page": 1,
	"data": [
		{
			"disabled": "0",
			"created_at": "2022-05-16 09:51:32",
			"v": "http://www.freeswitch.org/gateway.xml",
			"ref_id": "0",
			"deleted_at": "",
			"updated_at": "2022-05-16 09:51:32",
			"id": "210",
			"realm": "cURL",
			"k": "gateway-url"
		},
		{
			"disabled": "0",
			"created_at": "2022-05-16 09:51:32",
			"v": "muser:mypass",
			"ref_id": "0",
			"deleted_at": "",
			"updated_at": "2022-05-16 09:51:32",
			"id": "211",
			"realm": "cURL",
			"k": "gateway-credentials"
		}
		...
	]
}
  • curl 示例:
curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/params/realm/cURL

创建系统参数基本信息

  • 请求 URL： /api/params
  • 请求方式： POST
  • Body 信息：
{
  "disabled": 0, //默认开启
  "k": "test11", //名称
  "realm": "cURL", //域名称
  "v": "123" //值
}
  • curl 示例:
curl -POST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"disabled": 0,"k": "test11","realm": "cURL","v": "123"}' \
-H "Content-Type: application/json" http://192.168.1.100:8081/api/params
  • 返回值：
{
  "data": 1755,
  "message": "success",
  "code": 200
}

修改指定参数值

  • 请求 URL： /api/params/:id
  • 请求方式： PUT
  • Body 信息：
{
  "k": "test_t", //名称
  "v": "300" //值
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"k": "test_t","v": "300"}' \
192.168.1.100:8081/api/params/1755
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": "1755"
}

删除指定参数

  • 请求 URL： /api/params/:id
  • 请求方式： DELETE
  • Body 信息：无
  • 返回值：
{
  "message": "success",
  "code": 200,
  "data": "1755"
}

示例：

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE 192.168.1.100:8081/api/params/1755

分配器

分配器信息说明如下:

参数说明
id分配器ID
name名称
type总权重
created_at创建时间
updated_at更新时间
deleted_at删除时间

获取分配器

  • 请求 URL: /api/distributors 返回所有分配器信息

  • 请求 URL: /api/distributors/$id 返回指定 ID 的分配器信息

  • 请求方式: GET

  • 返回值: 路由 JSON 对象，如果找不到会返回 HTTP 状态码404。

  • curl 示例:

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" http://192.168.1.100:8081/api/distributors

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/distributors/1

返回

{
	"page": 1,
	"data": [
		{
			"type": "weight",
			"deleted_at": "",
			"created_at": "2025-08-21 09:46:59",
			"updated_at": "2025-08-21 09:46:59",
			"name": "1001",
			"description": "1",
			"id": "1"
		}
	],
	"rowCount": 1,
	"pageCount": 1
}

新建分配器

  • 请求 URL: /api/distributors
  • 请求方式: POST
  • 消息头: Content-Type: application/json
  • Body 信息: 参见分配器信息说明。

Body:

{
  "name": "test",
  "type": "weight"
}

返回:

{
  "message": "success",
  "code": 200,
  "data": 1
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"name": "test","type": "weight"}' \
-H "Content-Type: application/json" "http://192.168.1.100:8081/api/distributors"

删除分配器

  • 请求 URL: /api/distributors/$id
  • 请求方式: DELETE
  • 消息头: 无
  • 返回值:
状态返回值
成功{"code": 200,"message": "success","data": "1"}
失败404
  • 示例:
curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE http://192.168.1.100:8081/api/distributors/1

返回:

{
  "data": "1",
  "code": 200,
  "message": "success"
}

修改分配器

  • 请求 URL: /api/distributors/$id

  • 请求方式: PUT

  • 消息头: Content-Type: application/json

  • Body 信息: 参见分配器信息说明。

  • 示例:

Body:

{
  "name": "test",
  "type": "5"
}

返回:

{
  "data": "1",
  "code": 200,
  "message": "success"
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"name":"test","description": "test"}' \
"http://192.168.1.100:8081/api/distributors/1"

新建节点

  • 请求 URL: /api/distributors/$id/nodes
  • 请求方式: POST
  • 消息头: Content-Type: application/json
  • Body 信息: 参见分配器信息说明。

Body:

{
  "k": "gw",
  "v": "2"
}

返回:

{
  "message": "success",
  "data": 1,
  "code": 200
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"k": "gw","v":"2"}' \
-H "Content-Type: application/json" "http://192.168.1.100:8081/api/distributors/1/nodes"

修改分配器

  • 请求 URL: /api/distributors/id/nodes/$id

  • 请求方式: PUT

  • 消息头: Content-Type: application/json

  • Body 信息: 参见分配器信息说明。

  • 示例:

Body:

{
  "k": "test",
  "v": "test"
}

返回:

{
  "data": "2",
  "message": "success",
  "code": 200
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"k":"test","v": "test"}' \
"http://192.168.1.100:8081/api/distributors/2/nodes/2"

删除分配器指定节点

  • 请求 URL: /api/distributors/nodes/$id

  • 请求方式: DELETE

  • 消息头: 无

  • 返回值:

  • 示例:

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE http://192.168.1.100:8081/api/distributors/nodes/1

返回:

{
  "data": "1",
  "message": "success",
  "code": 200
}

黑白名单

黑白名单信息说明如下:

参数说明
name名称-必填
description描述
list_type名单类型 0：黑名单, 1：白名单 必填
limit_user_type限制用户类型 0：主叫限制, 1：被叫限制, 2：主被叫限制 必填
参数说明
params{ k , v}k：名称或说明, v：黑名单中号码

获取黑白名单

  • 请求 URL: /api/blacklists 返回所有黑名单信息

  • 请求 URL: /api/blacklists/$id 返回指定 ID 的黑名单信息

  • 请求方式: GET

  • 返回值: 路由 JSON 对象，如果找不到会返回 HTTP 状态码404。

  • curl 示例:

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" http://192.168.1.100:8081/api/blacklists

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/blacklists/1

返回：

{
  "data": [
    {
      "name": "hei",
      "limit_user_type": "1",
      "id": "2",
      "created_at": "2022-05-11 20:02:36",
      "description": "",
      "deleted_at": "",
      "updated_at": "2022-05-11 20:02:36",
      "list_type": "0"
    },
    {
      "name": "bai",
      "limit_user_type": "0",
      "id": "1",
      "created_at": "2022-05-11 20:02:26",
      "description": "",
      "deleted_at": "",
      "updated_at": "2022-05-11 20:02:26",
      "list_type": "1"
    }
  ],
  "page": 1,
  "rowCount": 2,
  "pageCount": 1
}

新建黑白名单

  • 请求 URL: /api/blacklists
  • 请求方式: POST
  • 消息头: Content-Type: application/json
  • Body 信息: 参见黑名单信息说明。

Body:

{
  "name": "test",
  "description": "test",
  "limit_user_type": "1",
  "list_type": "1"
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"name": "test","description":"test","limit_user_type": "1","list_type": "1"}' \
-H "Content-Type: application/json" "http://192.168.1.100:8081/api/blacklists"

返回:

{
  "message": "success",
  "code": 200,
  "data": 3
}

新建名单号码列表

  • 请求 URL: /api/blacklists/$id/lists
  • 请求方式: POST
  • 消息头: Content-Type: application/json
  • Body 信息: 参见黑名单信息说明。

Body:

{
  "k": "test",
  "v": "test"
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"k": "test","v":"test"}' \
-H "Content-Type: application/json" "http://192.168.1.100:8081/api/blacklists/1/lists"

返回:

{
  "code": 200,
  "data": 1501,
  "message": "success"
}

指定黑白名单下批量新建号码列表

  • 请求 URL: /api/blacklists/$id/import
  • 请求方式: POST
  • 消息头: Content-Type: application/json
  • Body 信息: 参见黑名单信息说明。
    • k：名称
    • v：号码

Body:

{
  "data": [
    {
      "k": "lili",
      "v": "1008"
    },
    {
      "k": "lisi",
      "v": "1009"
    },
    {
      "k": "1012",
      "v": "1012"
    }
  ]
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"data":[{"k": "lili","v": "1008"},{"k": "lisi","v": "1009"},{"k": "1012","v": "1012"}]}' \
-H "Content-Type: application/json" "http://192.168.1.100:8081/api/blacklists/3/import"

返回:

{
  "message": "success",
  "data": [
    {
      "id": 1502,
      "created_at": "2022-05-11 20:21:02",
      "v": "1008",
      "k": "lili",
      "deleted_at": "",
      "realm": "BLACKLIST",
      "updated_at": "2022-05-11 20:21:02",
      "ref_id": 3,
      "disabled": 0
    },
    {
      "id": 1503,
      "created_at": "2022-05-11 20:21:02",
      "v": "1009",
      "k": "lisi",
      "deleted_at": "",
      "realm": "BLACKLIST",
      "updated_at": "2022-05-11 20:21:02",
      "ref_id": 3,
      "disabled": 0
    },
    {
      "id": 1504,
      "created_at": "2022-05-11 20:21:02",
      "v": "1012",
      "k": "1012",
      "deleted_at": "",
      "realm": "BLACKLIST",
      "updated_at": "2022-05-11 20:21:02",
      "ref_id": 3,
      "disabled": 0
    }
  ],
  "code": 200
}

直接导入黑白名单号码数据

通过 Excel 文件导入黑白名单及对应的号码列表。

  • 请求 URL: /api/blacklists/import
  • 请求方式: POST
  • 消息头: Content-Type: application/json
  • Body 信息:

Body 信息由 Excel 文件解析而来，Excel 格式与导出格式一致。 key 为 Excel 的字段名。

{
  "lists": [
    {
      "名称": "import_1",
      "名单类型": 1,
      "限制用户类型": 1,
      "号码名称": "hello",
      "起始号码": "123"
    },
    {
      "名称": "import_1",
      "名单类型": 1,
      "限制用户类型": 1,
      "号码名称": "hello1",
      "起始号码": "12345"
    }
  ]
}
  • 返回值:
{
  "message": "success",
  "data": [
    {
      "list_type": 1,
      "name": "import_1",
      "limit_user_type": 1,
      "description": "",
      "id": 4
    }
  ],
  "code": 200
}
  • curl 示例:
curl -XPOST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"lists":[{"名称":"import_1","名单类型":1,"限制用户类型":1,"号码名称":"hello","起始号码":"123"},{"名称":"import_1","名单类型":1,"限制用户类型":1,"号码名称":"hello1","起始号码":"12345"}]}' \
-H "Content-Type: application/json" "http://192.168.1.100:8081/api/blacklists/import"

修改黑白名单

  • 请求 URL: /api/blacklists/$id
  • 请求方式: PUT
  • 消息头: Content-Type: application/json
  • Body 信息: 参见黑名单信息说明。
  • 返回值:
状态返回值
成功"code": 200
失败-ERR Cannot execute script
  • 示例:

Body:

{
  "name": "test01",
  "id": "2",
  "limit_user_type": "1",
  "list_type": "1",
  "description": "test01"
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"name":"test","description": "test","id":"1"}' \
"http://192.168.1.100:8081/api/blacklists/2"

返回:

{
  "code": 200,
  "data": "2",
  "message": "success"
}

修改号码列表

  • 请求 URL: /api/blacklists/$id/lists/$id
  • 请求方式: PUT
  • 消息头: Content-Type: application/json
  • Body 信息: 参见黑名单信息说明。
  • 返回值:
状态返回值
成功"code": 200
失败"code": 500
  • 示例:

Body:

{
  "k": "test",
  "v": "1008"
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"k":"test","v": "1008"}' \
"http://192.168.1.100:8081/api/blacklists/1/lists/1502"

返回:

{
  "message": "success",
  "data": "1502",
  "code": 200
}

批量修改名单下的号码列表

  • 请求 URL: /api/blacklists/$id/multimodify
  • 请求方式: PUT
  • 消息头: Content-Type: application/json
  • Body 信息: 参见黑名单信息说明。
  • 返回值:
状态返回值
成功返回最后一个修改值信息
失败"code": 500
  • 示例:
参数说明
k名称
v号码数
idid 为号码列表的id，必填项

Body:

{
  "data": [
    {
      "k": "xiaoyang",
      "v": "1003",
      "id": 1501
    },
    {
      "k": "xiaoyang1",
      "v": "1004",
      "id": 1502
    }
  ]
}
  • curl 示例:
curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"data":[{"k": "lili","v": "1001"},{"k": "xiaoyang","v": "1003"}]}' \
"http://192.168.1.100:8081/api/blacklists/3/multimodify"

返回:

{
  "code": 200,
  "data": {
    "disabled": 0,
    "ref_id": 3,
    "updated_at": "2022-05-11 20:24:58",
    "deleted_at": "",
    "realm": "BLACKLIST",
    "v": "1003",
    "created_at": "2022-05-11 20:19:45",
    "id": 1501,
    "k": "xiaoyang"
  },
  "message": "success"
}

删除黑白名单

  • 请求 URL: /api/blacklists/$id
  • 请求方式: DELETE
  • 消息头: 无
  • 返回值:
状态返回值
成功"code": 200
失败404
  • 示例:
curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE http://192.168.1.100:8081/api/blacklists/3

返回:

{
  "data": "3",
  "code": 200,
  "message": "success"
}

删除号码列表

  • 请求 URL: /api/blacklists/$id/lists/$id
  • 请求方式: DELETE
  • 消息头: 无
  • 返回值:
状态返回值
成功"code": 200
失败404
  • 示例:
curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE http://192.168.1.100:8081/api/blacklists/4/lists/1120

返回:

{
  "message": "success",
  "code": 200,
  "data": "1120"
}

数据字典

数据字典信息说明如下：

参数说明
id数据字典 ID
realm数据字典所属领域
k数据字典键
v数据字典值
d数据字典描述
o数据字典所属分配器 ID
created_at创建时间
updated_at更新时间
deleted_at删除时间

获取数据字典信息

  • 请求 URL: /api/dicts
  • 请求方式: GET
  • 消息头: 无
  • 返回值:
[
	{
		"deleted_at": "",
		"created_at": "2025-08-19 08:52:03",
		"v": "acls_delete",
		"o": 0,
		"id": 427,
		"k": "Delete",
		"updated_at": "2025-08-19 08:52:03",
		"realm": "/settings/acls",
		"d": ""
	}
  ...
]

获取数据字典所属的领域

  • 请求 URL: /api/dicts/realm
  • 请求方式: GET
  • 消息头: 无
  • 返回值:
[
	{
		"id": "1",
		"realm": "XUI_SCRIPTS"
	},
	{
		"id": "2",
		"realm": "XUI"
	},
	{
		"id": "3",
		"realm": "XAPPS"
	}
  ...
]

获取某个领域的数据字典

  • 请求 URL: /api/dicts/realm/:realm
  • 请求方式: GET
  • 消息头: 无
  • 返回值:
[
	{
		"updated_at": "2025-08-19 08:52:02",
		"k": "REALMS",
		"deleted_at": "",
		"v": "All Realmes",
		"d": "所有键值对的的根节点",
		"created_at": "2025-08-19 08:52:02",
		"o": "0",
		"id": "1",
		"realm": "REALMS"
	}
  ...
]

获取数据字典的详细信息

  • 请求 URL: /api/dicts/:id
  • 请求方式: GET
  • 消息头: 无
  • 返回值:
{
	"k": "REALMS",
	"updated_at": "2025-08-19 08:52:02",
	"o": 0,
	"d": "所有键值对的的根节点",
	"deleted_at": "",
	"id": 1,
	"created_at": "2025-08-19 08:52:02",
	"realm": "REALMS",
	"v": "All Realmes"
}

修改数据字典数据

  • 请求 URL: /api/dicts/:id
  • 请求方式: PUT
  • 消息头: 无
  • Body 信息:
{
    "o": "",
    "d": "新字典"
}
  • 返回值:
{
	"code": 200,
	"message": "success",
	"data": "1"
}

创建数据字典

  • 请求 URL: /api/dicts
  • 请求方式: POST
  • 消息头: 无
  • Body 信息:
{
  "d": "新字典",
	"o": 0,
	"k": "NEWDICT",
	"realm": "REALMS"
}
  • 返回值:
{
	"message": "success",
	"data": 647,
	"code": 200
}

批量导入数据字典

  • 请求 URL: /api/dicts/import
  • 请求方式: POST
  • 消息头: 无
  • Body 信息:
{
  "request": [
    {
      "d": "批量1",
      "o": 0,
      "k": "IMPORT1",
      "realm": "REALMS"
    },
    {
      "d": "批量2",
      "o": 0,
      "k": "IMPORT2",
      "realm": "REALMS"
    }
  ]
}
  • 返回值:
{
	"code": 200,
	"message": "success",
	"data": {
		"request": [
			{
				"o": 0,
				"d": "批量1",
				"realm": "REALMS",
				"k": "IMPORT1"
			},
			{
				"o": 0,
				"d": "批量2",
				"realm": "REALMS",
				"k": "IMPORT2"
			}
		]
	}
}

删除数据字典

  • 请求 URL: /api/dicts/:id
  • 请求方式: DELETE
  • 消息头: 无
  • Body 信息: 无
  • 返回值:
{
	"message": "success",
	"data": 647,
	"code": 200
}

脚本

脚本信息说明如下:

参数说明
v脚本运行路径
status脚本运行状态
disabled是否启用 0 启用 1 禁用
param脚本名

获取脚本信息

  • 请求 URL: api/script_lists?type=0 返回所有系统脚本信息

  • 请求 URL: api/script_lists?type=1 返回所有功能脚本信息

  • 请求方式: GET

  • 返回值: 路由 JSON 对象，如果找不到会返回 HTTP 状态码404。

  • curl 示例:

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" http://192.168.1.100:8081/api/script_lists?type=0

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/script_lists?type=1

返回

{
  "rowCount": 8,
  "page": 1,
  "data": [
    {
      "ref_id": "",
      "id": "812",
      "v": "xui/xlonglive/auto_call_task.lua",
      "deleted_at": "",
      "realm": "API_ON_STARTUP",
      "created_at": "2023-03-01 01:18:57",
      "disabled": "1",
      "updated_at": "2023-03-01 01:18:57",
      "log_disabled": 1,
      "param": "auto-call-task",
      "k": "luarun",
      "status": "stop"
    }
    ...
  ],
  "pageCount": 1
}

操作参数记录（启用/禁用脚本及日志）

  • 请求 URL: api/script_lists/ 返回所有系统脚本信息
  • 请求方式: PUT
  • 返回值: 路由 JSON 对象，如果找不到会返回 HTTP 状态码404。
  • Body 信息:
{
    "type": 1,
    "id": 579,
    "enable_script": 0
}

返回值

{
	"data": {
		"id": 579,
		"created_at": "2025-08-19 08:52:04",
		"deleted_at": "",
		"v": "xcallback-track",
		"realm": "XUI_SCRIPTS",
		"k": "xcallback-track",
		"updated_at": "2025-08-19 08:52:04",
		"o": 0,
		"log_disabled": 1,
		"d": "启用智能回呼"
	},
	"code": 200,
	"message": "success"
}

系统

获取当前的数据库模式

  • 请求 URL: api/system/schema
  • 请求方式: GET
  • Body 信息: 无
  • 返回值:
[
	"backup_database_2025_08_22_15_39"
]

获得数据库备份文件

生成当前数据库模式的 SQL 备份文件（.sql）

  • 请求 URL: api/system/backup_schema
  • 请求方式: GET
  • Body 信息: 无
  • 返回值: 下载 SQL 文件
{
	"code": 200,
	"message": "success",
	"data": "SET\nSET\nSET\nSET\nSET\n set_config \n------------\n \n(1 row)\n\nSET ... " 
}

获取端口配置

  • 请求 URL: api/system/port
  • 请求方式: GET
  • Body 信息: 无
  • 返回值:
{
	"data": {
		"rtp_start_port": "19000",
		"rtp_end_port": "19100",
		"sip_wss_port": "",
		"sip_tls_port": "",
		"verto_ws_port": "18081",
		"agora_rtp_end": "",
		"agora_rtp_start": "",
		"sip_public_port": "5080",
		"sip_ws_port": "",
		"bfcp": "",
		"sip_port": "5060",
		"verto_wss_port": "8082"
	},
	"code": 200,
	"message": "success"
}

切换备份的数据库

  • 请求 URL: api/system/switch_schema
  • 请求方式: POST
  • Body 信息:
{
	"schema_name": "xswitch_back"
}
  • 返回值:
{
	"message": "success",
	"data": "xswitch_back",
	"code": 200
}
高级配置-扩展功能
高级配置-模块配置