# 新增文件服务器接口
#### 场景描述
该接口为新增文件服务器接口，便于导入服务器外呼文件时的前置条件。
#### 使用说明
- 前提条件
  - 有对应的Ak/Sk鉴权权限。
  
  - 已经申请了开发者账号。
   
- 注意事项
  - 接收请求后，需服务端返回200的响应，其他响应均认为回写失败；
  
  - 同一个租间下，服务器信息不允许相同
  
  - 用户名长度最大为30，不允许出现特殊字符 \`\~!@#$%\^\&\*()+=\|{}'":;\<\>/?.\\\[\\\]！￥...（）---【】'；：" "',、？
  
  - 密码长度为8-80之间
  
  - 当前仅支持SFTP文件服务器
   
 
#### 接口方法
该接口仅支持POST方法。
#### 接口URL
https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/addServer
其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。
表1URL中携带的参数说明 
| 序号 | 参数名   | 参数类型 | 是否必选 | 说明                                                                                                                                        |
|:---|:---|:---|:---|:---|
| 1  | vdnId | int  | True | 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 |
   
#### 请求说明
表2请求消息头参数 
| 序号 | 名称            | 参数类型   | 是否必选  | 说明                                                                                                                            |
|:---|:---|:---|:---|:---|
| 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)。 |
| 3  | locale        | String | False | i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。                                                              |
   
表3请求消息体参数说明 
| 序号 | 参数名        | 参数类型       | 是否必选 | 说明               |
|:---|:---|:---|:---|:---|
| 1  | serverInfo | JsonObject | True | 文件服务器信息。         |
| 2  | userName   | String     | True | 用户名              |
| 3  | serverPwd  | String     | True | 服务密码，明文传递，后台密文保存 |
   
表4serverInfo参数说明 
| 序号 | 参数名      | 参数类型   | 是否必选 | 说明                      |
|:---|:---|:---|:---|:---|
| 1  | ip       | String | True | 文件服务器IP。客户自备ip地址。       |
| 2  | port     | String | True | port                    |
| 3  | filePath | String | True | 文件服务器默认路径 示例：/home/sftp |
   
#### 响应说明
表5消息体参数说明 
| 序号 | 参数名        | 参数类型   | 说明                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| 1  | resultCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表5](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0790.html#ZH-CN_TOPIC_0000002513233761__zh-cn_topic_0000002510109817_zh-cn_topic_0313705102_table3576145771717)。 |
| 2  | resultDesc | String | 描述。                                                                                                                                                                                                                                                                                                           |
| 3  | serverId   | String | 生成文件服务ID 全局唯一                                                                                                                                                                                                                                                                                                 |
| 4  | returnCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表6]                                                        |
| 5  | returnDesc | String | 描述。                                                                                                                                                                                                                                                                                                           |
   
#### 触发事件
无
#### 错误结果码
 表6错误原因码说明 
| 序号 | 错误码      | 说明                       |
|:---|:---|:---|
| 1  | 0200001  | 参数异常，异常详情在resultDesc中描述。 |
| 2  | 0200033  | 外呼数据不存在。                 |
| 3  | 0200034  | 子状态与业务结果不匹配。             |
| 4  | 02000005 | 参数长度超过指定范围               |
| 5  | 02000001 | 参数值为空                    |
| 6  | 02000002 | 参数包含非法字符                 |
| 7  | 02000003 | 参数长度不能大于规定长度             |
| 8  | 02000004 | 参数长度不能小于规定长度             |
| 9  | 02000005 | 参数长度需要介于规定长度之间           |
| 10 | 02000006 | 参数值类型不正确                 |
| 11 | 02000007 | 参数值大小不正确                 |
| 12 | 02000008 | 参数转换异常，请检查请求参数           |
| 13 | 02000009 | 参数组合不正确，请检查请求参数          |
| 14 | 02000010 | hour和minute必须同时存在        |
   
#### 报文样例
- 该接口的请求消息体举例如下：
  ```
  {
      "userName":"zhangsan",
      "serverInfo":{
          "ip":"1.2.3.4",
          "port":"22",
          "filePath":"/home/sftp"
      },
      "serverPwd":"******"
  }
  ```
  
- 该接口的响应消息体举例如下：
  ```
  {
  "resultCode": "02000005",
  "description": " 参数长度需要介于8和80之间"
  }
  ```