调用CreateUser在指定实例下创建一个新的坐席。
接口说明
创建坐席实际上就是创建一个RAM子账户,云呼叫中心的坐席与RAM子账户是相互映射的,所以创建时传入的参数就和创建RAM账户时类似,比如:LoginName就是RAM账号的登录名,Email就是创建RAM账号时预留的邮箱,该邮箱会接收到带有RAM账户初始登录密码的邮件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例ID。 | ccc-test |
LoginName | string | 是 | 坐席登录名,长度为4-64个字符,可包含英文大小写字母、数字、英文句点“.”、下划线“_”或短划线“-”。 | agent |
DisplayName | string | 是 | 坐席展示名,长度为1-128个字符。 | 坐席小王 |
Mobile | string | 否 | 坐席的个人电话号码,该号码在场外模式下会用到,坐席可以使用该号码进行场外模式接听。 | 1382114**** |
string | 是 | 坐席邮箱地址,坐席创建成功后会发送邮件到该邮箱,邮件中包含呼叫中心登录地址,以及RAM账户的用户名和密码,请妥善保管。 | username@example.com | |
WorkMode | string | 是 | 工作模式。 枚举值:
| ON_SITE |
RoleId | string | 是 | 角色ID,格式为:角色@实例ID,包含三种角色:Admin(管理员)、Manager(技能组组长)、Agent(坐席)。 | Agent@ccc-test |
SkillLevelList | string | 否 | 技能组的技能等级列表,格式为JSON数组的字符串,数组元素最大为100个,数组元素是一个对象,包含两个字段:skillGroupId和skillLevel,skillGroupId填写要添加的技能组ID,skillLevel填写要添加的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。 | [{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}] |
ResetPassword | boolean | 否 | 首次登录时是否需要重置密码,如果为true,则在首次登录RAM账户时会提示重置密码,否则不提示。默认为false。 | false |
DisplayId | string | 否 | 坐席的工号,客户可根据需要自行设置。 | 1001 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
"Data": {
"DisplayName": "坐席小王",
"Extension": "8032****",
"Email": "username@example.com",
"LoginName": "agent",
"WorkMode": "ON_SITE",
"Mobile": "1382114****",
"UserId": "agent@ccc-test"
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Parameter.Blank | The parameter %s may not be null or blank. | 该参数不能为null或含有空白符的字符串。 |
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. | 参数必须小于或等于系统规定的最大值。 |
403 | Permission.StsToken | You have no permission to access sts token %s. | 您无权访问STS Token。 |
404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
404 | NotExists.RoleId | Role %s does not exist. | 指定的角色不存在。 |
409 | AlreadyExists.User | User %s already exists in instance %s. | 呼叫中心实例下已存在指定的用户。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2021-12-21 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
|