REST API文档

高级配置-模块配置

系统模块

参数说明
kFreeSWITCH 模块名称
disabled是否启用 0-启用 1-不启用
status状态 false-未运行 true-运行

查看系统模块

  • 请求 URL： /api/modules
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[
	{
		"deleted_at": "",
		"updated_at": "2022-05-16 09:51:32",
		"v": "",
		"id": 79,
		"k": "mod_console",
		"created_at": "2022-05-16 09:51:32",
		"realm": "MODULES",
		"ref_id": 0,
		"disabled": 0
	},
	{
		"deleted_at": "",
		"updated_at": "2022-05-16 09:51:32",
		"v": "",
		"id": 80,
		"k": "mod_graylog2",
		"created_at": "2022-05-16 09:51:32",
		"realm": "MODULES",
		"ref_id": 0,
		"disabled": 1
	}
	...
]
  • curl 示例:
curl -XGET -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/modules

新增系统模块

  • 请求 URL： /api/modules
  • 请求方式： POST
  • Body 信息：
{
  "k": "mod_test",
  "disabled": "1"
}
  • curl 示例:
curl -POST -H "X-XTRA-AUTH-ID: 69ee9c54-734b-11e7-a262-b5df20245f60" \
-d '{"k": "mod_test","disabled": "1"}' \
-H "Content-Type: application/json" http://192.168.1.100:8081/api/modules
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": 1754
}

修改系统模块

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

删除系统模块

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

示例：

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

XCC—RTC

查看 XCC-RTC 配置

  • 请求 URL： /api/xcc_rtc
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[
  {
    "description": "default profile",
    "id": 1,
    "name": "default",
    "disabled": 0,
    "created_at": "2022-05-16 09:51:32",
    "deleted_at": "",
    "updated_at": "2022-05-16 09:51:32"
  }
]

查看 XCC-RTC 的配置参数

  • 请求 URL： /api/xcc_rtc/$id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"deleted_at": "",
	"id": 1,
	"updated_at": "2022-05-16 09:51:32",
	"params": [
		{
			"updated_at": "2022-05-16 09:51:32",
			"deleted_at": "",
			"disabled": "0",
			"created_at": "2022-05-16 09:51:32",
			"id": "566",
			"ref_id": "1",
			"v": "$${domain}",
			"k": "force-register-domain",
			"realm": "XCC-RTC-DEFAULT"
		},
		{
			"updated_at": "2022-05-16 09:51:32",
			"deleted_at": "",
			"disabled": "0",
			"created_at": "2022-05-16 09:51:32",
			"id": "567",
			"ref_id": "1",
			"v": "true",
			"k": "userauth",
			"realm": "XCC-RTC-DEFAULT"
		}
		...
	],
	"name": "default",
	"disabled": 0,
	"created_at": "2022-05-16 09:51:32",
	"description": "default profile"
}

创建 XCC-RTC profile

  • 请求 URL： /api/xcc_rtc
  • 请求方式： POST
  • Body 信息：
{
  "name": "test",
  "disabled": "1",
  "template": "default"
}
  • 返回值：
{
  "message": "success",
  "data": 3,
  "code": 200
}

修改 XCC-RTC profile

  • 请求 URL： /api/xcc_rtc/$id
  • 请求方式： PUT
  • Body 信息：
{
  "description": "default profile",
  "name": "default"
}
  • 返回值：
{
  "code": 200,
  "data": "2",
  "message": "success"
}

创建 XCC-RTC 配置中 Default Profile

  • 请求 URL： /api/xcc_rtc/$id/params
  • 请求方式： POST
  • Body 信息：
{
  "name": "test",
  "realm": "XCC-RTC-DEFAULT",
  "value": "test"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": 1877
}

修改 XCC-RTC 配置中 Default Profile

  • 请求 URL： /api/xcc_rtc/$id/params/$param_id
  • 请求方式： PUT
  • Body 信息：
{
  "action": "toggle"
}

或

{
  "k": "test",
  "v": "true"
}
  • 返回值：
{
  "message": "success",
  "code": 200,
  "data": "2152"
}

启用/禁用 XCC-RTC 的 Setting 参数

  • 请求 URL： /api/params/$param_id
  • 请求方式： PUT
  • Body 信息：
{
  "action": "toggle"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": "544"
}

创建 XCC-RTC 的 Setting 参数

  • 请求 URL： /api/params
  • 请求方式： POST
  • Body 信息：
{
  "k": "3",
  "v": "1",
  "realm": "XCC-RTC",
  "ref_id": 0
}
  • 返回值：
{
	"message": "success",
	"code": 200,
	"data": 3148
}

删除 XCC-RTC 配置中 Default Profile

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

删除指定 XCC-RTC

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

微信小程序

查看微信小程序的列表

  • 请求 URL： /api/wxapp_profiles
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[
  {
    "name": "wxapp",
    "created_at": "2022-05-16 09:51:32",
    "deleted_at": "",
    "disabled": 0,
    "description": "default",
    "updated_at": "2022-05-16 09:51:32",
    "id": 1
  }
]

查看指定小程序的详细信息

  • 请求 URL： /api/wxapp_profiles/$id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"disabled": 0,
	"deleted_at": "",
	"params": [
		{
			"ref_id": "1",
			"id": "704",
			"realm": "WX-APP",
			"disabled": "0",
			"deleted_at": "",
			"k": "context",
			"created_at": "2022-05-16 09:51:32",
			"updated_at": "2022-05-16 09:51:32",
			"v": "context-1"
		},
		{
			"ref_id": "1",
			"id": "705",
			"realm": "WX-APP",
			"disabled": "0",
			"deleted_at": "",
			"k": "use-auth",
			"created_at": "2022-05-16 09:51:32",
			"updated_at": "2022-05-16 09:51:32",
			"v": "true"
		}
		...
	],
	"id": 1,
	"description": "default",
	"created_at": "2022-05-16 09:51:32",
	"updated_at": "2022-05-16 09:51:32",
	"name": "wxapp"
}

创建微信小程序

  • 请求 URL： /api/wxapp_profiles
  • 请求方式： POST
  • Body 信息：
参数说明
name名称
description描述
template模板
{
  "name": "test",
  "description": "测试",
  "template": "default"
}
  • 返回值：
{
  "code": 200,
  "data": 2,
  "message": "success"
}

修改小程序的名称和描述

  • 请求 URL： /api/wxapp_profiles/$id
  • 请求方式： PUT
  • Body 信息：
参数说明
name名称
description描述
disabled是否启用，0 为启用，1 为不启用
{
  "name": "default"
}

或

{
  "disabled": "1"
}
  • 返回值：
{
  "code": 200,
  "data": "2",
  "message": "success"
}

修改微信小程序的启用状态

  • 请求 URL： /api/wxapp_profiles/toggle/:id
  • 请求方式： PUT
  • Body 信息：无
  • 返回值：
{
	"data":	"1",
	"message":	"success",
	"code":	200
}

修改微信小程序的 Settings 参数配置

  • 请求 URL： /api/wxapp_profiles/$id/params/$param_id
  • 请求方式： PUT
  • Body 信息：
参数说明
v需要修改的参数内容
action变更启用状态，固定为"toggle"

修改参数内容:

{
  "v": "context-1"
}

变更参数启用状态：

{
  "action": "toggle"
}
  • 返回值：
{
  "code": 200,
  "data": "1878",
  "message": "success"
}

删除指定小程序

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

EventSocket

查看 Socket 事件列表

  • 请求 URL： /api/event_socket
  • 请求方式： GET
  • Body 信息：无
  • 示例： /api/event_socket?perpage=100&page=1
  • 返回值：
{
	"pageCount": 1,
	"rowCount": 8,
	"page": 1,
	"data": [
		{
			"id": 202,
			"updated_at": "2022-05-16 09:51:32",
			"v": "127.0.0.1",
			"ref_id": 0,
			"realm": "EVENT-SOCKET",
			"created_at": "2022-05-16 09:51:32",
			"disabled": 0,
			"deleted_at": "",
			"k": "listen-ip"
		},
		{
			"id": 203,
			"updated_at": "2022-05-16 09:51:32",
			"v": "1",
			"ref_id": 0,
			"realm": "EVENT-SOCKET",
			"created_at": "2022-05-16 09:51:32",
			"disabled": 1,
			"deleted_at": "",
			"k": "debug"
		}
		...
	]
}

创建 Socket 事件参数

  • 请求 URL： /api/event_socket
  • 请求方式： POST
  • Body 信息：
参数说明
k参数名称
v参数内容
{
  "k": "test",
  "v": "test"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": 1889
}

启用/禁用 Socket 事件参数

  • 请求 URL： /api/event_socket/:param_id
  • 请求方式： PUT
  • Body 信息：
参数说明
action变更启用状态，固定为"toggle"
{
  "action": "toggle"
}
  • 返回值：
{
  "data": "1889",
  "code": 200,
  "message": "success"
}

修改 Socket 事件参数

  • 请求 URL： /api/event_socket/$param_id
  • 请求方式： PUT
  • Body 信息：
参数说明
v要修改的参数内容
{
  "v": "test—11"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": "1889"
}

