用户管理

用户指人，可以登录到系统 Web 界面，或拥有一次资源（如分机）、操作权限等。

用户信息说明如下：

• NORMAL：普通用户
• AGENT：坐席，在呼叫中心中使用，坐席具有普通用户所有的权限
• CONFMAN：会议管理员，能管理会议，具有普通用户所有的权限

特别注意

所有涉及密码的接口数据请自行修改为复杂密码，防止因为密码过于简单导致系统被攻击。

创建用户信息说明如下：

带有分机号用户信息说明如下：

• 请求 URL： /api/users
• 请求 URL： /api/users/create
• 请求方式： POST
• 消息头： Content-Type: application/json
• Body 信息： 参见用户信息说明。如：

{
  "login": "cherry",
  "name": "小樱桃",
  "password": "123!@#QWEqwe"
}

• 返回值：

正常返回一个 JSON Object，data 中只包含id。

如果出错，返回 HTTP 状态码如403、500等，详见HTTP 状态码参考及JSON 返回格式参考相关内容。

• 其它说明：无
• curl 示例：

curl -0 -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"login":"cherry","name":"小樱桃","password":"123!@#QWEqwe"}' \
"192.168.0.1:8081/api/users"

或

curl -0 -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"login":"cherry","name":"小樱桃","password":"123!@#QWEqwe"}' \
"192.168.0.1:8081/api/users/create"

返回：

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

批量创建用户信息说明如下：

• 请求 URL: /api/users/muti_add

• 请求方式: POST

• 消息头: Content-Type: application/json
• Body 信息: 参见分配器信息说明。

Body:

{
  "users_start": 2011,
  "users_end": 2012,
  "password": "Xswitch.cn/6753997!Qqa",
  "type": "NORMAL",
  "context": "context-1",
  "extn_password": "123qaQQQ"
}

返回:

{
  "data": [
    {
      "email": "",
      "tel_enabled": 0,
      "login": "2011",
      "deleted_at": "",
      "tel": "",
      "created_at": "2023-03-17 01:02:38",
      "agent_info": "{}",
      "updated_at": "2023-03-17 01:02:38",
      "last_login_at": "",
      "extn": "2011",
      "is_super": 0,
      "auto_record": 0,
      "type": "NORMAL",
      "password": "Xswitch.cn/6753997!Qqa",
      "ha1": "6b2f4520f0f925f8f08c1249e0c178c1",
      "name": "2011",
      "context": "context-1",
      "extn_id": 0,
      "vm_password": "",
      "ha1b": "2620139be102567d75de062931e58b15",
      "domain": "192.168.31.98",
      "cid_name": "",
      "id": 44,
      "cid_number": ""
    },
    {
      "email": "",
      "tel_enabled": 0,
      "login": "2012",
      "deleted_at": "",
      "tel": "",
      "created_at": "2023-03-17 01:02:38",
      "agent_info": "{}",
      "updated_at": "2023-03-17 01:02:38",
      "last_login_at": "",
      "extn": "2012",
      "is_super": 0,
      "auto_record": 0,
      "type": "NORMAL",
      "password": "Xswitch.cn/6753997!Qqa",
      "ha1": "8bf8153d51fb13cba01a85670ac3cbcd",
      "name": "2012",
      "context": "context-1",
      "extn_id": 0,
      "vm_password": "",
      "ha1b": "32ce02f6c4daa7580dcc29c63d4cd2d8",
      "domain": "192.168.31.98",
      "cid_name": "",
      "id": 45,
      "cid_number": ""
    }
  ],
  "code": 200,
  "message": "success"
}

• curl 示例:

curl -XPOST -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -d '{"users_start": 2011,"users_end": 2012,"password": "Xswitch.cn/6753997!Qqa","type": "NORMAL","extn_password": "123qaQQQ","context":"context-1"}' -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/muti_add"

• 请求 URL: /api/users/import
• 请求方式: POST
• 消息头: Content-Type: application/json
• Body 信息: 参见用户信息说明：

{
  "users": [
    {
      "登录名": "user001",
      "分机": "1001",
      "名称": "用户1",
      "密码": "123!@#QWEqwe",
      "呼叫源": "context-1",
      "域": "xswitch.cn",
      "类型": "NORMAL",
      "超级管理员": "否"
    }
  ]
}

返回:

{
	"data": [
		{
			"login": "user001",
			"last_login_at": "",
			"deleted_at": "",
			"name": "用户1",
			"updated_at": "2025-08-18 05:32:03",
			"created_at": "2025-08-18 05:32:03",
			"tel_enabled": 0,
			"is_locked": false,
			"context": "context-1",
			"id": 25,
			"first_login": 0,
			"last_login_attempt_at": "",
			"idle_timeout": 60,
			"login_attempts": 0,
			"vm_password": "",
			"salt": "$1$x8DADcaA",
			"tel": "",
			"is_admin": false,
			"password": "123!@#QWEqwe",
			"agent_info": [],
			"cid_name": "",
			"sha1": "\\x42d68f5f4d5dbf62b0173ae44251e1373e06cc8e",
			"auto_record": 0,
			"cid_number": "",
			"email": "",
			"is_super": 0,
			"type": "NORMAL",
			"domain": "xswitch.cn",
			"extn": "1001"
		}
	],
	"message": "success",
	"code": 200
}

