ListConfigItems-阿里云帮助中心

Retrieves the config items for a specified instance.

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 ID of the instance.	ccc-test
ObjectId	string	Yes	The ID of the object to which the config item applies. This can be the ID of an Alibaba Cloud account, an instance, a skill group, or an agent.	ccc-test
ObjectType	string	Yes	The type of the object. Valid values: INSTANCE : Instance-level configuration. USER : Agent-level configuration. SKILL_GROUP : Skill group-level configuration. ALIYUN_UID : Alibaba Cloud account-level configuration.	INSTANCE

Response elements

Element	Type	Description	Example
	object	The data returned.
Code	string	The response code.	OK
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	无
RequestId	string	The request ID.	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Params	array	The list of dynamic response parameters.
	string	A response parameter.	无
Data	array<object>	The list of config items.
	object	A config item.
ObjectId	string	The ID of the object to which the config item applies.	ccc-test
Value	string	The value of the config item.	100
ObjectType	string	The type of the object to which the config item applies.	INSTANCE
InstanceId	string	The ID of the instance.	ccc-test
Name	string	The name of the config item. A name can be system-defined or custom. You can customize the value of a system-defined item. You can also create custom items with custom names and values. Valid values: AllowAudioDownload : Controls whether an agent can download recordings. Valid values: `0` (No) and `1` (Yes). RecordingStorageSetting : The recording storage configuration for the instance. AllowChooseSignedSkillGroup : Determines if an agent must manually select which skill groups to sign in to. Valid values: `0` (The agent automatically signs in to all assigned skill groups) and `1` (The agent must manually select the skill groups to sign in to). AgentRingingTimeoutSeconds : The time in seconds before an unanswered call to an agent times out. The value must be an integer from 5 to 90. ShowCalledID : Controls the display of the caller ID for incoming calls. Valid values: `-1` (Hide the full number), `0` (Partially hide the number), and `1` (Show the full number). ShowCalleeID : Controls the display of the callee ID for outgoing calls. Valid values: `-1` (Hide the full number), `0` (Partially hide the number), and `1` (Show the full number). AllowHangup : Controls whether an agent can hang up an incoming call. Valid values: `0` (No) and `1` (Yes). AutoAnswerCall : Controls how an agent answers incoming calls. Valid values: `-1` (Manual answer) or `n` (The call is automatically answered after ringing for `n` seconds).	config-item

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": [
    {
      "ObjectId": "ccc-test",
      "Value": "100",
      "ObjectType": "INSTANCE",
      "InstanceId": "ccc-test",
      "Name": "config-item"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Enumeration	The parameter %s must be one of the value of enumeration %s.
400	Parameter.Blank	The parameter %s may not be null or blank.
400	Parameter.Empty	The parameter %s may not be null or empty.
400	Parameter.Null	The parameter %s may not be null.
403	Permission.Unauthorized	You are not authorized to perform this action. %s privileges are required.
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.