删除 Socket 事件参数

  • 请求 URL： /api/event_socket/$param_id
  • 请求方式： DELETE
  • Body 信息：无
  • 返回值：
{
  "data": "1889",
  "code": 200,
  "message": "success"
}

XUI

查看 XUI 列表

  • 请求 URL： /api/xui_profiles
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[
  {
    "id": 1,
    "description": "default",
    "created_at": "2022-05-16 09:51:32",
    "updated_at": "2022-05-16 09:51:32",
    "disabled": 0,
    "name": "xui",
    "deleted_at": ""
  }
]

查看指定 XUI

  • 请求 URL： /api/xui_profiles/:id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"description": "default",
	"created_at": "2022-05-16 09:51:32",
	"name": "xui",
	"params": [
		{
			"created_at": "2022-05-16 09:51:32",
			"realm": "XUI-SETTINGS",
			"v": "0",
			"k": "debug",
			"updated_at": "2022-05-16 09:51:32",
			"id": "721",
			"ref_id": "1",
			"deleted_at": "",
			"disabled": "0"
		}
		...
		[
			{
				"k": "CHANNEL_CREATE",
				"realm": "XUI-BINDINGS",
				"v": "",
				"o": "0",
				"updated_at": "2022-05-16 09:51:32",
				"created_at": "2022-05-16 09:51:32",
				"id": "13",
				"ref_id": "1",
				"deleted_at": "",
				"disabled": "0"
			}
			...
		]
	],
	"id": 1,
	"disabled": 0,
	"deleted_at": "",
	"updated_at": "2022-05-16 09:51:32"
}

创建 XUI

  • 请求 URL： /api/xui_profiles
  • 请求方式： POST
  • Body 信息：
参数说明
name名称
description描述
template模板
disabled是否启用，1 为不启用，0 为启用
{
  "disabled": "1",
  "name": "222",
  "template": "default",
  "description": "test"
}
  • 返回值：
{
  "data": 2,
  "code": 200,
  "message": "success"
}

修改 XUI名称或描述

  • 请求 URL： /api/xui_profiles/$id
  • 请求方式： PUT
  • Body 信息：
参数说明
name名称
description描述
{
  "name": "test1",
  "description": "test1"
}
  • 返回值：
{
  "code": 200,
  "data": "2",
  "message": "success"
}

启用/禁用 XUI 配置

  • 请求 URL： /api/xui_profiles/toggle/:id
  • 请求方式： PUT
  • Body 信息：
参数说明
action变更启用状态，固定为"toggle"
{
  "action": "toggle"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": "2"
}

创建 XUI-SETTINGS 参数

  • 请求 URL： /api/xui_profiles/$id/settings
  • 请求方式： POST
  • Body 信息：
参数说明
k参数名称
v参数内容
{
  "k": "test1",
  "v": "test1"
}
  • 返回值：
{
  "data": 1896,
  "message": "success",
  "code": 200
}

修改 XUI-SETTINGS 参数

  • 请求 URL： /api/xui_profiles/$id/settings/param_id
  • 请求方式： PUT
  • Body 信息：
参数说明
v要修改的参数内容
{
  "v": "test"
}
  • 返回值：
{
  "data": "1896",
  "code": 200,
  "message": "success"
}

删除 XUI-SETTINGS 参数

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

创建 XUI-BINDINGS 参数

  • 请求 URL： /api/xui_profiles/$id/bindings
  • 请求方式： POST
  • Body 信息：
参数说明
k参数名称
v参数内容
{
  "k": "test",
  "v": "999"
}
  • 返回值：
{
  "message": "success",
  "data": 37,
  "code": 200
}

修改 XUI-BINDINGS 参数

  • 请求 URL： /api/xui_profiles/$id/bindings/$param_id
  • 请求方式： PUT
  • Body 信息：
参数说明
v要修改的参数内容
{
  "v": "test"
}
  • 返回值：
{
  "data": "37",
  "code": 200,
  "message": "success"
}

删除 XUI-BINDINGS 参数

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

删除指定XUI

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

WS Stream

获取 WS Stream 信息

  • 请求 URL： /api/wsstream_profiles
  • 请求方式： GET
  • 示例： GET /api/wsstream_profiles
  • Body 信息：无
  • 返回值：
[
	{
		"name": "default",
		"updated_at": "2025-08-19 08:52:04",
		"created_at": "2025-08-19 08:52:04",
		"id": 1,
		"deleted_at": "",
		"disabled": 0,
		"description": "default"
	}
]

获取 WS Stream 详细信息

  • 请求 URL： /api/wsstream_profiles/:id
  • 请求方式： GET
  • Body 信息：无
  • 示例： GET /api/wsstream_profiles/1
  • 返回值：
{
	"deleted_at": "",
	"name": "default",
	"params": [
		{
			"id": "2446",
			"created_at": "2025-08-19 08:52:09",
			"disabled": "0",
			"v": "2",
			"realm": "WSSTREAM-SETTINGS",
			"k": "max-cache-second",
			"deleted_at": "",
			"ref_id": "1",
			"updated_at": "2025-08-19 08:52:09"
		},
		{
			"id": "2444",
			"created_at": "2025-08-19 08:52:09",
			"disabled": "0",
			"v": "ws://localhost:9000",
			"realm": "WSSTREAM-SETTINGS",
			"k": "ws-url",
			"deleted_at": "",
			"ref_id": "1",
			"updated_at": "2025-08-19 08:52:09"
		},
		[
			{
				"id": "2447",
				"created_at": "2025-08-19 08:52:09",
				"disabled": "0",
				"v": "2",
				"realm": "WSSTREAM-INTERFACE",
				"k": "max-cache-second",
				"deleted_at": "",
				"ref_id": "1",
				"updated_at": "2025-08-19 08:52:09"
			},
			{
				"id": "2445",
				"created_at": "2025-08-19 08:52:09",
				"disabled": "0",
				"v": "ws://localhost:9000",
				"realm": "WSSTREAM-INTERFACE",
				"k": "ws-url",
				"deleted_at": "",
				"ref_id": "1",
				"updated_at": "2025-08-19 08:52:09"
			}
		]
	],
	"description": "default",
	"created_at": "2025-08-19 08:52:04",
	"disabled": 0,
	"updated_at": "2025-08-19 08:52:04",
	"id": 1
}

修改 WS Stream 信息

  • 请求 URL： /api/wsstream_profiles/:id
  • 请求方式： PUT
  • 示例： PUT /api/wsstream_profiles/1
  • Body 信息：
{
  "name": "text",
  "description": "text",
  "id": 1
}
  • 返回值：
{
	"data": "1",
	"code": 200,
	"message": "success"
}

修改 WS Stream 启用状态

  • 请求 URL： /api/wsstream_profiles/toggle/:id
  • 请求方式： PUT
  • 示例： PUT /api/wsstream_profiles/toggle/1
  • Body 信息：
{
  "name": "text",
  "description": "text",
  "id": 1
}
  • 返回值：
{
	"message": "success",
	"data": "1",
	"code": 200
}

修改 WSSTREAM SETTINGS 模块参数

  • 请求 URL： /api/wsstream_profiles/:id/settings/:param_id
  • 请求方式： PUT
  • 示例： PUT /api/wsstream_profiles/1/settings/2446
  • Body 信息：
{
  "k": "max-cache-second",
  "v": "22222",
  "realm": "WSSTREAM-SETTINGS"
}
  • 返回值：
{
	"message": "success",
	"data": "2446",
	"code": 200
}

修改 WSSTREAM INTERFACE 模块参数

  • 请求 URL： /api/wsstream_profiles/:id/interface/:param_id
  • 请求方式： PUT
  • 示例： PUT /api/wsstream_profiles/1/interface/3150
  • Body 信息：
{
  "k": "text",
  "v": "6666",
  "realm": "WSSTREAM-INTERFACE"
}
  • 返回值：
{
	"code": 200,
	"data": "3150",
	"message": "success"
}

新建 WS Stream

  • 请求 URL： /api/wsstream_profiles
  • 请求方式： POST
  • 示例： POST /api/wsstream_profiles
  • Body 信息：
{
  "name": "TEXT",
  "template": "default",
  "disabled": "1"
}
  • 返回值：
{
	"code": 200,
	"data": 3,
	"message": "success"
}

新建 WSSTREAM SETTINGS 模块参数

  • 请求 URL： /api/wsstream_profiles/:id/settings
  • 请求方式： POST
  • 示例： POST /api/wsstream_profiles/1/settings
  • Body 信息：
{
  "k": "TEXTTT",
  "v": "text",
  "realm": "WSSTREAM-SETTINGS"
}
  • 返回值：
{
	"code": 200,
	"data": "3160",
	"message": "success"
}

新建 WSSTREAM INTERFACE 模块参数

  • 请求 URL： /api/wsstream_profiles/:id/interface
  • 请求方式： POST
  • 示例： POST /api/wsstream_profiles/2/interface
  • Body 信息：
{
  "k": "TEXTTT",
  "v": "text",
  "realm": "WSSTREAM-INTERFACE"
}
  • 返回值：
{
	"code": 200,
	"data": "3161",
	"message": "success"
}

