Package com.sankcrm.erp.auth.interfaces.sms

Class SmsChannelController

java.lang.Object

com.sankcrm.erp.auth.interfaces.sms.SmsChannelController

@RestController
public class SmsChannelController
extends Object

短信渠道管理

Since:

2.1.3

Author:

zhsxin

create time:

2023/11/20 下午2:55

Constructor Summary

Constructors

Constructor	Description
SmsChannelController()

Method Summary

Modifier and Type	Method	Description
com.sankcrm.erp.mvc.application.readmodel.Response<SmsChannelDto>	apiCreate(SmsChannelCreateCommand command)	创建短信渠道
com.sankcrm.erp.mvc.application.readmodel.Response<Set<ChannelInfo>>	channels()	短信供货商
com.sankcrm.erp.mvc.application.readmodel.Response<SmsChannelDto>	create(SmsChannelCreateCommand command)	创建短信渠道
com.sankcrm.erp.mvc.application.readmodel.Response<Map<String,Object>>	getApi(SmsChannelByIdQuery query)	查询API信息
com.sankcrm.erp.mvc.application.readmodel.Response<List<SmsChannelDto>>	list(SmsChannelListQuery query)	短信渠道列表
com.sankcrm.erp.mvc.application.readmodel.Response<com.sankcrm.erp.bus.Pagination<SmsChannelDto>>	page(SmsChannelPageQuery query)	短信渠道分页
com.sankcrm.erp.mvc.application.readmodel.Response<SmsChannelDto>	updateApi(SmsChannelUpdateApiCommand command)	更新API信息

Methods inherited from class java.lang.Object

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

Constructor Details

SmsChannelController

public SmsChannelController()

Method Details

create

@PostMapping("/v1/app/auth/sms/channel/create")
public com.sankcrm.erp.mvc.application.readmodel.Response<SmsChannelDto> create(@RequestBody
 SmsChannelCreateCommand command)
                                                                         throws com.sankcrm.erp.common.exception.CoreException

创建短信渠道

Parameters:

command - 渠道信息

Returns:

渠道信息

Throws:

com.sankcrm.erp.common.exception.CoreException - 创建失败

apiCreate

@PostMapping("/v1/api/auth/sms/channel/create")
public com.sankcrm.erp.mvc.application.readmodel.Response<SmsChannelDto> apiCreate(@RequestBody
 SmsChannelCreateCommand command)
                                                                            throws com.sankcrm.erp.common.exception.CoreException

创建短信渠道

Parameters:

command - 渠道信息

Returns:

渠道信息

Throws:

com.sankcrm.erp.common.exception.CoreException - 创建失败

Since:

2.2.1

updateApi

@PostMapping("/v1/app/auth/sms/channel/api/update")
public com.sankcrm.erp.mvc.application.readmodel.Response<SmsChannelDto> updateApi(@RequestBody
 SmsChannelUpdateApiCommand command)
                                                                            throws com.sankcrm.erp.common.exception.CoreException

更新API信息

Parameters:

command - 渠道信息

Returns:

渠道信息

Throws:

com.sankcrm.erp.common.exception.CoreException - 创建失败

getApi

@GetMapping("/v1/app/auth/sms/channel/api/get")
public com.sankcrm.erp.mvc.application.readmodel.Response<Map<String,Object>> getApi(SmsChannelByIdQuery query)
                                                                              throws com.sankcrm.erp.common.exception.CoreException

查询API信息

Parameters:

query - 渠道信息

Returns:

渠道信息

Throws:

com.sankcrm.erp.common.exception.CoreException - 创建失败

list

@GetMapping("/v1/app/auth/sms/channel/list")
public com.sankcrm.erp.mvc.application.readmodel.Response<List<SmsChannelDto>> list(SmsChannelListQuery query)
                                                                             throws com.sankcrm.erp.common.exception.CoreException

短信渠道列表

Parameters:

query - 渠道信息

Returns:

渠道信息

Throws:

com.sankcrm.erp.common.exception.CoreException - 创建失败

page

@GetMapping("/v1/app/auth/sms/channel/page")
public com.sankcrm.erp.mvc.application.readmodel.Response<com.sankcrm.erp.bus.Pagination<SmsChannelDto>> page(SmsChannelPageQuery query)
                                                                                                       throws com.sankcrm.erp.common.exception.CoreException

短信渠道分页

Parameters:

query - 渠道信息

Returns:

渠道信息

Throws:

com.sankcrm.erp.common.exception.CoreException - 创建失败

channels

@GetMapping("/v1/app/auth/sms/channel/codes")
public com.sankcrm.erp.mvc.application.readmodel.Response<Set<ChannelInfo>> channels()

短信供货商

Returns:

渠道信息

Since:

2.1.4