文档

CreateUser - 创建坐席

更新时间:

调用CreateUser在指定实例下创建一个新的坐席。

接口说明

创建坐席实际上就是创建一个 RAM 子账户,云呼叫中心的坐席与 RAM 子账户是相互映射的,所以创建时传入的参数就和创建 RAM 账户时类似,比如:LoginName 就是 RAM 账号的登录名,Email 就是创建 RAM 账号时预留的邮箱,该邮箱会接收到带有 RAM 账户初始登录密码的邮件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

ccc-test
LoginNamestring

坐席登录名,长度为 4-64 个字符,可包含英文大小写字母、数字、英文句点“.”、下划线“_”或短划线“-”。

agent
DisplayNamestring

坐席展示名,长度为 1-128 个字符。

坐席小王
Mobilestring

坐席的个人电话号码,该号码在场外模式下会用到,坐席可以使用该号码进行场外模式接听。

1382114****
Emailstring

坐席邮箱地址,坐席创建成功后会发送邮件到该邮箱,邮件中包含呼叫中心登录地址,以及 RAM 账户的用户名和密码,请妥善保管。

username@example.com
WorkModestring

工作模式。

枚举值:
  • ON_SITE场内模式
  • OFF_SITE场外模式
  • OFFICE_PHONE办公电话模式
ON_SITE
RoleIdstring

角色 ID,格式为:角色@实例 ID,包含三种角色:Admin(管理员)、Manager(技能组组长)、Agent(坐席)。

Agent@ccc-test
SkillLevelListstring

技能组的技能等级列表,格式为 JSON 数组的字符串,数组元素最大为 100 个,数组元素是一个对象,包含两个字段:skillGroupId 和 skillLevel,skillGroupId 填写要添加的技能组 ID,skillLevel 填写要添加的技能等级,取值范围 1-10,值越小,业务能力越强,单位时间内能处理更多的通话。

[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]
ResetPasswordboolean

首次登录时是否需要重置密码,如果为 true,则在首次登录 RAM 账户时会提示重置密码,否则不提示。默认为 false。

false
DisplayIdstring

坐席的工号,客户可根据需要自行设置。

1001
AvatarUrlstring

坐席头像地址。

http://abc.com/sam.jpg
Nicknamestring

座席昵称。

老王

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

BA03159C-E808-4FF1-B27E-A61B6E888D7F
Dataobject

数据。

DisplayNamestring

坐席展示名。

坐席小王
Extensionstring

坐席分机号。

8032****
Emailstring

邮箱。

username@example.com
LoginNamestring

坐席登录名。

agent
WorkModestring

工作模式。

枚举值:
  • ON_SITE场内模式
  • OFF_SITE场外模式
  • OFFICE_PHONE办公电话模式
ON_SITE
Mobilestring

坐席的个人电话号码。

1382114****
UserIdstring

坐席 ID。

agent@ccc-test
AvatarUrlstring

坐席头像地址。

http://abc.com/sam.jpg
Nicknamestring

座席昵称。

老王。
Paramsarray

响应参数。

string

响应参数。

示例

正常返回示例

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",
    "AvatarUrl": "http://abc.com/sam.jpg",
    "Nickname": "老王。"
  },
  "Params": [
    "无"
  ]
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
400Parameter.EnumerationThe parameter %s must be one of the value of enumeration %s.该参数必须为系统限定的枚举值之一。
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
403Permission.StsTokenYou have no permission to access sts token %s.您无权访问STS Token。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.RoleIdRole %s does not exist.指定的角色不存在。
409AlreadyExists.UserUser %s already exists in instance %s.呼叫中心实例下已存在指定的用户。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
2023-11-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
入参OpenAPI 入参发生变更
    新增入参:AvatarUrl
    新增入参:Nickname
出参OpenAPI 返回结构发生变更
2021-12-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
入参OpenAPI 入参发生变更
    新增入参:DisplayId