删除 WSSTREAM SETTINGS 模块参数

  • 请求 URL： /api/wsstream_profiles/:id/settings/:param_id
  • 请求方式： DELETE
  • 示例： DELETE /api/wsstream_profiles/2/settings/3160
  • Body 信息：无
  • 返回值：
{
	"code": 200,
	"data": "3160",
	"message": "success"
}

删除 WSSTREAM INTERFACE 模块参数

  • 请求 URL： /api/wsstream_profiles/:id/interface/:param_id
  • 请求方式： DELETE
  • 示例： DELETE /api/wsstream_profiles/2/interface/3161
  • Body 信息：无
  • 返回值：
{
	"code": 200,
	"data": "3161",
	"message": "success"
}

删除 WS Stream

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

Verto

查看 Verto 基本信息

  • 请求 URL： /api/verto_profiles
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[{
    "name":"default-v4",
    "created_at":"2024-07-10 02:53:14",
    "disabled":0,
    "deleted_at":"",
    "updated_at":"2024-07-10 02:53:14",
    "description":"default-v4",
    "id":1
}]

查看指定Verto 的配置参数

  • 请求 URL： /api/verto_profiles/$id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"description": "default-v4",
	"params": [
		{
			"k": "bind-local",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2000",
			"ref_id": "1",
			"v": "$${local_ip_v4}:$${VERTO_WS_PORT}",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "bind-local-secure",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2001",
			"ref_id": "1",
			"v": "$${local_ip_v4}:$${VERTO_WSS_PORT}",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "force-register-domain",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2002",
			"ref_id": "1",
			"v": "$${domain}",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "secure-combined",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2003",
			"ref_id": "1",
			"v": "$${certs_dir}/wss.pem",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "secure-chain",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2004",
			"ref_id": "1",
			"v": "$${certs_dir}/wss.pem",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "userauth",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2005",
			"ref_id": "1",
			"v": "true",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "blind-reg",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2006",
			"ref_id": "1",
			"v": "false",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "mcast-ip",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2007",
			"ref_id": "1",
			"v": "224.1.1.1",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "mcast-port",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2008",
			"ref_id": "1",
			"v": "1337",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "rtp-ip",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2009",
			"ref_id": "1",
			"v": "$${local_ip_v4}",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "ext-rtp-ip",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2010",
			"ref_id": "1",
			"v": "$${ext_rtp_ip}",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "local-network",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2011",
			"ref_id": "1",
			"v": "localnet.auto",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "outbound-codec-string",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2012",
			"ref_id": "1",
			"v": "opus,vp8",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "inbound-codec-string",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2013",
			"ref_id": "1",
			"v": "opus,vp8",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "apply-candidate-acl",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2014",
			"ref_id": "1",
			"v": "localnet.auto",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "apply-candidate-acl:1",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2015",
			"ref_id": "1",
			"v": "wan_v4.auto",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "apply-candidate-acl:2",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2016",
			"ref_id": "1",
			"v": "rfc1918.auto",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "apply-candidate-acl:3",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2017",
			"ref_id": "1",
			"v": "any_v4.auto",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "timer-name",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2018",
			"ref_id": "1",
			"v": "soft",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "xui-auth",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2019",
			"ref_id": "1",
			"v": "hash",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "options-cross-domain",
			"disabled": "0",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2020",
			"ref_id": "1",
			"v": "*",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		},
		{
			"k": "jwt-secret",
			"disabled": "1",
			"created_at": "2024-07-10 02:53:14",
			"realm": "VERTO-PROFILE",
			"id": "2021",
			"ref_id": "1",
			"v": "secret",
			"deleted_at": "",
			"updated_at": "2024-07-10 02:53:14"
		}
	],
	"name": "default-v4",
	"id": 1,
	"updated_at": "2024-07-10 02:53:14",
	"disabled": 0,
	"deleted_at": "",
	"created_at": "2024-07-10 02:53:14"
}

查看 Verto 的 Setting 的信息

  • 请求 URL： /api/verto_profiles/setting
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[{
		"v":	"0",
		"disabled":	0,
		"realm":	"VERTO-SETTINGS",
		"k":	"debug",
		"id":	2217,
		"updated_at":	"2025-08-19 08:52:08",
		"created_at":	"2025-08-19 08:52:08",
		"deleted_at":	"",
		"ref_id":	0
	}, {
		"v":	"true",
		"disabled":	0,
		"realm":	"VERTO-SETTINGS",
		"k":	"enable-fs-events",
		"id":	2218,
		"updated_at":	"2025-08-19 08:52:08",
		"created_at":	"2025-08-19 08:52:08",
		"deleted_at":	"",
		"ref_id":	0
	}, {
		"v":	"true",
		"disabled":	0,
		"realm":	"VERTO-SETTINGS",
		"k":	"enable-presence",
		"id":	2219,
		"updated_at":	"2025-08-19 08:52:08",
		"created_at":	"2025-08-19 08:52:08",
		"deleted_at":	"",
		"ref_id":	0
	}, {
		"v":	"true",
		"disabled":	0,
		"realm":	"VERTO-SETTINGS",
		"k":	"event-channel-enable-hierarchy-deliver",
		"id":	2220,
		"updated_at":	"2025-08-19 08:52:08",
		"created_at":	"2025-08-19 08:52:08",
		"deleted_at":	"",
		"ref_id":	0
	}]

查看指定 Verto 的 vhost信息

  • 请求 URL： /api/verto_profiles/$id/verto_vhosts
  • 请求方式： GET
  • 示例： /api/verto_profiles/1/verto_vhosts
  • Body 信息：无
  • 返回值：
{
	"params": [
		{
			"id": "6",
			"disabled": "0",
			"v": "seven.local freeswitch.org",
			"ref_id": "1",
			"created_at": "2025-08-19 08:52:04",
			"vhost_id": "1",
			"updated_at": "2025-08-19 08:52:04",
			"k": "alias",
			"deleted_at": "",
			"realm": "VERTO-PROFILE-VHOST"
		},
		{
			"id": "7",
			"disabled": "0",
			"v": "$${base_dir}/xui/www",
			"ref_id": "1",
			"created_at": "2025-08-19 08:52:04",
			"vhost_id": "1",
			"updated_at": "2025-08-19 08:52:04",
			"k": "root",
			"deleted_at": "",
			"realm": "VERTO-PROFILE-VHOST"
		},
		{
			"id": "8",
			"disabled": "0",
			"v": "$${base_dir}/xui/lua/xui",
			"ref_id": "1",
			"created_at": "2025-08-19 08:52:04",
			"vhost_id": "1",
			"updated_at": "2025-08-19 08:52:04",
			"k": "script-root",
			"deleted_at": "",
			"realm": "VERTO-PROFILE-VHOST"
		},
		{
			"id": "9",
			"disabled": "0",
			"v": "index.html",
			"ref_id": "1",
			"created_at": "2025-08-19 08:52:04",
			"vhost_id": "1",
			"updated_at": "2025-08-19 08:52:04",
			"k": "index",
			"deleted_at": "",
			"realm": "VERTO-PROFILE-VHOST"
		},
		{
			"id": "10",
			"disabled": "0",
			"v": "/init.lua",
			"ref_id": "1",
			"created_at": "2025-08-19 08:52:04",
			"vhost_id": "1",
			"updated_at": "2025-08-19 08:52:04",
			"k": "^/api",
			"deleted_at": "",
			"realm": "VERTO-PROFILE-VHOST-REWRITE"
		}
	],
	"description": "default-v4",
	"name": "default-v4",
	"id": 1,
	"updated_at": "2025-08-19 08:52:04",
	"disabled": 0,
	"deleted_at": "",
	"created_at": "2025-08-19 08:52:04"
}

查看指定 Verto 的vhost信息

  • 请求 URL： /api/verto_profiles/$id/verto_vhosts
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
  • 返回值：
[{
    "deleted_at": "",
    "updated_at": "2024-07-16 09:19:01",
    "id": 4,
    "created_at": "2024-07-16 09:19:01",
    "ref_id": 4,
    "name": "localhost"
}]

查看指定 Verto 的指定类别的 Vhost 信息

  • 请求 URL： /api/verto_profiles/&id/vhost/&vhost_id/vhost_params
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"ref_id":	1,
	"deleted_at":	"",
	"id":	1,
	"created_at":	"2025-08-19 08:52:04",
	"name":	"localhost",
	"params":	[{
			"id":	"6",
			"ref_id":	"1",
			"k":	"alias",
			"realm":	"VERTO-PROFILE-VHOST",
			"v":	"seven.local freeswitch.org",
			"deleted_at":	"",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:04",
			"vhost_id":	"1",
			"updated_at":	"2025-08-19 08:52:04"
		}, {
			"id":	"9",
			"ref_id":	"1",
			"k":	"index",
			"realm":	"VERTO-PROFILE-VHOST",
			"v":	"index.html",
			"deleted_at":	"",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:04",
			"vhost_id":	"1",
			"updated_at":	"2025-08-19 08:52:04"
		}, {
			"id":	"7",
			"ref_id":	"1",
			"k":	"root",
			"realm":	"VERTO-PROFILE-VHOST",
			"v":	"$${base_dir}/xui/www",
			"deleted_at":	"",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:04",
			"vhost_id":	"1",
			"updated_at":	"2025-08-19 08:52:04"
		}, {
			"id":	"8",
			"ref_id":	"1",
			"k":	"script-root",
			"realm":	"VERTO-PROFILE-VHOST",
			"v":	"$${base_dir}/xui/lua/xui",
			"deleted_at":	"",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:04",
			"vhost_id":	"1",
			"updated_at":	"2025-08-19 08:52:04"
		}, {
			"id":	"10",
			"ref_id":	"1",
			"k":	"^/api",
			"realm":	"VERTO-PROFILE-VHOST-REWRITE",
			"v":	"/init.lua",
			"deleted_at":	"",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:04",
			"vhost_id":	"1",
			"updated_at":	"2025-08-19 08:52:04"
		}],
	"updated_at":	"2025-08-19 08:52:04"
}