• curl 示例:

curl -XPOST -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '{"users":[{"登录名": "user001","分机": "1001","名称": "用户1","密码": "123!@#QWEqwe","呼叫源": "context-1","域": "xswitch.cn"}]}' "http://192.168.31.98:8081/api/users/import"

• 请求 URL: /api/users/qyusers
• 请求方式: POST
• 消息头: Content-Type: application/json
• Body 信息: 包含 data 数组，数组元素为待导入的用户信息：

{
  "data": [
    {
      "userid": "qyuser001",
      "password": "Qy@123456",
      "is_admin": 1,
      "context": "context-2",
      "domain": "xswitch.cn"
    }
  ]
}

• 响应示例:

{
	"code": 200,
	"message": "success",
	"data": [
		"qyuser001"
	]
}

• curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '{"data": [{"userid": "qyuser001","password": "Qy@123456","is_admin": 1,"context": "context-2","domain": "xswitch.cn"}]}' "http://192.168.31.98:8081/api/users/qyusers"

• 请求 URL: /api/users/total
• 请求方式: GET
• 消息头: Content-Type: application/json
• Body 信息: 无
• 响应示例:

{
	"count": 15
}

• curl 示例:

curl -XGET -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/total"

用于获取系统中类型为 GATEWAY 的用户信息及数量

• 请求 URL: /api/users/gateway
• 请求方式: GET
• 消息头: Content-Type: application/json
• Body 信息: 无
• 响应示例:

{
  "rowCount": 2,
  "data": [
    {
      "id": 1,
      "type": "GATEWAY",
      "name": "GatewayUser1"
    },
    {
      "id": 2,
      "type": "GATEWAY",
      "name": "GatewayUser2"
    }
  ]
}

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/gateway"

• 请求 URL: /api/users/info
• 请求方式: GET
• 消息头: Content-Type: application/json
• Body 信息: 无
• 响应示例:

{
	"vm_password": "",
	"deleted_at": "",
	"domain": "xswitch.cn",
	"login": "admin",
	"tel": "",
	"last_login_at": "2025-08-18 00:47:52",
	"is_super": 1,
	"cid_number": "",
	"created_at": "2025-08-08 03:15:20",
	"cid_name": "",
	"extn": "admin",
	"name": "Admin",
	"salt": "$1$p0htFRHX",
	"login_attempts": 0,
	"idle_timeout": 60,
	"last_login_attempt_at": "",
	"tel_enabled": 0,
	"is_locked": false,
	"context": "context-1",
	"id": 1,
	"first_login": 0,
	"updated_at": "2025-08-18 00:47:52",
	"is_admin": false,
	"email": "",
	"agent_info": [],
	"auto_record": 0,
	"type": ""
}

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/info"

用于更新指定用户（通过 id 标识）的信息，支持常规字段更新及分机号切换（toggle 动作）

• 请求 URL: /api/users/:id
• 请求方式: PUT
• 消息头: Content-Type: application/json
• Body 信息:

{
  "name": "新用户名",
  "type": "AGENT"
}

• 响应示例:

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

• curl 示例:

curl -XPUT -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '{"request":{"action":"toggle","extn_id":1}}' "http://192.168.31.98:8081/api/users/5"

用于获取系统配置的默认域信息

• 请求 URL: /api/users/force_domain/default
• 请求方式: GET
• 消息头: Content-Type: application/json
• Body 信息: 无
• 响应示例:

{
	"force_domain": "xswitch.cn"
}

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/force_domain/default"

用于获取指定用户（通过 id 标识）的分机列表

• 请求 URL: /api/users/:id/extensions
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

