Package com.bytedesk.call.users

Class CallUserController

java.lang.Object

com.bytedesk.call.users.CallUserController

@RestController
@RequestMapping("/freeswitch/api/v1/users")
@ConditionalOnProperty(prefix="bytedesk.call.freeswitch",
                       name="enabled",
                       havingValue="true",
                       matchIfMissing=false)
public class CallUserController
extends Object

Call用户管理REST API控制器

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallUserController.NumberStats	用户统计信息内部类

Field Summary

Fields

Modifier and Type	Field	Description
private final CallUserService	userService

Constructor Summary

Constructors

Constructor	Description
CallUserController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<JsonResult<?>>	checkNumberExists(String username, String domain)	检查用户名和域名组合是否存在
org.springframework.http.ResponseEntity<JsonResult<?>>	createNumber(@Valid CallUserRequest request)	创建用户
org.springframework.http.ResponseEntity<JsonResult<?>>	deleteNumber(Long id)	删除用户
org.springframework.http.ResponseEntity<JsonResult<?>>	disableNumber(Long id)	禁用用户
org.springframework.http.ResponseEntity<JsonResult<?>>	enableNumber(Long id)	启用用户
org.springframework.http.ResponseEntity<JsonResult<?>>	getEnabledNumbers()	获取启用的用户列表
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumber(Long id)	获取用户详情
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumberByNumbername(String username)	根据用户名获取用户
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumberByNumbernameAndDomain(String username, String domain)	根据用户名和域名获取用户
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumbers(int page, int size, String sortBy, String sortDir)	获取用户列表（分页）
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumbersByAccountcode(String accountcode)	根据账户代码获取用户列表
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumbersByDomain(String domain)	根据域名获取用户列表
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumbersByEmail(String email)	根据邮箱获取用户列表
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumberStats()	获取用户统计信息
org.springframework.http.ResponseEntity<JsonResult<?>>	getNumberStatsByDomain(String domain)	根据域名获取用户统计信息
org.springframework.http.ResponseEntity<JsonResult<?>>	getOnlineNumbers()	获取在线的用户列表
org.springframework.http.ResponseEntity<JsonResult<?>>	updateNumber(Long id, @Valid CallUserRequest request)	更新用户
org.springframework.http.ResponseEntity<JsonResult<?>>	updateNumberRegistration(String username, String domain, String registerIp, String userAgent)	更新用户注册信息
org.springframework.http.ResponseEntity<JsonResult<?>>	validateNumberPassword(String username, String domain, String password)	验证用户密码

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

userService

private final CallUserService userService

Constructor Details

CallUserController

public CallUserController()

Method Details

createNumber

@PostMapping
public org.springframework.http.ResponseEntity<JsonResult<?>> createNumber(@Valid @RequestBody
 @Valid CallUserRequest request)

创建用户

getNumber

@GetMapping("/{id}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumber(@PathVariable
 Long id)

获取用户详情

getNumberByNumbername

@GetMapping("/username/{username}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumberByNumbername(@PathVariable
 String username)

根据用户名获取用户

getNumberByNumbernameAndDomain

@GetMapping("/username/{username}/domain/{domain}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumberByNumbernameAndDomain(@PathVariable
 String username,
 @PathVariable
 String domain)

根据用户名和域名获取用户

getNumbers

@GetMapping
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumbers(@RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="20")
 int size,
 @RequestParam(defaultValue="id")
 String sortBy,
 @RequestParam(defaultValue="desc")
 String sortDir)

获取用户列表（分页）

getNumbersByDomain

@GetMapping("/domain/{domain}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumbersByDomain(@PathVariable
 String domain)

根据域名获取用户列表

getEnabledNumbers

@GetMapping("/enabled")
public org.springframework.http.ResponseEntity<JsonResult<?>> getEnabledNumbers()

获取启用的用户列表

getOnlineNumbers

@GetMapping("/online")
public org.springframework.http.ResponseEntity<JsonResult<?>> getOnlineNumbers()

获取在线的用户列表

getNumbersByEmail

@GetMapping("/email/{email}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumbersByEmail(@PathVariable
 String email)

根据邮箱获取用户列表

getNumbersByAccountcode

@GetMapping("/accountcode/{accountcode}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumbersByAccountcode(@PathVariable
 String accountcode)

根据账户代码获取用户列表

updateNumber

@PutMapping("/{id}")
public org.springframework.http.ResponseEntity<JsonResult<?>> updateNumber(@PathVariable
 Long id,
 @Valid @RequestBody
 @Valid CallUserRequest request)

更新用户

enableNumber

@PutMapping("/{id}/enable")
public org.springframework.http.ResponseEntity<JsonResult<?>> enableNumber(@PathVariable
 Long id)

启用用户

disableNumber

@PutMapping("/{id}/disable")
public org.springframework.http.ResponseEntity<JsonResult<?>> disableNumber(@PathVariable
 Long id)

禁用用户

updateNumberRegistration

@PutMapping("/registration")
public org.springframework.http.ResponseEntity<JsonResult<?>> updateNumberRegistration(@RequestParam
 String username,
 @RequestParam
 String domain,
 @RequestParam
 String registerIp,
 @RequestParam(required=false)
 String userAgent)

更新用户注册信息

deleteNumber

@DeleteMapping("/{id}")
public org.springframework.http.ResponseEntity<JsonResult<?>> deleteNumber(@PathVariable
 Long id)

删除用户

validateNumberPassword

@PostMapping("/validate")
public org.springframework.http.ResponseEntity<JsonResult<?>> validateNumberPassword(@RequestParam
 String username,
 @RequestParam
 String domain,
 @RequestParam
 String password)

验证用户密码

getNumberStats

@GetMapping("/stats")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumberStats()

获取用户统计信息

getNumberStatsByDomain

@GetMapping("/stats/domain/{domain}")
public org.springframework.http.ResponseEntity<JsonResult<?>> getNumberStatsByDomain(@PathVariable
 String domain)

根据域名获取用户统计信息

checkNumberExists

@GetMapping("/exists")
public org.springframework.http.ResponseEntity<JsonResult<?>> checkNumberExists(@RequestParam
 String username,
 @RequestParam
 String domain)

检查用户名和域名组合是否存在