删除A号码报备文件 - DeleteReportFiles
接口功能
企业租户通过该接口删除号码所属人现场照片报备文件。
使用说明
前提条件:
限制约束:
- 只有未在使用中的A号码报备文件可以删除。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限管理。
URI
DELETE /v1/privatenumber/a-number/files
请求参数
| 参数名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| Content-Type | 否 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 固定填写为application/json;charset=UTF-8。 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 说明:
|
| 参数名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| files | 是 | String[] | 报备文件名称,最大支持10个文件。 |
响应参数
| 参数名称 | 是否必须 | 参数类型 | 说明 |
|---|---|---|---|
| result | 否 | String | 值为"Delete Successful.",响应码为200时携带。 |
| error_code | 否 | String | 请求异常时返回的错误码。 |
| error_msg | 否 | String | 请求异常时返回的错误描述。 |
结果码说明
| 响应码 | 返回值 | 英文描述 | 中文描述 | 处理方法 |
|---|---|---|---|---|
| 400 | PPT.0002 | Invalid Parameter. | 参数错误。 | 请检查请求参数填写是否正确。 |
| PPT.0009 | Order does not exist. | 服务未开通完成。 | 点击开通隐私号业务。 | |
| PPT.00011 | Resource not exist. | 报备文件不存在。 | 请检查报备文件名称(file_name)是否正确。 | |
| PPT.00017 | Voice have been used. | 报备文件已使用。 | 请解除报备文件使用状态后重试。 | |
| PPT.00032 | The operation is forbidden because tenant has been frozen. | 租户已被冻结,不能进行该操作。 | 请联系管理员处理。 | |
| PPT.00033 | The operation is forbidden because tenant has been restricted. | 租户受限,不允许操作。 | 请联系管理员处理。 | |
| PPT.00039 | Operation failed. | 操作失败。 | 请联系管理员处理。 |
接口示例
- 请求示例
DELETE /v1/privatenumber/a-number/files { "files": ["xxx.jpg"] } - 响应示例
成功: { "result": "Delete Successful." } 失败: { "error_code":"PPT.00011", "error_msg":"Resource not exist" }