创建 Verto Setting

  • 请求 URL： /api/verto_profiles/setting
  • 请求方式： POST
  • Body 信息：
{
  "k": "TEXT",
  "v": "1",
  "realm": "VERTO-SETTINGS",
  "ref_id": 1,
  "disabled": 0
}
  • 返回值：
{
	"id": 3164
}

为指定 Verto 创建模块参数

  • 请求 URL： /api/verto_profiles/&id
  • 请求方式： POST
  • Body 信息：
{
  "k": "TEXT",
  "v": "1",
  "realm": "VERTO-SETTINGS",
  "ref_id": 1,
  "disabled": 0
}
  • 返回值：
{
	"id": 31
}

创建 Verto profile

  • 请求 URL： /api/verto_profiles
  • 请求方式： POST
  • Body 信息：
{
  "name": "test",
  "template": "default"
}
  • 返回值：
{
  "id": 3
}

为指定 Verto 创建 Vhost

  • 请求 URL： /api/verto_profiles/:id/vhost_param/:vhost_param_id
  • 请求方式： POST
  • Body 信息：
{
  "k": "TEXT",
  "v": "text",
  "realm": "VERTO-PROFILE-VHOST"
}
  • 返回值：
{
	"id":	17
}

为指定 Verto 添加 Vhost 类别

  • 请求 URL： /api/verto_profiles/:id/vhosts/
  • 请求方式： POST
  • Body 信息：
{
  "name": "TEXT"
}
  • 返回值：
{
	"id":	3
}

修改 Verto 基本信息

  • 请求 URL： /api/verto_profiles/$id
  • 请求方式： PUT
  • Body 信息：
{
  "description": "default profile",
  "name": "default"
}
  • 返回值：
{
  "code": 200,
  "data": "2",
  "message": "success"
}

创建 Verto 配置中参数

  • 请求 URL： /api/verto_profiles/$id/param
  • 请求方式： POST
  • Body 信息：
{
  "k": "test",
  "v": "test"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": 1877
}

修改 Verto 配置中参数

  • 请求 URL： /api/verto_profiles/$id/param/$param_id
  • 请求方式： PUT
  • Body 信息：
{
  "action": "toggle"
}

或

{
  "v": "true"
}
  • 返回值：
{
  "message": "success",
  "code": 200,
  "data": "2152"
}

启用/禁用 Verto 的 Setting 参数

  • 请求 URL： /api/verto_profiles/setting/$param_id
  • 请求方式： PUT
  • Body 信息：
{
  "action": "toggle"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": "544"
}

修改指定 Verto 的指定类别的指定 Vhost

  • 请求 URL： /api/verto_profiles/:id/vhost/:vhost_id/vhost_param/:param_id
  • 请求方式： PUT
  • Body 信息：
{
  "k": "test",
  "v": "test"
}
  • 返回值：
{}

修改指定 Verto 的指定类别

  • 请求 URL： /api/verto_profiles/:id/vhost/:vhost_id
  • 请求方式： PUT
  • Body 信息：
{
  "name": "test"
}
  • 返回值：
{
	"message":	"success",
	"code":	200,
	"data":	"6"
}

删除 Verto 配置中参数

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

删除 Verto profile

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

删除 Verto Setting 参数

  • 请求 URL： /api/verto_profiles/setting/$setting_id
  • 请求方式： DELETE
  • Body 信息：无
  • 返回值：
{}

删除指定 Verto 的指定类别的指定 Vhost

  • 请求 URL： /api/verto_profiles/:id/vhost/:vhost_id/vhost_param/:vhost_param_id
  • 请求方式： DELETE
  • Body 信息：无
  • 返回值：
{}

删除指定 Verto 的指定类别

  • 请求 URL： /api/verto_profiles/:id/vhost/:vhost_id
  • 请求方式： DELETE
  • Body 信息：无
  • 返回值：
{}

UniMRCP

查看 UniMRCP 基本信息

  • 请求 URL： /api/unimrcp_profiles
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[
	{
		"created_at": "2024-07-10 02:53:14",
		"version": "2",
		"id": 1,
		"deleted_at": "",
		"updated_at": "2024-07-10 02:53:14",
		"disabled": 0,
		"name": "loquendo7-mrcp2"
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"version": "1",
		"id": 2,
		"deleted_at": "",
		"updated_at": "2024-07-10 02:53:14",
		"disabled": 0,
		"name": "nuance-mrcp1"
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"version": "2",
		"id": 3,
		"deleted_at": "",
		"updated_at": "2024-07-10 02:53:14",
		"disabled": 0,
		"name": "ali-mrcp"
	}
]

查看指定 UniMRCP 的配置参数

  • 请求 URL： /api/unimrcp_profiles/$id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"updated_at": "2024-07-10 02:53:14",
	"disabled": 0,
	"id": 1,
	"deleted_at": "",
	"params": [
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2047,
			"realm": "UNIMRCP-PROFILES",
			"v": "auto",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "client-ext-ip"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2048,
			"realm": "UNIMRCP-PROFILES",
			"v": "auto",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "client-ip"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2049,
			"realm": "UNIMRCP-PROFILES",
			"v": "5090",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "client-port"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2050,
			"realm": "UNIMRCP-PROFILES",
			"v": "10.5.5.152",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "server-ip"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2051,
			"realm": "UNIMRCP-PROFILES",
			"v": "5060",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "server-port"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2052,
			"realm": "UNIMRCP-PROFILES",
			"v": "1",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "force-destination"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2053,
			"realm": "UNIMRCP-PROFILES",
			"v": "udp",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "sip-transport"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2054,
			"realm": "UNIMRCP-PROFILES",
			"v": "FreeSWITCH",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "ua-name"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2055,
			"realm": "UNIMRCP-PROFILES",
			"v": "FreeSWITCH",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "sdp-origin"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2056,
			"realm": "UNIMRCP-PROFILES",
			"v": "auto",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "rtp-ext-ip"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2057,
			"realm": "UNIMRCP-PROFILES",
			"v": "auto",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "rtp-ip"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2058,
			"realm": "UNIMRCP-PROFILES",
			"v": "4000",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "rtp-port-min"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2059,
			"realm": "UNIMRCP-PROFILES",
			"v": "5000",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "rtp-port-max"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2060,
			"realm": "UNIMRCP-PROFILES",
			"v": "50",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "playout-delay"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2061,
			"realm": "UNIMRCP-PROFILES",
			"v": "200",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "max-playout-delay"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2062,
			"realm": "UNIMRCP-PROFILES",
			"v": "20",
			"disabled": 1,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "ptime"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2063,
			"realm": "UNIMRCP-PROFILES",
			"v": "PCMU PCMA L16/96/8000",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "codecs"
		},
		{
			"updated_at": "2024-07-10 02:53:14",
			"id": 2064,
			"realm": "UNIMRCP-PROFILES",
			"v": "application/jsgf",
			"disabled": 0,
			"ref_id": 1,
			"deleted_at": "",
			"created_at": "2024-07-10 02:53:14",
			"k": "jsgf-mime-type"
		}
	],
	"created_at": "2024-07-10 02:53:14",
	"name": "loquendo7-mrcp2",
	"version": "2"
}

查看 UniMRCP 的settings信息

  • 请求 URL： /api/unimrcp_profiles/settings
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
  • 返回值：
[
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "log-level",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "DEBUG",
		"id": 2040
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "default-tts-profile",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "voxeo-prophecy8.0-mrcp1",
		"id": 2041
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "default-asr-profile",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "voxeo-prophecy8.0-mrcp1",
		"id": 2042
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "enable-profile-events",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "false",
		"id": 2043
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "max-connection-count",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "100",
		"id": 2044
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "offer-new-connection",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "1",
		"id": 2045
	},
	{
		"created_at": "2024-07-10 02:53:14",
		"k": "request-timeout",
		"realm": "UNIMRCP-SETTINGS",
		"disabled": 0,
		"updated_at": "2024-07-10 02:53:14",
		"ref_id": 0,
		"deleted_at": "",
		"v": "3000",
		"id": 2046
	}
]

获取指定 UniMRCP 的 Recogparam 信息

  • 请求 URL： /api/unimrcp_profiles/&id/recogparams
  • 请求方式： GET
  • 返回值：
[{
		"created_at":	"2025-08-19 08:52:09",
		"k":	"start-input-timers",
		"ref_id":	1,
		"id":	2308,
		"disabled":	1,
		"updated_at":	"2025-08-19 08:52:09",
		"deleted_at":	"",
		"v":	"false",
		"realm":	"UNIMRCP-RECO"
}]