[
	{
		"type": "SIP",
		"call_authority": 4,
		"extn": "admin",
		"display_order": "0",
		"enable_hotline": 0,
		"hotline_type": "",
		"boss_extn": false,
		"created_at": "2025-08-08 03:15:21",
		"force_insert": 0,
		"weblogin_disabled": 0,
		"enable_extn_time_recurrences": 0,
		"priority": "99",
		"codec": "",
		"cid_number": "",
		"dtmf_type": 0,
		"enable_t38": 0,
		"deleted_at": "",
		"called_limit": 1,
		"vm_password": "",
		"caller_display": 1,
		"ha1": "3737327c84bc4a3627053e431af87ba6",
		"hotline_address": "",
		"hotline_number": "",
		"domain": "xswitch.cn",
		"intercepted_group_name": "",
		"extn_cidr": "",
		"disabled": 0,
		"updated_at": "2025-08-08 03:15:21",
		"name": "Admin",
		"enable_cb_onbusy": 0,
		"mac_address": "",
		"ringback": "",
		"call_limit": 1,
		"id": 1,
		"enable_srtp": 0,
		"timeout": "",
		"eavesdropped": 0,
		"forced_breakdown": 0,
		"eavesdrop": 0,
		"forced_insert": 0,
		"context": "context-1",
		"force_breakdown": 0,
		"auto_record": 0,
		"ha1b": "ac7f0950fa459b6779098a090bcc6af6",
		"call_transfer_type": 0,
		"sync_enabled": 0,
		"password": "XSwitch.cn/6753997",
		"group_name": "",
		"cid_name": "",
		"secretary_extn": "",
		"intercept": 0,
		"connect_phone": "",
		"user_id": 1,
		"intercepted": 0,
		"description": "",
		"voicemail": 0,
		"enable_ringback": 0
	}
]

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -X "GET" "http://192.168.31.98:8081/api/users/1/extensions"

用于获取当前登录用户的信息及关联的微信头像信息

• 请求 URL: /api/users/wechat_info
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:正常返回一个 JSON Object，data 中包含用户信息

{
	"salt": "$1$p0htFRHX",
	"tel_enabled": 0,
	"id": 1,
	"domain": "xswitch.cn",
	"is_admin": false,
	"updated_at": "2025-08-18 00:47:52",
	"vm_password": "",
	"cid_name": "",
	"auto_record": 0,
	"created_at": "2025-08-08 03:15:20",
	"idle_timeout": 60,
	"last_login_attempt_at": "",
	"type": "",
	"is_locked": false,
	"context": "context-1",
	"cid_number": "",
	"first_login": 0,
	"last_login_at": "2025-08-18 00:47:52",
	"deleted_at": "",
	"is_super": 1,
	"login": "admin",
	"sha1": "\\xc329e666b2ba4840f7d0c798ad7e9a4a43e98371",
	"agent_info": [],
	"email": "",
	"name": "Admin",
	"tel": "",
	"extn": "admin",
	"login_attempts": 0
}

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/wechat_info"

用于根据筛选条件查询用户信息并生成可下载的表格数据（支持中英文表头）

• 请求 URL: /api/users/download
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

[
	[
		"User ID",
		"Login Name",
		"Extension",
		"Name",
		"Call Source",
		"Domain",
		"Type",
		"Super Admin",
		"Password"
	],
	[
		"1",
		"admin",
		"admin",
		"Admin",
		"context-1",
		"xswitch.cn",
		"NORMAL",
		"否"
	],
	[
		"2",
		"1000",
		"1000",
		"1000",
		"context-1",
		"xswitch.cn",
		"NORMAL",
		"否"
	],
	[
		"13",
		"cher",
		"1234",
		"小",
		"context-1",
		"xswitch.cn",
		"NORMAL",
		"否"
	],
	[
		"14",
		"2011",
		"2011",
		"2011",
		"context-1",
		"xswitch.cn",
		"NORMAL",
		"否"
	],
	[
		"15",
		"2012",
		"2012",
		"2012",
		"context-1",
		"xswitch.cn",
		"NORMAL",
		"否"
	],
]

用于获取用户及其关联的微信账号信息

• 请求 URL: /api/users/bind
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

[
  {
    "id": 2,
    "login": "user02",
    "name": "用户2",
    "wechat_id": null,
    "openid": null,
    "headimgurl": null,
    "nickname": null
  }
]

如果出错，返回对应内容： 无操作权限时返回 403 及提示 “no permission” 无数据时返回空数组 []

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/bind"

用于获取所有密钥信息

• 请求 URL: /api/users/:id/dev_keys
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

[
	{
		"k": "0198bbcc-42f9-7ee4-a466-103f54c362ea",
		"description": "11",
		"updated_at": "2025-08-18 06:09:43",
		"deleted_at": "",
		"created_at": "2025-08-18 06:09:43",
		"user_id": 5,
		"id": 1,
		"enabled": 0
	},
	{
		"k": "0198bbe1-cfd8-7242-9b0b-cb2894054c1f",
		"description": "密钥描述",
		"updated_at": "2025-08-18 06:33:15",
		"deleted_at": "",
		"created_at": "2025-08-18 06:33:15",
		"user_id": 5,
		"id": 2,
		"enabled": 1
	}
]

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/5/dev_keys"

用于获取指定用户（通过 id 标识）关联的微信账号详细信息

• 请求 URL: /api/users/:id/wechat_users
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

[
  {
    "id": 5,
    "openid": "o6_bmjrPTlm6_2sgVt7hMZOPfL2M",
    "nickname": "微信用户1",
    "headimgurl": "https://example.com/avatar1.jpg"
  }
]

