ListSmsMetadata-阿里云帮助中心

Queries the details of SMS configurations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	ccc-test
PageNumber	integer	Yes	The page number. The value ranges from 1 to 100.	1
PageSize	integer	Yes	The number of entries per page. The value ranges from 1 to 100.	100
ScenarioListJson	string	No	The type of the scenario. Valid values: SATISFACTION_SURVEY: satisfaction survey CONTACT_FLOW_NODE: Interactive Voice Response (IVR) flow node MISSED_CALL_NOTIFICATION: missed call notification FLASH_SMS: Alibaba Cloud flash SMS notification	["SATISFACTION_SURVEY","CONTACT_FLOW_NODE"]

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	OK
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	无
RequestId	string	The request ID.	8707EB29-BAED-4302-B999-40BA61877437
Params	array	The list of incorrect parameters.
	string	The incorrect parameter.	无
Data	object	The data.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
TotalCount	integer	The total number of records.	200
List	array<object>	The list of SMS configurations.
	object	The SMS configuration.
SmsMetadataId	string	The ID of the SMS configuration.	5ffc1c9a-4d3d-4019-*****-73255fb01d1c
TemplateCode	string	The template code.	SMS_468xxxx298
Description	string	The description of the configuration.	漏话短信配置
Scenario	string	The scenario type.	MISSED_CALL_NOTIFICATION
AliyunUid	integer	The Alibaba Cloud account ID.	15772400000****
InstanceId	string	The instance ID.	ccc-test
Name	string	The name of the configuration.	漏话短信提醒
SignName	string	The name of the SMS signature.	云呼叫中心

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "8707EB29-BAED-4302-B999-40BA61877437",
  "Params": [
    "无"
  ],
  "Data": {
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 200,
    "List": [
      {
        "SmsMetadataId": "5ffc1c9a-4d3d-4019-*****-73255fb01d1c",
        "TemplateCode": "SMS_468xxxx298",
        "Description": "漏话短信配置",
        "Scenario": "MISSED_CALL_NOTIFICATION",
        "AliyunUid": 0,
        "InstanceId": "ccc-test",
        "Name": "漏话短信提醒",
        "SignName": "云呼叫中心"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Blank	The parameter %s must not be null or empty.
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.