获取指定 UniMRCP 的 Synthparam 信息

  • 请求 URL： /api/unimrcp_profiles/&id/synthparams
  • 请求方式： GET
  • 返回值：
[{
		"id":	3212,
		"k":	"text",
		"ref_id":	1,
		"updated_at":	"2025-08-26 07:31:34",
		"disabled":	0,
		"realm":	"UNIMRCP-SYNTH",
		"created_at":	"2025-08-26 07:31:34",
		"v":	"text",
		"deleted_at":	""
}]

创建 UniMRCP

  • 请求 URL： /api/unimrcp_profiles
  • 请求方式： POST
  • Body 信息：
{
  "name": "test",
  "template": "voxeo-prophecy8.0-mrcp1",
  "version": "2"
}
  • 返回值：
{
	"data": 5,
	"message": "success",
	"code": 200
}

创建 UniMRCP Setting

  • 请求 URL： /api/unimrcp_profiles/$id/settings
  • 请求方式： POST
  • Body 信息：
{
  "k": "TEXT",
  "v": "1",
  "realm": "UNIMRCP-SETTINGS"
}
  • 返回值：
{
	"id":	3213
}

修改 UniMRCP

  • 请求 URL： /api/unimrcp_profiles/$id
  • 请求方式： PUT
  • Body 信息：
{
  "version": "2",
  "name": "default"
}
  • 返回值：
{
  "code": 200,
  "data": "2",
  "message": "success"
}

修改指定 UniMRCP 的启用状态

  • 请求 URL： /api/unimrcp_profiles/toggle/$id
  • 请求方式： PUT
  • Body 信息：无
  • 返回值：
{
	"data":	[{
			"deleted_at":	"",
			"name":	"loquendo7-mrcp2",
			"version":	"2",
			"updated_at":	"2025-08-26 07:52:23",
			"id":	1,
			"disabled":	0,
			"created_at":	"2025-08-19 08:52:04"
		}, {
			"deleted_at":	"",
			"name":	"nuance-mrcp1",
			"version":	"1",
			"updated_at":	"2025-08-19 08:52:04",
			"id":	2,
			"disabled":	0,
			"created_at":	"2025-08-19 08:52:04"
		}],
	"message":	"success",
	"code":	200
}

创建 UniMRCP 配置中各种类型参数

  • 请求 URL： /api/unimrcp_profiles/$id/param
  • 请求 URL： /api/unimrcp_profiles/$id/synthparams
  • 请求 URL： /api/unimrcp_profiles/$id/recogparams
  • 请求方式： POST
  • Body 信息：
{
  "k": "test",
  "v": "test"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": 1877
}

修改 UniMRCP 配置中参数

  • 请求 URL： /api/unimrcp_profiles/$id/params/$param_id
  • 请求方式： PUT
  • Body 信息：
{
  "action": "toggle"
}

或

{
  "v": "true"
}
  • 返回值：
{
  "message": "success",
  "code": 200,
  "data": "2152"
}

启用/禁用 UniMRCP 的 Setting 参数

  • 请求 URL： /api/unimrcp_profiles/setting/$param_id
  • 请求方式： PUT
  • Body 信息：
{
  "action": "toggle"
}
  • 返回值：
{
  "code": 200,
  "message": "success",
  "data": "544"
}

删除 UniMRCP 配置中参数

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

删除 UniMRCP 配置中 Setting 参数

  • 请求 URL： /api/unimrcp_profiles/setting/$param_id
  • 请求方式： DELETE
  • Body 信息：无
  • 返回值：
{
	"code":	200,
	"message":	"success",
	"data":	"{}"
}

删除 UniMRCP

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

HTTP Cache

查询 HTTP Cache 配置

  • 请求 URL： /api/http_caches
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
[{
		"id":	1,
		"deleted_at":	"",
		"disabled":	0,
		"updated_at":	"2025-08-19 08:52:04",
		"name":	"default",
		"description":	"default",
		"created_at":	"2025-08-19 08:52:04"
}]

查询指定 HTTP Cache 配置

  • 请求 URL： /api/http_caches/$id
  • 请求方式： GET
  • Body 信息：无
  • 返回值：
{
	"id":	1,
	"params":	[{
			"k":	"enable-file-formats",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2359",
			"v":	"false",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"max-urls",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2360",
			"v":	"10000",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"location",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2361",
			"v":	"$${cache_dir}",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"default-max-age",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2362",
			"v":	"86400",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"prefetch-thread-count",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2363",
			"v":	"8",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"prefetch-queue-size",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2364",
			"v":	"100",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"ssl-cacert",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2365",
			"v":	"$${certs_dir}/cacert.pem",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"ssl-verifypeer",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2366",
			"v":	"false",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"ssl-verifyhost",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2367",
			"v":	"true",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"connect-timeout",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2368",
			"v":	"300",
			"deleted_at":	"",
			"disabled":	"1",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}, {
			"k":	"download-timeout",
			"created_at":	"2025-08-19 08:52:09",
			"ref_id":	"1",
			"id":	"2369",
			"v":	"300",
			"deleted_at":	"",
			"disabled":	"1",
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"HTTP-CACHE"
		}],
	"updated_at":	"2025-08-19 08:52:04",
	"created_at":	"2025-08-19 08:52:04",
	"deleted_at":	"",
	"disabled":	0,
	"description":	"default",
	"name":	"default"
}

新建 HTTP Cache

  • 请求 URL： /api/http_caches
  • 请求方式： POST
  • Body 信息：
{
  "name": "text",
  "template": "default"
}
  • 返回值：
{
	"message":	"success",
	"data":	2,
	"code":	200
}

新建指定 HTTP Cache 的 setting 参数

  • 请求 URL： /api/http_caches/:ref_id/settings/
  • 请求方式： POST
  • Body 信息：
{
  "k": "text",
  "v": "text"
}
  • 返回值：
{
	"message":	"success",
	"code":	200,
	"data":	3225
}

修改指定 HTTP Cache 的 setting 参数

  • 请求 URL： /api/http_caches/:id/settings/:setting_id
  • 请求方式： PUT
  • Body 信息：
{
  "k": "text",
  "v": "text"
}
  • 返回值：
{
	"data":	"3225",
	"code":	200,
	"message":	"success"
}

修改指定 HTTP Cache

  • 请求 URL： /api/http_caches/:id
  • 请求方式： PUT
  • Body 信息：
{
  "name": "text",
  "description": "defaul",
  "id": 2
}
  • 返回值：
{
	"code":	200,
	"message":	"success",
	"data":	"2"
}

删除指定 HTTP Cache

  • 请求 URL： /api/http_caches/:id
  • 请求方式： DELETE
  • 返回值：
{
	"code":	200,
	"data":	1,
	"message":	"success"
}

删除指定 HTTP Cache 的 setting 参数

  • 请求 URL： /api/http_caches/:id/settings/:setting_id
  • 请求方式： DELETE
  • 返回值：
{
	"code":	200,
	"data":	1,
	"message":	"success"
}

声网

获取声网配置

  • 请求 URL： /api/agoras
  • 请求方式： GET
  • 返回值：
[{
		"disabled":	0,
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:04",
		"created_at":	"2025-08-19 08:52:04",
		"id":	1,
		"description":	"default",
		"name":	"default"
	}]

获取指定声网配置

  • 请求 URL： /api/agoras/:id
  • 请求方式： GET
  • 返回值：
{
	"deleted_at":	"",
	"disabled":	0,
	"updated_at":	"2025-08-19 08:52:04",
	"created_at":	"2025-08-19 08:52:04",
	"name":	"default",
	"id":	1,
	"description":	"default",
	"params":	[{
			"ref_id":	"1",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:06",
			"id":	"828",
			"deleted_at":	"",
			"realm":	"AGORA",
			"updated_at":	"2025-08-19 08:52:06",
			"k":	"switch-port-allocator",
			"v":	"false"
		}, {
			"ref_id":	"1",
			"disabled":	"0",
			"created_at":	"2025-08-19 08:52:06",
			"id":	"829",
			"deleted_at":	"",
			"realm":	"AGORA",
			"updated_at":	"2025-08-19 08:52:06",
			"k":	"media-start-port",
			"v":	"$ENV:AGORA_MEDIA_START_PORT"
		}
		...
		]
	
}

新建声网配置

  • 请求 URL： /api/agoras
  • 请求方式： POST
  • Body 信息：
{
  "name": "text",
  "template": "default"
}
  • 返回值：
{
	"message":	"success",
	"code":	200,
	"data":	2
}

新建指定声网配置的模块参数

  • 请求 URL： /api/agoras/:ref_id/settings/
  • 请求方式： POST
  • Body 信息：
{
  "k": "text",
  "v": "text"
}
  • 返回值：
{
	"data":	3248,
	"code":	200,
	"message":	"success"
}

修改指定声网配置的模块参数

  • 请求 URL： /api/agoras/:id/settings/:setting_id
  • 请求方式： PUT
  • Body 信息：
{
  "k": "text",
  "v": "text11"
}
  • 返回值：
{
	"message":	"success",
	"code":	200,
	"data":	"3248"
}

