ResetAgentState-阿里云帮助中心

Resets the state of a specific agent in a specific 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 Cloud Call Center (CCC) instance.	ccc-test
UserId	string	No	The ID of the agent. This parameter is optional. If omitted, the agent mapped to the current RAM account is reset.	agent@ccc-test
DeviceId	string	No	A string that identifies the device. The value is not processed by the system and can be any string.	device

Response elements

Element	Type	Description	Example
	object	Container for the response data.
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	Reserved for future use.
	string	A reserved parameter.	无
Data	object	The response data.
Extension	string	The agent's extension.	8001****
WorkMode	string	The agent's work mode. Valid values: ON_SITE : On-site mode OFF_SITE : Off-site mode OFFICE_PHONE : Office phone mode	ON_SITE
DeviceId	string	The ID of the registered device, such as a browser-based WebRTC softphone or a physical phone. An agent can register only one device at a time.	ACC-YUNBS-1.0.10-****
JobId	string	The ID of the call. This parameter is returned only if the agent is on a call.	无
UserId	string	The ID of the agent.	agent@ccc-test
BreakCode	string	The reason code for the agent's break. This can be a system-defined or a custom code. System-defined codes include: Valid values: RingingTimeout : The agent did not answer a call before it timed out. RejectCall : The agent rejected an incoming call. Warm-up : A temporary break state that an agent enters after signing in and before becoming Ready.	Warm-up
InstanceId	string	The ID of the instance.	ccc-test
OutboundScenario	boolean	Indicates whether the outbound-only mode is enabled for the agent.	false
UserState	string	The current state of the agent. Valid values: READY : Available WORKING : After call work DIALING : Dialing BREAK : On break OFFLINE : Offline TALKING : On a call RINGING : Ringing	OFFLINE
SignedSkillGroupIdList	array	The IDs of the skill groups that the agent is signed in to.
	string	The ID of the skill group.	skillgroup@ccc-test

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": {
    "Extension": "8001****",
    "WorkMode": "ON_SITE",
    "DeviceId": "ACC-YUNBS-1.0.10-****",
    "JobId": "无",
    "UserId": "agent@ccc-test",
    "BreakCode": "Warm-up",
    "InstanceId": "ccc-test",
    "OutboundScenario": false,
    "UserState": "OFFLINE",
    "SignedSkillGroupIdList": [
      "skillgroup@ccc-test"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.