无关联微信账号时：

[]

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/5/wechat_users"

用于获取指定用户（通过 id 标识）关联的队列信息

• 请求 URL: /api/users/:id/queue
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

{
	"cti_template": "callcenter"
}

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/5/queue"

• 请求 URL: /api/users/:id/dev_keys
• 请求方式: POST
• 消息头: Content-Type: application/json
• Body 信息: 包含设备密钥描述（可选）。示例：

{
	"description": "密钥描述"
}

• 响应示例:

{
	"code": 200,
	"data": {
		"user_id": 5,
		"deleted_at": "",
		"description": "密钥描述",
		"id": 2,
		"created_at": "2025-08-18 06:33:15",
		"enabled": 1,
		"updated_at": "2025-08-18 06:33:15",
		"k": "0198bbe1-cfd8-7242-9b0b-cb2894054c1f"
	},
	"message": "success"
}

• curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '{"description": "密钥描述"}' "http://192.168.31.98:8081/api/users/qyuser001/dev_keys"

• 请求 URL: /api/users/:id/dev_keys/:key_id
• 请求方式: PUT
• 消息头: Content-Type: application/json
• Body 信息: 包含操作类型或待更新的密钥信息。示例：

{
  "action": "toggle"
}

• 返回值: 对象，包含更新后的用户信息。示例：

{
	"code": 200,
	"data": {
		"updated_at": "2025-08-18 06:09:43",
		"k": "0198bbcc-42f9-7ee4-a466-103f54c362ea",
		"user_id": 5,
		"enabled": 0,
		"created_at": "2025-08-18 06:09:43",
		"deleted_at": "",
		"description": "11",
		"id": 1
	},
	"message": "success"
}

• curl 示例:

curl -XPUT -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '{"action": "toggle"}' "http://192.168.0.198:18081/api/users/5/dev_keys/1"

• 请求 URL: /api/users/:id/dev_keys/:key_id
• 请求方式: DELETE
• 消息头: Content-Type: application/json
• Body 信息: 无
• 返回值: 对象，包含被删除的密钥key_id。示例：

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

• curl 示例:

curl -XDELETE -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.0.198:18081/api/users/5/dev_keys/1"

• 请求 URL： /api/users/$id
• 请求方式： DELETE
• 消息头：无
• 返回值：对象，包含被删除用户的 ID，如 {"id": "3"} 。
• 示例：

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

返回： {"id": "3"}

• 请求 URL： /api/users/delete
• 请求方式： POST
• 消息头： Content-Type: application/json
• Body 信息: 包含待删除用户 id 的数组。示例：

	[1, 2, 3]

• 返回值：正常返回一个 JSON Object，data 中包含删除成功的用户数量：

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

• curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '[1, 2, 3]' 'http://192.168.31.98:8081/api/users/delete'

• 请求 URL： /api/users/$id
• 请求方式： PUT
• 消息头：Content-Type: application/json
• Body 信息：参见用户信息说明
• 返回值： 对象，包含被修改的用户的 ID，如： {"id": "3"}
• 示例：

PUT http://192.168.1.100:8081/api/users/3

Body:

{
  "login": "36",
  "name": "36",
  "vm_password": "36",
  "domain": "xswitch.cn",
  "type": "NORMAL",
  "tel": "123456789",
  "auto_record": "0",
  "tel_enabled": "0"
}

• curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: applcation/json" -d '{"login": "36","name": "36","vm_password": "36","domain": "xswitch.cn","type": "NORMAL","tel": "1234567890000","auto_record": "0","tel_enabled": "0"}' "192.168.3.16:8081/api/users/49"

返回：

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

• 其它说明：

如果在请求参数中包含用户的 ID，则会被忽略。

• 请求 URL: /api/users/change_password
• 请求方式: PUT
• 消息头: Content-Type: application/json
• Body 信息: 参见用户信息说明
• 返回值: status 200 OK
• 示例:

PUT http://192.168.1.100:8081/api/users/change_password

Body:

{
  "password": "1qazQAZ!@4",
  "old_password": "1qazQAZ!@5",
  "domain": "192.168.31.98",
  "id": "39"
}

• curl 示例:

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" \
-H "Content-Type: application/json" \
-d '{"id":"39","password":"1qazQAZ!@4","old_password": "1qazQAZ!@5","domain": "192.168.31.98"}' \
"192.168.1.100:8081/api/users/change_password"

返回：

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

• 请求 URL： /api/users 返回所有用户
• 请求 URL： /api/users? 返回所有用户
• 请求 URL： /api/users?page=1&perPage=10&login=1001&name=张三&type=NORMAL 支持用户名、名称、类型等查询
• 请求 URL： /api/users/$id 返回指定 ID 的用户
• 请求方式： GET
• 返回值： 用户对象，如果找不到会返回 HTTP 状态码404。