修改指定声网配置

  • 请求 URL： /api/agoras/:id
  • 请求方式： PUT
  • Body 信息：
{
  "name": "text",
  "description": "default",
  "id": 2
}
  • 返回值：
{
	"code":	200,
	"message":	"success",
	"data":	"2"
}

删除指定声网

  • 请求 URL： /api/agoras/:id
  • 请求方式： DELETE
  • 返回值：
{
	"message":	"success",
	"data":	1,
	"code":	200
}

删除指定声网配置的模块参数

  • 请求 URL： /api/agoras/:id/settings/:setting_id
  • 请求方式： DELETE
  • 返回值：
{
	"message":	"success",
	"code":	200,
	"data":	1
}

AV Config

获取所有 AV Config

  • 请求 URL： /api/av_profiles
  • 请求方式： GET
  • 返回值：
[{
		"deleted_at":	"",
		"name":	"H263",
		"updated_at":	"2025-08-19 08:52:04",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:04",
		"description":	"default",
		"id":	1
	}, {
		"deleted_at":	"",
		"name":	"H263+",
		"updated_at":	"2025-08-19 08:52:04",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:04",
		"description":	"default",
		"id":	2
	}, {
		"deleted_at":	"",
		"name":	"H264",
		"updated_at":	"2025-08-19 08:52:04",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:04",
		"description":	"default",
		"id":	3
	}, {
		"deleted_at":	"",
		"name":	"H265",
		"updated_at":	"2025-08-19 08:52:04",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:04",
		"description":	"default",
		"id":	4
	}, {
		"deleted_at":	"",
		"name":	"conference",
		"updated_at":	"2025-08-19 08:52:04",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:04",
		"description":	"default",
		"id":	5
	}, {
		"deleted_at":	"",
		"name":	"conference-H264",
		"updated_at":	"2025-08-19 08:52:04",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:04",
		"description":	"default",
		"id":	6
}]

获取指定 AV Config

  • 请求 URL： /api/av_profiles/:id
  • 请求方式： GET
  • 返回值：
{
	"description":	"default",
	"created_at":	"2025-08-19 08:52:04",
	"options":	[],
	"name":	"H263",
	"id":	1,
	"disabled":	0,
	"updated_at":	"2025-08-19 08:52:04",
	"codecs":	[],
	"params":	[],
	"deleted_at":	""
}

获取 AV Config 的 Setting

  • 请求 URL： /api/av_profiles/settings
  • 请求方式： GET
  • 返回值：
[{
		"id":	2391,
		"k":	"dec-threads",
		"ref_id":	0,
		"disabled":	0,
		"v":	"1",
		"realm":	"AV-SETTINGS",
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:09",
		"created_at":	"2025-08-19 08:52:09"
	}, {
		"id":	2392,
		"k":	"enc-threads",
		"ref_id":	0,
		"disabled":	0,
		"v":	"cpu/2/4",
		"realm":	"AV-SETTINGS",
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:09",
		"created_at":	"2025-08-19 08:52:09"
	}, {
		"id":	2393,
		"k":	"max-bitrate",
		"ref_id":	0,
		"disabled":	1,
		"v":	"5mb",
		"realm":	"AV-SETTINGS",
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:09",
		"created_at":	"2025-08-19 08:52:09"
	}, {
		"id":	2394,
		"k":	"rtp-slice-size",
		"ref_id":	0,
		"disabled":	1,
		"v":	"1200",
		"realm":	"AV-SETTINGS",
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:09",
		"created_at":	"2025-08-19 08:52:09"
	}, {
		"id":	2395,
		"k":	"key-frame-min-freq",
		"ref_id":	0,
		"disabled":	1,
		"v":	"250",
		"realm":	"AV-SETTINGS",
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:09",
		"created_at":	"2025-08-19 08:52:09"
	}]

新建 AV Config

  • 请求 URL： /api/av_profiles
  • 请求方式： POST
  • Body 信息：
{
  "name": "text",
  "template": "default"
}
  • 返回值：
{
	"code":	200,
	"data":	7,
	"message":	"success"
}

新建 AV Config 的 setting

  • 请求 URL： /api/av_profiles/setting
  • 请求方式： POST
  • Body 信息：
{
	"k": "TEXT",
	"v": "1",
	"realm": "UNIMRCP-SETTINGS"
}
  • 返回值：
{
	"id":	3250
}

新建指定 AV Config 的 Param

  • 请求 URL： /api/av_profiles/:id/param
  • 请求方式： POST
  • Body 信息：
{
	"k": "text",
	"v": "text"
}
  • 返回值：
{
	"code":	200,
	"data":	3251,
	"message":	"success"
}

新建指定 AV Config 的 Codec

  • 请求 URL： /api/av_profiles/:id/codec
  • 请求方式： POST
  • Body 信息：
{
	"k": "text",
	"v": "text"
}
  • 返回值：
{
	"code":	200,
	"data":	3252,
	"message":	"success"
}

新建指定 AV Config 的 Option

  • 请求 URL： /api/av_profiles/:id/option
  • 请求方式： POST
  • Body 信息：
{
	"k": "text",
	"v": "text"
}
  • 返回值：
{
	"code":	200,
	"data":	3253,
	"message":	"success"
}

获取指定 AV Config 的 Param

  • 请求 URL： /api/av_profiles/:id/params
  • 请求方式： GET
  • 返回值：
[
	{
		"v": "text",
		"id": 3251,
		"k": "text",
		"updated_at": "2025-08-26 09:04:23",
		"deleted_at": "",
		"realm": "AV-PARAMS",
		"ref_id": 7,
		"disabled": 0,
		"created_at": "2025-08-26 08:59:37"
	}
]

获取指定 AV Config 的 Codec

  • 请求 URL： /api/av_profiles/:id/codecs
  • 请求方式： GET
  • 返回值：
[
	{
		"disabled": 0,
		"deleted_at": "",
		"realm": "AV-CODECS",
		"created_at": "2025-08-26 09:00:53",
		"id": 3252,
		"v": "text",
		"ref_id": 7,
		"updated_at": "2025-08-26 09:00:53",
		"k": "text"
	}
]

获取指定 AV Config 的 Option

  • 请求 URL： /api/av_profiles/:id/options
  • 请求方式： GET
  • 返回值：
[
	{
		"k": "text",
		"disabled": 0,
		"v": "text",
		"created_at": "2025-08-26 09:01:37",
		"id": 3253,
		"realm": "AV-OPTIONS",
		"deleted_at": "",
		"ref_id": 7,
		"updated_at": "2025-08-26 09:01:37"
	}
]

修改 AV Config 的 Setting

  • 请求 URL： /api/av_profiles/setting/:param_id
  • 请求方式： PUT
  • Body 信息：
{
	"k": "TEXT",
	"v": "text"
}
  • 返回值：
{
	"code":	200,
	"data":	"3250",
	"message":	"success"
}

修改指定 AV Config 的Param

  • 请求 URL： /api/av_profiles/:id/params/:param_id
  • 请求方式： PUT
  • Body 信息：
{
	"k": "text",
	"v": "text",
	"realm": "AV-PARAMS"
}
  • 返回值：
{
	"code":	200,
	"data":	3251,
	"message":	"success"
}

修改指定 AV Config

  • 请求 URL： /api/av_profiles/:id
  • 请求方式： PUT
  • Body 信息：
{
	"name": "text",
	"id": 7,
	"description": "text"
}
  • 返回值：
{
	"code":	200,
	"data":	7,
	"message":	"success"
}

修改指定 AV Config 的启用状态

  • 请求 URL： /api/av_profiles/toggle/:id
  • 请求方式： PUT
  • Body 信息：无
  • 返回值：
{
	"message": "success",
	"data": [
		{
			"created_at": "2025-08-19 08:52:04",
			"name": "H263",
			"id": 1,
			"updated_at": "2025-08-19 08:52:04",
			"deleted_at": "",
			"description": "default",
			"disabled": 1
		},
		{
			"created_at": "2025-08-19 08:52:04",
			"name": "H263+",
			"id": 2,
			"updated_at": "2025-08-19 08:52:04",
			"deleted_at": "",
			"description": "default",
			"disabled": 0
		},
		{
			"created_at": "2025-08-19 08:52:04",
			"name": "H264",
			"id": 3,
			"updated_at": "2025-08-19 08:52:04",
			"deleted_at": "",
			"description": "default",
			"disabled": 0
		},
		{
			"created_at": "2025-08-19 08:52:04",
			"name": "H265",
			"id": 4,
			"updated_at": "2025-08-19 08:52:04",
			"deleted_at": "",
			"description": "default",
			"disabled": 0
		},
		{
			"created_at": "2025-08-19 08:52:04",
			"name": "conference",
			"id": 5,
			"updated_at": "2025-08-19 08:52:04",
			"deleted_at": "",
			"description": "default",
			"disabled": 0
		},
		{
			"created_at": "2025-08-19 08:52:04",
			"name": "conference-H264",
			"id": 6,
			"updated_at": "2025-08-19 08:52:04",
			"deleted_at": "",
			"description": "default",
			"disabled": 1
		}
	],
	"code": 200
}

