Search SMS Channel¶
查询短信渠道,范围包括当前 OU 和 system OU。
请求格式¶
GET https://{apigw-address}/notification-center-service/v2.0/sms/tunnels
请求参数 (URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
组织 ID。如何获取 orgId 信息 >> |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
Data 结构体数组 |
有关 Data 结构体的定义,参见 Data 结构体。 |
Data 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
orgId |
String |
短信渠道所属的组织 ID。 |
tunnelCode |
String |
短信渠道标识符。 |
serviceProvider |
String |
短信供应商来源。 |
name |
StringI18n |
短信渠道名称。国际化名称表示方法 >> |
示例¶
请求示例¶
url: https://{apigw-address}/notification-center-service/v2.0/sms/tunnels?action=get&orgId=yourOrgId
method: GET
返回示例¶
{
"code":"0",
"msg":"OK",
"submsg":"",
"data":[
{
"orgId":"yourorgId",
"tunnelCode":"tunnelCode",
"serviceProvider":"SCS",
"name":{
"defaultValue":"SCS",
"i18nValue":{"zh_CN": "SCS", "en_US": "SCS"}
}
}
],
"requestId":""
}