# 座席加入用户组
#### 场景描述
用于将座席加入CMS上的用户组。
#### 接口方法
设置成"POST"。该接口仅支持POST方法，不支持PUT、GET和DELTE等方法。
#### 请求URL
https://ip:port/rest/cmsapp/v1/openapi/qcrelationconf/joinusergroup
其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。
非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。
#### 请求说明
表1请求头参数 
| 序号 | 名称            | 参数类型   | 是否必选 | 说明                                                                                                                            |
|:---|:---|:---|:---|:---|
| 1  | Content-Type  | String | True | 固定填 application/json;charset=UTF-8。                                                                                           |
| 2  | Authorization | String | True | 生成方式参见[C2 监控/系统外呼/话单/知识库类接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0003.html#ZH-CN_TOPIC_0000002481273406)。 |
   
表2消息体参数说明 
| 参数名       | 数据类型   | 选取原则  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| ccId      | int    | False | 呼叫中心编号，取值范围为1\~65535 - 独立部署环境，默认值为系统管理员登录AICC系统后，通过"配置中心 \> 系统管理 \> 参数配置"查看"默认呼叫中心标识"的值。   |
| vdnId     | int    | True  | 虚拟呼叫中心编号，取值范围为1\~5000。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| agentId   | int    | True  | 加入用户组的座席工号，取值范围为0\~999999。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| groupId   | String | False | 加入的用户组编号 **不携带：先根据groupName参数指定的名称创建用户组，然后把座席加入新创建的组（如果座席此前已经在其它用户组，则会自动从其它组中移除）** **携带：忽略groupName参数，将座席加入groupId对应的用户组（如果座席此前已经在其它用户组，则会自动从其它组中移除）**                                                                                                                                                         |
| groupName | string | False | 加入的用户组名称（不允许非法字符，长度不超过100）                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| groupType | int    | False | 用户组类型，默认为2，可选值为2和3，其中2代表话务组，3代表质检组，其他为非法入参                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 响应消息
表3消息体参数说明 
| 参数名     | 数据类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| message | string | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| retcode | string | 错误码。取值如下： 0：成功 非0：失败 错误码的参数说明请参见[表5]。 |
| result  | object | 加入成功后，返回结果信息的对象。该对象的参数说明请参见[表4]。                                                                                                                                                                                                                                                                                                                              |
   
 表4result对象参数说明 
| 参数名       | 数据类型   | 说明                                                                                                                                     |
|:---|:---|:---|
| groupId   | string | 座席加入的用户组编号                                                                                                                             |
| groupName | string | 座席加入的用户组名称 （不允许非法字符，长度不超过20） |
   
 表5错误结束码说明 
| 错误结束码   | 说明                  | 处理意见                         |
|:---|:---|:---|
| 300-010 | VDN用户ccid和vdnid匹配错误 | 检查输入参数是否正确。                  |
| 300-016 | VDN下不存在此座席          | 检查VDN下是否存在该座席，如果存在建议1分钟后重试一次 |
| 300-017 | 质检用户组名已存在           | 更改待创建的质检用户组名称                |
| 300-018 | 质检用户组名为空            | 检查是否携带groupName参数或者其值是否为空    |
| 300-019 | 待加入的质检用户组不存在        | 检查groupId对应的质检用户组是否存在        |
| 1       | 参数不合法或系统报错          | 检查输入参数是否正确。                  |
   
#### 样例报文
- 请求头：
  ```
  Content-Type: application/json;charset=UTF-8
  Authorization: ******************
  ```
  
- 请求参数：
  ```
  {
      "ccId":1,
      "vdnId":4,
      "agentId":667,
      "groupId":"159282396714302232563636876268",
      "groupName":"话务组",
      "groupType":""
  }
  ```
  

- 响应参数：
  ```
  {
      "result": {
          "groupName": "话务组A",
          "groupId": "161960203515344228641565404173"
      },
      "message": "success",
      "retcode": "0"
  }
  ```