ListSmsMetadata - 获取短信配置详情_云联络中心(Cloud Contact Center)-阿里云帮助中心

使用ListSmsMetadata获取短信配置详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
PageNumber	integer	是	分页序号，范围 1-100。	1
PageSize	integer	是	分页大小，范围 1-100。	100
ScenarioListJson	string	否	场景类型。 SATISFACTION_SURVEY(满意度调查) CONTACT_FLOW_NODE(IVR 流程节点) MISSED_CALL_NOTIFICATION(漏话提醒) FLASH_SMS(阿里通信闪信通知)	["SATISFACTION_SURVEY","CONTACT_FLOW_NODE"]

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	8707EB29-BAED-4302-B999-40BA61877437
Params	array	错误参数列表。
Param	string	错误参数。	无
Data	object	数据。
PageNumber	integer	页码。	1
PageSize	integer	页大小。	100
TotalCount	integer	总记录数。	200
List	array<object>	短信配置列表。
SmsMetadata	object	短信配置。
SmsMetadataId	string	短信配置 ID。	5ffc1c9a-4d3d-4019-*****-73255fb01d1c
TemplateCode	string	模板 CODE。	SMS_468xxxx298
Description	string	配置描述。	漏话短信配置
Scenario	string	场景类型。	MISSED_CALL_NOTIFICATION
AliyunUid	long	阿里云账号 ID。	15772400000****
InstanceId	string	实例 ID。	ccc-test
Name	string	配置名称。	漏话短信提醒
SignName	string	短信签名名称。	云呼叫中心

示例

正常返回示例

JSON格式

{
  "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": "云呼叫中心"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Parameter.Blank	The parameter %s must not be null or empty.	该参数不能为null值。
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.	指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。