• 示例：

GET /api/users/1

返回：

{
  "extn": "admin",
  "cid_name": "",
  "context": "context-1",
  "ha1b": "747e17632f2443bfdbef0113eba4a266",
  "name": "Admin",
  "type": "",
  "last_login_at": "2022-05-11 09:44:44",
  "deleted_at": "",
  "id": 1,
  "login": "admin",
  "updated_at": "2022-05-11 09:44:44",
  "ha1": "fd4500fcb6ccd4ee87d5debac892ac59",
  "created_at": "2022-05-11 09:43:15",
  "is_super": 1,
  "auto_record": 0,
  "email": "",
  "tel_enabled": 0,
  "tel": "",
  "cid_number": "",
  "extn_id": 0,
  "domain": "demo.xswitch.cn",
  "vm_password": ""
}

GET /api/users

返回

{
  "data": [
    {
      "cid_number": "",
      "ha1b": "",
      "auto_record": 0,
      "vm_password": "",
      "domain": "demo.xswitch.cn",
      "cid_name": "",
      "extn_id": 0,
      "extn": "",
      "tel": "",
      "deleted_at": "",
      "updated_at": "2022-05-11 09:43:16",
      "is_super": 0,
      "created_at": "2022-05-11 09:43:15",
      "last_login_at": "",
      "tel_enabled": 0,
      "context": "",
      "name": "SYSTEM",
      "ha1": "",
      "login": "system",
      "email": "",
      "type": "",
      "id": 0
    },
    {
      "cid_number": "",
      "ha1b": "747e17632f2443bfdbef0113eba4a266",
      "auto_record": 0,
      "vm_password": "",
      "domain": "demo.xswitch.cn",
      "cid_name": "",
      "extn_id": 0,
      "extn": "admin",
      "tel": "",
      "deleted_at": "",
      "updated_at": "2022-05-11 09:44:44",
      "is_super": 1,
      "created_at": "2022-05-11 09:43:15",
      "last_login_at": "2022-05-11 09:44:44",
      "tel_enabled": 0,
      "context": "context-1",
      "name": "Admin",
      "ha1": "fd4500fcb6ccd4ee87d5debac892ac59",
      "login": "admin",
      "email": "",
      "type": "",
      "id": 1
    }
  ],
  "pageCount": 1,
  "rowCount": 2,
  "page": 1
}

• curl 示例：

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

• 请求 URL： /api/users/
• 请求方式： PUT

PUT /api/users/

Body:

{
    "type": "AGENT",
    "idle_timeout": 60,
    "username": [
        "9",
        "8",
        "7"
    ]
}

返回值：

{
    "code": 200,
    "data": [],
    "message": "update rows 3"
}

• curl 示例：

curl --location --request PUT 'http://192.168.0.101:8081/api/users/' \
--header 'token: 01906d5e-28a0-7495-aa9f-0fdeb7212878' \
--header 'Content-Type: application/json' \
--header 'Cookie: freeswitch_xtra_session_id=01906d5e-28a0-7495-aa9f-0fdeb7212878' \
--data '{
    "type": "AGENT",
    "idle_timeout": 60,
    "username": [
        "9",
        "8",
        "7"
    ]
}'

• 请求 URL： /api/users/:extnID
• 请求方式： PUT

GET /api/users/4607

Body:

{
    "action": "toggle",
    "extn_id": 2510
}

返回值：

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

• curl 示例：

curl --location --request PUT 'http://192.168.0.101:8081/api/users/4607' \
--header 'token: 01906d5e-28a0-7495-aa9f-0fdeb7212878' \
--header 'Content-Type: application/json' \
--header 'Cookie: freeswitch_xtra_session_id=01906d5e-28a0-7495-aa9f-0fdeb7212878' \
--data '{
    "action": "toggle",
    "extn_id": 2510
}'

• 请求 URL: /api/users/:id/wechat_users/:wechat_user_id
• 请求方式: DELETE
• 消息头: Content-Type: application/json
• Body 信息: 无
• 返回值: 返回包含解除关联的微信用户 ID 的 JSON 对象

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

• curl 示例:

curl -XDELETE -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/1/wechat_users/123"

用于获取当前登录用户的详细信息（包含自定义字段）

• 请求 URL: /api/users/currentUser
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:正常返回一个 JSON Object，data 中包含用户详情

{
	"geographic": {
		"province": {
			"key": "256000",
			"label": "山东省"
		},
		"city": {
			"key": "264000",
			"label": "烟台市"
		}
	},
	"notifyCount": 0,
	"name": "Admin",
	"phone": "0535-6753997",
	"tags": [
		{
			"label": "很有想法的",
			"key": "0"
		},
		{
			"label": "专注设计",
			"key": "1"
		}
	],
	"address": "烟台市",
	"userid": 1,
	"unreadCount": 0,
	"group": "小樱桃-技术部－UED",
	"title": "Admin",
	"email": "",
	"country": "China",
	"signature": "海纳百川，有容乃大",
	"avatar": "/assets/img/sit.png"
}