删除指定 AV Config

  • 请求 URL： /api/av_profiles/:id
  • 请求方式： DELETE
  • 返回值：
{
	"code":	200,
	"data":	7,
	"message":	"success"
}

删除指定 AV Config 的 Param

  • 请求 URL： /api/av_profiles/:id/params/:param_id
  • 请求方式： DELETE
  • 返回值：
{
	"code":	200,
	"data":	3251,
	"message":	"success"
}

删除指定的 Setting

  • 请求 URL： /api/av_profiles/setting/:id
  • 请求方式： DELETE
  • 返回值：
{
	"message":	"success",
	"data":	"{}",
	"code":	200
}

Redis

获取 Redis 的信息

  • 请求 URL： /api/hiredis_profiles
  • 请求方式： GET
  • 返回值：
[{
		"description":	"",
		"updated_at":	"2025-08-19 08:52:09",
		"deleted_at":	"",
		"id":	1,
		"created_at":	"2025-08-19 08:52:09",
		"name":	"default",
		"disabled":	0
}]

获取指定 Redis 的信息

  • 请求 URL： /api/hiredis_profiles/:id
  • 请求方式： GET
  • 返回值：
{
	"id":	1,
	"deleted_at":	"",
	"name":	"default",
	"updated_at":	"2025-08-19 08:52:09",
	"disabled":	0,
	"connections":	[{
			"created_at":	"2025-08-19 08:52:09",
			"deleted_at":	"",
			"updated_at":	"2025-08-19 08:52:09",
			"k":	"primary",
			"v":	"primary",
			"disabled":	0,
			"ref_id":	1,
			"id":	2378,
			"params":	[{
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"enable-file-formats",
					"v":	"false",
					"disabled":	0,
					"ref_id":	2378,
					"id":	2384,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"hostname",
					"v":	"172.18.101.101",
					"disabled":	0,
					"ref_id":	2378,
					"id":	2380,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"password",
					"v":	"redis",
					"disabled":	0,
					"ref_id":	2378,
					"id":	2381,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"port",
					"v":	"6379",
					"disabled":	0,
					"ref_id":	2378,
					"id":	2382,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"timeout_ms",
					"v":	"500",
					"disabled":	0,
					"ref_id":	2378,
					"id":	2383,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}],
			"realm":	"HIREDIS-CONNECTION"
		}, {
			"created_at":	"2025-08-19 08:52:09",
			"deleted_at":	"",
			"updated_at":	"2025-08-19 08:52:09",
			"k":	"secondary",
			"v":	"secondary",
			"disabled":	0,
			"ref_id":	1,
			"id":	2379,
			"params":	[{
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"enable-file-formats",
					"v":	"false",
					"disabled":	0,
					"ref_id":	2379,
					"id":	2389,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"hostname",
					"v":	"localhost",
					"disabled":	0,
					"ref_id":	2379,
					"id":	2385,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"password",
					"v":	"redis",
					"disabled":	0,
					"ref_id":	2379,
					"id":	2386,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"port",
					"v":	"6380",
					"disabled":	0,
					"ref_id":	2379,
					"id":	2387,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}, {
					"created_at":	"2025-08-19 08:52:09",
					"deleted_at":	"",
					"updated_at":	"2025-08-19 08:52:09",
					"k":	"timeout_ms",
					"v":	"500",
					"disabled":	0,
					"ref_id":	2379,
					"id":	2388,
					"realm":	"HIREDIS-CONNECTION-PARAM"
				}],
			"realm":	"HIREDIS-CONNECTION"
		}],
	"created_at":	"2025-08-19 08:52:09",
	"params":	[{
			"created_at":	"2025-08-19 08:52:09",
			"deleted_at":	"",
			"updated_at":	"2025-08-19 08:52:09",
			"k":	"ignore-connect-fail",
			"v":	"true",
			"disabled":	0,
			"ref_id":	1,
			"id":	2390,
			"realm":	"HIREDIS-PARAM"
		}],
	"description":	""
}

新建 Redis

  • 请求 URL： /api/hiredis_profiles
  • 请求方式： POST
  • 请求参数：
{
	"name":	"test",
	"description":	"test"
}
  • 返回示例：
{
	"data":	2,
	"code":	200,
	"message":	"success"
}

新建指定 Redis 的连接类别

  • 请求 URL： /api/hiredis_profiles/:id/connections
  • 请求方式： POST
  • 请求参数：
{
	"k": "text"
}
  • 返回示例：
{
	"code":	200,
	"message":	"success",
	"data":	3254
}

新建指定 Redis 的连接参数

  • 请求 URL： /api/hiredis_profiles/:id/connection_params
  • 请求方式： POST
  • 示例： /api/hiredis_profiles/3254/connection_params/
  • 请求参数：
{
	"k": "text",
	"v": "text"
}
  • 返回示例：
{
	"message":	"success",
	"code":	200,
	"data":	3255
}

新建指定 Redis 的 Param 参数

  • 请求 URL： /api/hiredis_profiles/:id/params
  • 请求方式： POST
  • 请求参数：
{
	"k": "text",
	"v": "text"
}
  • 返回示例：
{
	"message":	"success",
	"code":	200,
	"data":	3256
}

修改指定 Redis 的信息

  • 请求 URL： /api/hiredis_profiles/:id
  • 请求方式： PUT
  • 请求参数：
{
	"name":	"test",
	"description":	"test1"
}
  • 返回示例：
{
	"code":	200,
	"data":	"2",
	"message":	"success"
}

修改指定 Redis 的 Param 信息

  • 请求 URL： /api/hiredis_profiles/:id/params/:param_id
  • 请求方式： PUT
  • 请求参数：
{
	"k":	"test",
	"v":	"test1"
}
  • 返回示例：
{
	"code":	200,
	"message":	"success",
	"data":	"3256"
}

修改 Connection Params 信息

  • 请求 URL： /api/hiredis_profiles/params/:param_id
  • 请求方式： PUT
  • 请求参数：
{
	"k":	"test",
	"v":	"test1"
}
  • 返回示例：
{
	"data":	"3255",
	"message":	"success",
	"code":	200
}

删除指定 Redis 的信息

  • 请求 URL： /api/hiredis_profiles/:id
  • 请求方式： DELETE
  • 返回示例：
{
	"code":	200,
	"data":	"2",
	"message":	"success"
}

删除指定的 Param 信息

  • 请求 URL： /api/hiredis_profiles/param/:param_id
  • 请求方式： DELETE
  • 返回示例：
{
	"code":	200,
	"data":	"3256",
	"message":	"success"
}

H323

获取 H323 信息

  • 请求 URL： /api/ooh323_profiles
  • 请求方式： GET
  • 返回示例：
[
	{
		"deleted_at":	"",
		"disabled":	0,
		"name":	"default",
		"id":	1,
		"created_at":	"2025-08-19 08:52:04",
		"updated_at":	"2025-08-19 08:52:04",
		"description":	"default"
	}
]

获取指定 H323 信息

  • 请求 URL： /api/ooh323_profiles/:id
  • 请求方式： GET
  • 返回示例：
{
	"updated_at":	"2025-08-19 08:52:04",
	"params":	[{
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"OOH323",
			"disabled":	"1",
			"ref_id":	"1",
			"v":	"discover",
			"created_at":	"2025-08-19 08:52:09",
			"id":	"2482",
			"deleted_at":	"",
			"k":	"gk-ip"
		}, {
			"updated_at":	"2025-08-19 08:52:09",
			"realm":	"OOH323",
			"disabled":	"0",
			"ref_id":	"1",
			"v":	"17999",
			"created_at":	"2025-08-19 08:52:09",
			"id":	"2515",
			"deleted_at":	"",
			"k":	"rtp-max-port"
		}
		...
		],
	"deleted_at":	"",
	"disabled":	0,
	"created_at":	"2025-08-19 08:52:04",
	"name":	"default",
	"id":	1,
	"description":	"default"
}

创建 H323

  • 请求 URL： /api/ooh323_profiles
  • 请求方式： POST
  • 请求参数：
{
	"name":	"test",
	"template":	"default"
}
  • 返回示例：
{
	"code":	200,
	"data":	2,
	"message":	"success"
}

新建指定 H323 的 Setting 参数

  • 请求 URL： /api/ooh323_profiles/:ref_id/params/
  • 请求方式： POST
  • 请求参数：
{
	"k":	"gk-ip",
	"v":	"discover"
}
  • 返回示例：
{
	"message":	"success",
	"data":	3291,
	"code":	200
}

更新指定 H323 信息

  • 请求 URL： /api/ooh323_profiles/:id
  • 请求方式： PUT
  • 请求参数：
{
	"name":	"test",
	"description":	"default",
	"id": 2
}
  • 返回示例：
{
	"data":	"2",
	"message":	"success",
	"code":	200
}

修改指定 H323 的启用状态

  • 请求 URL： /api/ooh323_profiles/toggle/:id
  • 请求方式： PUT
  • 请求参数：无
  • 返回示例：
{
	"message":	"success",
	"data":	"2",
	"code":	200
}

