Search SMS Channel¶

Query the SMS channels created within the OU and the system OU.

This API is only available if 2.4 Cumulative Update 3 has been applied to your environment.

Request Format¶

GET https://{apigw-address}/notification-center-service/v2.0/sms/tunnels

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	The OU ID. How to get orgId >>

Response Parameters¶

Name	Data Type	Description
data	Data Struct	For more information about Data Struct, see Data Struct.

Data Struct¶

Name	Data Type	Description
orgId	String	The OU ID of the SMS channel.
tunnelCode	String	The SMS channel ID.
serviceProvider	String	The service supplier of the SMS channel.
name	StringI18n	The SMS channel name. Internationalized name representation >>

Samples¶

Request Sample¶

url: https://{apigw-address}/notification-center-service/v2.0/sms/tunnels?action=get&orgId=yourOrgId
method: GET

Return Sample¶

{
    "code":"0",
    "msg":"OK",
    "submsg":"",
    "data":[
        {
            "orgId":"yourorgId",
            "tunnelCode":"tunnelCode",
            "serviceProvider":"SCS",
            "name":{
                "defaultValue":"SCS",
                "i18nValue":{"zh_CN": "SCS", "en_US": "SCS"}
            }
        }
    ],
    "requestId":""
}