如果出错，返回对应 HTTP 状态码： 无操作权限时返回 403 及提示 “no permission”

用户不存在时返回 404 及提示 “not found”

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/currentUser"

用于分页获取与当前用户同域的用户列表信息

• 请求 URL: /api/users/app
• 请求 URL: /api/users/app?page=1&perPage=10
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:正常返回一个 JSON Object，包含分页信息和用户数据列表。

{
	"rowCount": 15,
	"data": [
		{
			"name": "1000",
			"id": "2",
			"email": "",
			"extn": "1000"
		},
		{
			"name": "1001",
			"id": "3",
			"email": "",
			"extn": "1001"
		},
		{
			"name": "1234",
			"id": "19",
			"email": "",
			"extn": "1234"
		},
		{
			"name": "小聪明",
			"id": "5",
			"email": "",
			"extn": "2000"
		},
		{
			"name": "2011",
			"id": "14",
			"email": "",
			"extn": "2011"
		},
		{
			"name": "2012",
			"id": "15",
			"email": "",
			"extn": "2012"
		},
		{
			"name": "2013",
			"id": "16",
			"email": "",
			"extn": ""
		},
		{
			"name": "2014",
			"id": "17",
			"email": "",
			"extn": ""
		},
		{
			"name": "1234",
			"id": "22",
			"email": "",
			"extn": "1234"
		},
		{
			"name": "Admin",
			"id": "1",
			"email": "",
			"extn": "admin"
		},
		{
			"name": "小",
			"id": "13",
			"email": "",
			"extn": "1234"
		},
		{
			"name": "小樱",
			"id": "8",
			"email": "",
			"extn": ""
		},
		{
			"name": "1234",
			"id": "24",
			"email": "",
			"extn": "4589"
		},
		{
			"name": "qyuser001",
			"id": "27",
			"email": "",
			"extn": "qyuser001"
		},
		{
			"name": "SYSTEM",
			"id": "0",
			"email": "",
			"extn": ""
		}
	],
	"page": 1,
	"pageCount": 1
}

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/app?page=1&perPage=10"

警告：该接口已废弃（api/users/wechat is Deprecated!!），建议使用api/users/:id/wechat_users 接口。

用于获取指定用户（通过 id 标识）关联的队列信息

• 请求 URL: /api/users/:id/queue/name
• 请求方式: GET
• 消息头: Content-Type: application/json
• 响应示例:

[
	{
		"name": "test2"
	}
]

• curl 示例:

curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '' "http://192.168.31.98:8081/api/users/5/queue/name"

• 请求 URL： /api/users
• 请求方式： DELETE
• 消息头： Content-Type: application/json
• Body 信息:待删除用户 ID 数组，示例：

[4,5]

• 返回值：正常返回一个 JSON Object，data 中包含删除成功的用户数量：

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

• curl 示例：

curl -XDELETE -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '[4,5]' 'http://192.168.31.98:8081/api/users'

• 请求 URL： /api/users/delete
• 请求方式： DELETE
• 消息头： Content-Type: application/json
• Body 信息：包含待删除用户extn。示例：

{
  "extn":"444"
}

• 返回值：正常返回一个 JSON Object，data 中包含删除成功的用户数量：

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

• curl 示例：

curl -XDELETE -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" -d '{"extn":"444"}' 'http://192.168.31.98:8081/api/users/delete'

• 请求 URL: /api/users/:id/password
• 请求方式: PUT
• 消息头: Content-Type: application/json
• Body 信息: 包含旧密码和新密码。
• 示例：

PUT /api/users/1/password

普通用户修改：

{
  "old_password": "XSwitch.cn/6753997",
  "password": "New@456"
}

管理员用户修改其他用户密码

{
  "id": 5,
  "old_password": "Admin@123",  // 管理员自身旧密码（部分场景需验证）
  "password": "New@456"
}

• 返回值：正常返回一个 JSON Object，data 中包含被修改的用户的 ID。

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

• curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -H "Content-Type: application/json" -d  '{"old_password": "XSwitch.cn/6753997","password": "New@456"}' http://192.168.1.100:8081/api/users/5/password

• 请求 URL： /api/users/list 返回所有用户下分机在线状态
• 请求 URL： /api/users/list?extn=$extn 返回指定分机号用户信息和注册信息
• 请求方式： GET

GET /api/users/list

返回

[
  {
    "extn": "admin",
    "status": "offline"
  },
  {
    "extn": "1001",
    "status": "offline"
  },
  {
    "extn": "1000",
    "status": "offline"
  }
]

GET /api/users/list?extn=1001

返回

