ChangeVisibility-阿里云帮助中心

Changes an agent's status to invisible. This is equivalent to the outbound-only mode.

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 Connect Center instance.	szpczf
UserId	string	No	The ID of the agent.	sam@szpczf
Invisible	boolean	No	Specifies whether to set the agent's status to invisible.	true

Response elements

Element	Type	Description	Example
	object	The returned data.
Code	string	The response code.	OK
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	Internal service issue. Detail:.
RequestId	string	The request ID.	24BE19E8-BF7D-4992-A35E-15EBA874F2E5
Params	array	The response parameters.
	string	A response parameter.	无
Data	object	The returned data.
Extension	string	The agent's extension number.	8001****
WorkMode	string	The work mode.	ON_SITE
DeviceId	string	The device ID. This can be the ID of a browser-based WebRTC softphone or a physical phone. Only one device can be registered at a time.	Yealink SIP-T23G 44.84.203.6
JobId	string	The call ID. If populated, this field indicates that the agent is in a call.	job-330557290544431104
UserId	string	The agent ID.	sam@szpczf
BreakCode	string	The break code.	会议
InstanceId	string	The instance ID.	szpczf
OutboundScenario	boolean	Indicates whether the agent is in outbound-only mode.	False
UserState	string	The agent state.	Ready
SignedSkillGroupIdList	array	The IDs of the skill groups to which the agent is signed in.
	string	The ID of a skill group.	skillgroup@ccc-test

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "Internal service issue. Detail:.",
  "RequestId": "24BE19E8-BF7D-4992-A35E-15EBA874F2E5",
  "Params": [
    "无"
  ],
  "Data": {
    "Extension": "8001****",
    "WorkMode": "ON_SITE",
    "DeviceId": "Yealink SIP-T23G 44.84.203.6",
    "JobId": "job-330557290544431104",
    "UserId": "sam@szpczf",
    "BreakCode": "会议",
    "InstanceId": "szpczf",
    "OutboundScenario": true,
    "UserState": "Ready",
    "SignedSkillGroupIdList": [
      "skillgroup@ccc-test"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidOperation.ChannelState	The operation is not allowed. Channel stats (%s) does not meet expectations (%s).
400	InvalidOperation.UserState	The operation is not allowed. User state (%s) does not meet expectations (%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.