短信通道

提供第三方短信渠道配置管理功能。若短信无法发送，请确认是否已安装对应短信渠道插件或短信模板是否正确

---

启用或禁用短信通道

PATCH

/api/v1/sms/channel/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/sms/channel/enabled

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询短信通道详情

GET

/api/v1/sms/channel/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

短信通道ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/sms/channel/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

查询短信通道列表

GET

/api/v1/sms/channel

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/sms/channel

试验场

授权

UserHttpBearer

变量

键

值

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

更新短信通道

PATCH

/api/v1/sms/channel

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/sms/channel

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---