{
  "ha1b": "6238501df8a36fe9ee9cbb4855b651e1",
  "ha1": "f0ad0f1442d65643068a0f6faeea5208",
  "extn": "1001",
  "cid_number": "",
  "email": "",
  "login": "1001",
  "is_super": 0,
  "cid_name": "bob",
  "last_login_at": "",
  "password": "Xswitch.cn/6753997",
  "context": "context-1",
  "regs": [],
  "updated_at": "2022-05-11 09:50:56",
  "auto_record": 0,
  "vm_password": "1234",
  "id": 3,
  "created_at": "2022-05-11 09:43:15",
  "domain": "demo.xswitch.cn",
  "tel": "",
  "name": "5555",
  "extn_id": 0,
  "tel_enabled": 0,
  "agent_info": "{}",
  "type": "AGENT",
  "deleted_at": ""
}

• curl 示例：

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

• 请求 URL： /api/users/list1 返回所有分机在线以及未在线状态
• 请求方式： GET

GET /api/users/list1

返回

{
  "reg": {
    "row_count": 2,
    "rows": [
      {
        "url": "sofia/default/sip:1003@192.168.3.107:5060;transport=tcp",
        "expires": "1666342728",
        "token": "678042420-5060-1@BJC.BGI.D.BAH",
        "reg_user": "1003",
        "network_proto": "tcp",
        "metadata": "",
        "hostname": "a7642d101231",
        "network_port": "58570",
        "realm": "xswitch.cn",
        "network_ip": "172.18.0.1"
      },
      {
        "url": "sofia/default/sip:1002@172.18.0.1:62404;transport=UDP;rinstance=3c3795973a249e7d",
        "expires": "1666340706",
        "token": "2xrd5GUgSWnixoaYvD8Xpw..",
        "reg_user": "1002",
        "network_proto": "udp",
        "metadata": "",
        "hostname": "a7642d101231",
        "network_port": "62404",
        "realm": "xswitch.cn",
        "network_ip": "172.18.0.1"
      }
    ]
  },
  "unreg": [
    {
      "status": "offline",
      "extn": "admin"
    },
    {
      "status": "offline",
      "extn": "1000"
    }
  ]
}

• curl 示例：

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

分机字段信息说明如下：

创建单个分机号信息说明如下：

批量创建分机号信息说明如下：

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

{
  "name": "lis",
  "extn": "889",
  "password": "123QWEqwe",
  "context": "context-1",
  "user_id": 6
}

• name： 分机名
• extn：分机号码
• password：分机注册密码，需由大写字母+小写字母+数字组合而成，且在 8-20 位之间
• context：分机呼叫源

• curl 示例：

curl -0 -H "X-XTRA-AUTH-ID: 018fb7c0-5e52-79ed-92f4-6263b2835f1b" \
-d '{"name": "接口测试12","extn": "47789451001","context": "context-1","user_id": 6,"password": "XSwitch.cn/6753997"}' \
-H "Content-Type: application/json" "192.168.0.108:8081/api/extensions"

• 返回值：

{
	"message":	"success",
	"data":	{
		"eavesdrop":	0,
		"tmf_type":	0,
		"extn":	"47789451001",
		"mac_address":	"",
		"called_limit":	1,
		"forced_insert":	0,
		"forced_breakdown":	0,
		"ringback":	"",
		"name":	"接口测试12",
		"boss_extn":	false,
		"enable_srtp":	0,
		"weblogin_disabled":	0,
		"disabled":	0,
		"timeout":	"",
		"enable_t38":	0,
		"enable_extn_time_recurrences":	0,
		"cid_number":	"",
		"caller_display":	1,
		"dtmf_type":	0,
		"call_limit":	1,
		"eavesdropped":	0,
		"extn_cidr":	"",
		"updated_at":	"2024-05-27 10:02:19",
		"intercepted_group_name":	"",
		"created_at":	"2024-05-27 10:02:19",
		"group_name":	"",
		"call_authority":	4,
		"auto_record":	0,
		"secretary_extn":	"",
		"enable_hotline":	0,
		"hotline_address":	"",
		"hotline_type":	"",
		"force_breakdown":	0,
		"enable_cb_onbusy":	0,
		"sync_enabled":	0,
		"codec":	"",
		"ha1":	"dc093f09ebeb9a37283f22956e1d5b5e",
		"type":	"SIP",
		"description":	"",
		"password":	"XSwitch.cn/6753997",
		"connect_phone":	"",
		"domain":	"xswitch.cn",
		"hotline_number":	"",
		"vm_password":	"",
		"call_transfer_type":	0,
		"force_insert":	0,
		"deleted_at":	"",
		"user_id":	6,
		"intercepted":	0,
		"id":	2531,
		"priority":	"99",
		"display_order":	"0",
		"enable_ringback":	0,
		"intercept":	0,
		"voicemail":	0,
		"cid_name":	"",
		"ha1b":	"fe25bae9818d72a995af21faef3a3cae",
		"context":	"context-1"
	},
	"code":	200
}

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

