DocsICP FilingConsole
官方文档
首页

UpdateConfigItems

更新时间：
复制 MD 格式
产品详情
我的收藏

Use the UpdateConfigItems operation to add or modify configuration items for an instance, such as hiding the caller ID for inbound calls or allowing agents to hang up.

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
ObjectId

string

Yes

The ID of the object to be configured.

ccc-test
ObjectType

string

Yes

The type of the object to be configured.

INSTANCE
ConfigItems

string

Yes

A JSON-formatted string representing an array of configuration items. Each object in the array must contain a name to identify the configuration item and its value. You can use system-defined items (which have fixed names and customizable values, such as agent permissions to hang up or the ring no answer timeout) or create custom items.

Valid values:

  • AllowAudioDownload :

    AllowAudioDownload: Controls whether agents can download recordings. Valid values: 0 (No) and 1 (Yes).

  • RecordingStorageSetting :

    The recording storage configuration for the instance.

  • AllowChooseSignedSkillGroup :

    AllowChooseSignedSkillGroup: Controls whether agents must manually select skill groups before signing in. Valid values: 0 (Agents are automatically signed into all their assigned skill groups) and 1 (Agents manually select which skill groups to sign into).

  • AgentRingingTimeoutSeconds :

    AgentRingingTimeoutSeconds: The duration in seconds before an inbound call is considered a ring no answer. The value must be an integer from 5 to 90.

  • ShowCalledID :

    Controls how the caller ID is displayed to the agent for inbound calls. Valid values: -1 (Hide the entire number), 0 (Hide part of the number), and 1 (Show the full number).

  • ShowCalleeID :

    Controls how the callee's number is displayed to the agent for outbound calls. Valid values: -1 (Hide the entire number), 0 (Hide part of the number), and 1 (Show the full number).

  • AllowHangup :

    AllowHangup: Controls whether an agent can hang up on an inbound call. Valid values: 0 (No) and 1 (Yes).

  • AutoAnswerCall :

    Configures how agents answer inbound calls. Valid values: -1 (Manual answer) and n (Automatically answer after ringing for n seconds).

[{"name":"ShowCalledID","value":"-1"},{"name":"ShowCalleeID","value":"1"},{"name":"AllowHangup","value":"0"},{"name":"AutoAnswerCall","value":"-1"},{"name":"AllowAudioDownload","value":"1"},{"name":"AllowChooseSignedSkillGroup","value":"1"}]

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.

8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75
Params

array

string

The response parameters.

无

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ]
}

Error codes

HTTP status code

Error code

Error message

Description
400 Parameter.Enumeration The parameter %s must be one of the value of enumeration %s.
404 NotExists.InstanceId The specified instance %s does not exist.
404 NotExists.UserId The user %s does not exist in instance %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.