添加备份文件

添加并配置备份文件。

请求 URL

POST {base_url}/{api_path}/backup/create?access_token={access_token}

请求参数

参数 是否必填 类型 说明
file_name 是 String 备份文件的名称。
memo 否 String 备份文件的备注。
storage_location 否 Integer

存储该备份文件的存储设备 ID。

注： 可使用 查询存储设备列表 接口查询存储设备 ID。
sound_backup 否 Integer

是否备份自定义提示音。

取值范围：

  • 0：禁用
  • 1：启用
cdr_backup 否 Integer 是否备份通话记录。

取值范围：

  • 0：禁用
  • 1：启用
contact_backup 否 Integer 是否备份企业联系人和企业联系人群组相关设置。

取值范围：

  • 0：禁用
  • 1：启用
message_backup 否 Integer 是否备份外部聊天的聊天记录。

取值范围：

  • 0：禁用
  • 1：启用

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
file_name String 备份文件的名称。

示例

请求示例

POST /openapi/v1.0/backup/create?access_token=C6cqRHSqYPNMrTDyF2BLyVUCKkpS6rTG HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "file_name": "Backup-X.18.0.89", 
    "memo": "test",
    "storage_location": 1,
    "sound_backup": 1,
    "cdr_backup": 1,
    "contact_backup": 1,
    "message_backup": 1
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file_name": "Backup-X.18.0.89-local.bak"
}