Body:

{
    "extns_start": 100001,
    "extns_end": 100002,
    "password": "Lv1.rqdg6Un6ho4B",
    "context": "context-5",
    "user_id": 6
}

• extns_start：批量创建分机起始号码
• extns_start：批量创建分机结束号码
• password ：分机注册密码，需由大写字母+小写字母+数字组合而成，且在 8-20 位之间
• user_id：分机归属于此 ID 对应的用户，如 0 代表 system 用户
• context：分机呼叫源

• curl 示例:

curl -XPOST -H "X-XTRA-AUTH-ID: 06d8b7cd-88ca-4910-a9f4-4b2c7abae23e" -d '{"extns_start": 9898959,"extns_end": 9898969,"password": "XSwitch.cn/6753997","context": "context-1","user_id": 6}' -H "Content-Type: application/json" "http://192.168.3.16:8081/api/extensions/muti_add"

• 返回值：

{
    "data": [
        {
            "tmf_type": 0,
            "password": "Lv1.rqdg6Un6ho4B",
            "cid_name": "",
            "weblogin_disabled": 0,
            "timeout": "",
            "group_name": "",
            "context": "context-5",
            "voicemail": 0,
            "enable_extn_time_recurrences": 0,
            "connect_phone": "",
            "enable_t38": 0,
            "enable_srtp": 0,
            "vm_password": "",
            "called_limit": 1,
            "deleted_at": "",
            "cid_number": "",
            "ha1b": "f6947385ed54ae16d7738d1314c533bf",
            "dtmf_type": 0,
            "description": "",
            "sync_enabled": 0,
            "id": 2554,
            "updated_at": "2024-05-31 09:29:51",
            "enable_ringback": 0,
            "secretary_extn": "",
            "priority": "99",
            "ringback": "",
            "display_order": "0",
            "call_limit": 1,
            "forced_insert": 0,
            "name": "100001",
            "boss_extn": false,
            "hotline_address": "",
            "force_breakdown": 0,
            "hotline_number": "",
            "caller_display": 1,
            "enable_cb_onbusy": 0,
            "disabled": 0,
            "mac_address": "",
            "codec": "",
            "force_insert": 0,
            "intercepted_group_name": "",
            "intercepted": 0,
            "type": "SIP",
            "eavesdropped": 0,
            "auto_record": 0,
            "hotline_type": "",
            "ha1": "342e2bf9f7b828814af3800ecf8ed73a",
            "intercept": 0,
            "eavesdrop": 0,
            "extn": "100001",
            "forced_breakdown": 0,
            "user_id": 6,
            "enable_hotline": 0,
            "domain": "xswitch.cn",
            "extn_cidr": "",
            "call_transfer_type": 0,
            "created_at": "2024-05-31 09:29:51",
            "call_authority": 4
        },
        {
            "tmf_type": 0,
            "password": "Lv1.rqdg6Un6ho4B",
            "cid_name": "",
            "weblogin_disabled": 0,
            "timeout": "",
            "group_name": "",
            "context": "context-5",
            "voicemail": 0,
            "enable_extn_time_recurrences": 0,
            "connect_phone": "",
            "enable_t38": 0,
            "enable_srtp": 0,
            "vm_password": "",
            "called_limit": 1,
            "deleted_at": "",
            "cid_number": "",
            "ha1b": "4b8bbfb59bcff8d3a80de2bb533812c9",
            "dtmf_type": 0,
            "description": "",
            "sync_enabled": 0,
            "id": 2555,
            "updated_at": "2024-05-31 09:29:51",
            "enable_ringback": 0,
            "secretary_extn": "",
            "priority": "99",
            "ringback": "",
            "display_order": "0",
            "call_limit": 1,
            "forced_insert": 0,
            "name": "100002",
            "boss_extn": false,
            "hotline_address": "",
            "force_breakdown": 0,
            "hotline_number": "",
            "caller_display": 1,
            "enable_cb_onbusy": 0,
            "disabled": 0,
            "mac_address": "",
            "codec": "",
            "force_insert": 0,
            "intercepted_group_name": "",
            "intercepted": 0,
            "type": "SIP",
            "eavesdropped": 0,
            "auto_record": 0,
            "hotline_type": "",
            "ha1": "42adeeb1dc2b16ad2d9846b93beb18a3",
            "intercept": 0,
            "eavesdrop": 0,
            "extn": "100002",
            "forced_breakdown": 0,
            "user_id": 6,
            "enable_hotline": 0,
            "domain": "xswitch.cn",
            "extn_cidr": "",
            "call_transfer_type": 0,
            "created_at": "2024-05-31 09:29:51",
            "call_authority": 4
        }
    ],
    "code": 200,
    "message": "success"
}