Search SMS Signature¶
Query the SMS signatures within this OU and the system OU. Only return signatures with the status “approved”.
Request Format¶
GET https://{apigw-address}/notification-center-service/v2.0/sms/signatures
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 signature. |
signatureName |
String |
The SMS signature. |
signatureCode |
String |
The SMS signature ID. |
tunnelCode |
String |
The channel ID of the SMS signature. |
description |
String |
The description of the SMS signature. |
Samples¶
Request Sample¶
url: https://{apigw-address}/notification-center-service/v2.0/sms/signatures?action=get&orgId=yourOrgId
method: GET
Return Sample¶
{
"code":"0",
"msg":"OK",
"submsg":"",
"data":[
{
"orgId":"yourorgId",
"signatureName":"signature1",
"signatureCode":"signatureId1",
"tunnelCode":"channelId1",
"description":" "
},
{
"orgId":"yourorgId",
"signatureName":"signature2",
"signatureCode":"signatureId2",
"tunnelCode":"channelId2",
"description":" "
}
],
"requestId":""
}