调用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 |
| AvatarUrl |
string |
否 |
坐席头像地址。 |
http://abc.com/sam.jpg |
| Nickname |
string |
否 |
座席昵称。 |
老王 |
| NeedEmailNotification |
string |
否 |
是否需要邮件通知。
|
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
OK |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
响应信息。 |
无 |
| RequestId |
string |
请求 ID。 |
BA03159C-E808-4FF1-B27E-A61B6E888D7F |
| Data |
object |
数据。 |
|
| DisplayName |
string |
坐席展示名。 |
坐席小王 |
| Extension |
string |
坐席分机号。 |
8032**** |
|
string |
邮箱。 |
username@example.com |
|
| LoginName |
string |
坐席登录名。 |
agent |
| WorkMode |
string |
工作模式。 枚举值:
|
ON_SITE |
| Mobile |
string |
坐席的个人电话号码。 |
1382114**** |
| UserId |
string |
坐席 ID。 |
agent@ccc-test |
| AvatarUrl |
string |
坐席头像地址。 |
http://abc.com/sam.jpg |
| Nickname |
string |
座席昵称。 |
老王。 |
| Params |
array |
响应参数。 |
|
|
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 云联络中心实例下已存在指定的用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。