AssignUsers

更新时间:
复制 MD 格式

Call AssignUsers to import one or more RAM users into a specified instance. After the import, the RAM users become agents in the instance.

Note

This API has been deprecated. We recommend migrating to CCC(2020-07-01) - ImportRamUsers for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

Accounts with RAM permissions can view all RAM users under an Alibaba Cloud account in the RAM console. You can access the RAM console at https://ram.console.aliyun.com/users.

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

RoleId

string

Yes

The ID of the role to assign to the users in the instance. After the RAM users are imported, they are assigned this role. Valid roles are Administrator, Teamleader, and Agent.

Agent@ccc-test

SkillLevelList

string

No

A JSON array of skill objects, provided as a string. Each object specifies a skillGroupId and a skillLevel from 1 to 10. A lower skillLevel value indicates higher proficiency and greater call-handling capacity.

[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]

RamIdList

string

Yes

A JSON array of RAM user IDs to import, formatted as a string.

["28036411123456****","29234301123456****"]

WorkMode

string

Yes

The work mode for the agents.

Valid values:

  • ON_SITE :

    on-site mode

  • OFF_SITE :

    off-site mode

  • OFFICE_PHONE :

    office phone mode

ON_SITE

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

Data

string

The returned data, which is the same as the workflow ID.

1ca2b084-6f0a-454b-9851-29768a9a5832

RequestId

string

The request ID.

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75

Code

string

The response code.

OK

WorkflowId

string

The workflow ID.

1ca2b084-6f0a-454b-9851-29768a9a5832

Message

string

The response message.

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": "1ca2b084-6f0a-454b-9851-29768a9a5832",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Code": "OK",
  "WorkflowId": "1ca2b084-6f0a-454b-9851-29768a9a5832",
  "Message": "无"
}

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.
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.
400 Parameter.Blank The parameter %s may not be null or blank.
400 Parameter.Empty The parameter %s may not be null or empty.
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.