修改指定 H323 的 Setting 参数

  • 请求 URL： /api/ooh323_profiles/:id/params/:param_id
  • 请求方式： PUT
  • 请求参数：
{
	"k":	"gk-ip",
	"v":	"discover",
	"realm": "OOH323"
}
  • 返回示例：
{
	"code":	200,
	"data":	"3291",
	"message":	"success"
}

删除指定 H323 信息

  • 请求 URL： /api/ooh323_profiles/:id
  • 请求方式： DELETE
  • 请求参数：无
  • 返回示例：
{
	"message":	"success",
	"code":	200,
	"data":	"2"
}

Rkmpp

获取 Rkmpp 信息列表

  • 请求 URL： /api/rkmpp_profiles
  • 请求方式： GET
  • 请求参数：无
  • 返回示例：
[
	{
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:04",
		"created_at":	"2025-08-19 08:52:04",
		"name":	"H264",
		"id":	1,
		"disabled":	0,
		"description":	"default"
	}, {
		"deleted_at":	"",
		"updated_at":	"2025-08-19 08:52:04",
		"created_at":	"2025-08-19 08:52:04",
		"name":	"H265",
		"id":	2,
		"disabled":	0,
		"description":	"default"
	}
]

获取指定 Rkmpp 信息

  • 请求 URL： /api/rkmpp_profiles/:id
  • 请求方式： GET
  • 请求参数：无
  • 返回示例：
{
	"deleted_at":	"",
	"name":	"H264",
	"disabled":	0,
	"params":	[{
			"disabled":	0,
			"realm":	"RKMPP-PARAMS",
			"created_at":	"2025-08-19 08:52:11",
			"k":	"profile",
			"id":	3114,
			"updated_at":	"2025-08-19 08:52:11",
			"ref_id":	1,
			"v":	"baseline",
			"deleted_at":	""
		}, {
			"disabled":	0,
			"realm":	"RKMPP-PARAMS",
			"created_at":	"2025-08-19 08:52:11",
			"k":	"level",
			"id":	3115,
			"updated_at":	"2025-08-19 08:52:11",
			"ref_id":	1,
			"v":	"40",
			"deleted_at":	""
		}, {
			"disabled":	1,
			"realm":	"RKMPP-PARAMS",
			"created_at":	"2025-08-19 08:52:11",
			"k":	"cbr",
			"id":	3116,
			"updated_at":	"2025-08-19 08:52:11",
			"ref_id":	1,
			"v":	"true",
			"deleted_at":	""
		}, {
			"disabled":	1,
			"realm":	"RKMPP-PARAMS",
			"created_at":	"2025-08-19 08:52:11",
			"k":	"gop-size",
			"id":	3117,
			"updated_at":	"2025-08-19 08:52:11",
			"ref_id":	1,
			"v":	"300",
			"deleted_at":	""
		}, {
			"disabled":	1,
			"realm":	"RKMPP-PARAMS",
			"created_at":	"2025-08-19 08:52:11",
			"k":	"max-bandwidth-factor",
			"id":	3118,
			"updated_at":	"2025-08-19 08:52:11",
			"ref_id":	1,
			"v":	"1.5",
			"deleted_at":	""
		}],
	"created_at":	"2025-08-19 08:52:04",
	"updated_at":	"2025-08-19 08:52:04",
	"description":	"default",
	"id":	1
}

获取指定 Rkmpp 参数信息

  • 请求 URL： /api/rkmpp_profiles/:id/params
  • 请求方式： GET
  • 请求参数：无
  • 返回示例：
[{
		"updated_at":	"2025-08-19 08:52:11",
		"deleted_at":	"",
		"realm":	"RKMPP-PARAMS",
		"id":	3114,
		"v":	"baseline",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:11",
		"ref_id":	1,
		"k":	"profile"
	}, {
		"updated_at":	"2025-08-19 08:52:11",
		"deleted_at":	"",
		"realm":	"RKMPP-PARAMS",
		"id":	3115,
		"v":	"40",
		"disabled":	0,
		"created_at":	"2025-08-19 08:52:11",
		"ref_id":	1,
		"k":	"level"
	}, {
		"updated_at":	"2025-08-19 08:52:11",
		"deleted_at":	"",
		"realm":	"RKMPP-PARAMS",
		"id":	3116,
		"v":	"true",
		"disabled":	1,
		"created_at":	"2025-08-19 08:52:11",
		"ref_id":	1,
		"k":	"cbr"
	}, {
		"updated_at":	"2025-08-19 08:52:11",
		"deleted_at":	"",
		"realm":	"RKMPP-PARAMS",
		"id":	3117,
		"v":	"300",
		"disabled":	1,
		"created_at":	"2025-08-19 08:52:11",
		"ref_id":	1,
		"k":	"gop-size"
	}, {
		"updated_at":	"2025-08-19 08:52:11",
		"deleted_at":	"",
		"realm":	"RKMPP-PARAMS",
		"id":	3118,
		"v":	"1.5",
		"disabled":	1,
		"created_at":	"2025-08-19 08:52:11",
		"ref_id":	1,
		"k":	"max-bandwidth-factor"
	}
]

获取 Rkmpp 的 Setting 参数

  • 请求 URL： /api/rkmpp_profiles/settings
  • 请求方式： GET
  • 请求参数：无
  • 返回示例：
[
	{
		"v":	"2000",
		"ref_id":	0,
		"updated_at":	"2025-08-19 08:52:11",
		"id":	3107,
		"disabled":	0,
		"realm":	"RKMPP-SETTINGS",
		"deleted_at":	"",
		"created_at":	"2025-08-19 08:52:11",
		"k":	"key-frame-min-freq"
	}
]

新建 Rkmpp 信息

  • 请求 URL： /api/rkmpp_profiles
  • 请求方式： POST
  • 请求参数：
{
	"name": "vp8",
	"description": "default",
  	"disabled":"0"
}
  • 返回示例：
{
	"data": 3,
	"code": 200,
	"message": "success"
}

新建指定 Rkmpp 参数信息

  • 请求 URL： /api/rkmpp_profiles/:id/param
  • 请求方式： POST
  • 请求参数：
{
  "k": "TEXT",
  "v": "default",
  "realm": "REALMS"
}
  • 返回示例：
{
	"code": 200,
	"message": "success",
	"data": 3296
}

修改指定 Rkmpp 的启用状态

  • 请求 URL： /api/rkmpp_profiles/toggle/:id
  • 请求方式： PUT
  • 请求参数：
{
	"action": "toggle"
}
  • 返回示例：
{
	"data":	[{
			"created_at":	"2025-08-19 08:52:04",
			"name":	"H264",
			"deleted_at":	"",
			"disabled":	0,
			"updated_at":	"2025-08-19 08:52:04",
			"description":	"default",
			"id":	1
		}, {
			"created_at":	"2025-08-19 08:52:04",
			"name":	"H265",
			"deleted_at":	"",
			"disabled":	0,
			"updated_at":	"2025-08-19 08:52:04",
			"description":	"default",
			"id":	2
		}, {
			"created_at":	"2025-08-27 08:43:41",
			"name":	"vp8",
			"deleted_at":	"",
			"disabled":	1,
			"updated_at":	"2025-08-27 08:43:41",
			"description":	"default",
			"id":	3
		}],
	"code":	200,
	"message":	"success"
}

修改 Rkmpp Setting 的参数信息

  • 请求 URL： /api/rkmpp_profiles/setting/:param_id
  • 请求方式： PUT
  • 请求参数：
{
  "k": "text",
  "v": "default",
  "realm": "REALMS"
}
  • 返回示例：
{
	"message": "success",
	"data": "3296",
	"code": 200
}

修改指定 Rkmpp 的信息

  • 请求 URL： /api/rkmpp_profiles/:id
  • 请求方式： PUT
  • 请求参数：
{
  "name": "text",
  "description": "default",
  "disabled": "0"
}
  • 返回示例：
{
	"code": 200,
	"data": "3",
	"message": "success"
}

修改指定 Rkmpp 参数信息

  • 请求 URL： /api/rkmpp_profiles/:id/params/:param_id
  • 请求方式： PUT
  • 请求参数：
{
  "k": "text",
  "v": "default",
  "realm": "REALMS"
}
  • 返回示例：
{
	"message": "success",
	"data": "3296",
	"code": 200
}

删除指定 Rkmpp 的信息

  • 请求 URL： /api/rkmpp_profiles/:id
  • 请求方式： DELETE
  • 返回示例：
{
	"code": 200,
	"data": "3",
	"message": "success"
}

删除指定 Rkmpp 参数信息

  • 请求 URL： /api/rkmpp_profiles/:id/params/:param_id
  • 请求方式： DELETE
  • 返回示例：
{
	"message": "success",
	"data": "3296",
	"code": 200
}

删除指定 Rkmpp Setting 参数信息

  • 请求 URL： /api/rkmpp_profiles/setting/:id
  • 请求方式： DELETE
  • 返回示例：
{
	"message": "success",
	"code": 200,
	"data": "{}"
}

新建 Rkmpp Setting信息

  • 请求 URL： /api/rkmpp_profiles/setting
  • 请求方式： POST
  • 请求参数：
{
  "k": "TEXT",
  "v": "default",
  "realm": "REALMS"
}
  • 返回示例：
{
	"id": 3295
}
高级配置-系统管理
高级配置-计费管理