有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: bma.tencentcloudapi.com 。

新建作品

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCRWork。
Version String 公共参数,本接口取值:2021-06-24。
Region String 公共参数,本接口不需要传递此参数。
WorkName String 作品名称
示例值:西游记
WorkCategory String 作品分类
示例值:010101
WorkType String 作品内容类型
示例值:01
WorkSign String 作品标签
示例值:孙悟空、猪八戒
WorkPic String 字段已废弃,作品图片
示例值:https://test.com
WorkDesc String 作品描述
示例值:经典四大名著之一
IsOriginal String 是否原创:0-否 1-是
示例值:1
IsRelease String 是否发布:0-未发布 1-已发布
示例值:1
ProducerID Integer 字段已废弃,著作权人ID
示例值:0
ProduceTime String 创作时间
示例值:2022-01-01 00:00:00
SampleContentURL String 字段已废弃
示例值:https://test.com
SampleDownloadURL String 作品下载地址
示例值:https://test.com
SamplePublicURL String 作品在线地址
示例值:https://test.com
GrantType String 字段已废弃,授予类型
示例值:1
IsMonitor String 是否监测:0-不监测 1-监测
示例值:1
IsCert String 是否存证:0-不存证 2-存证 注意是2
示例值:1
CertUrl String 存证回调地址
示例值:https://test.com
MonitorUrl String 监测回调地址
示例值:https://test.com
ProduceType String 字段已废弃,创作性质
示例值:原创
WhiteLists.N Array of String 白名单列表
示例值:["qq.com","baidu.com"]
WorkId Integer 作品ID,忽略该字段
示例值:0
ProducerName String 著作权人姓名
示例值:张三
Nickname String 作者,小说类型必填
示例值:张三
Authorization String 授权书下载地址
示例值:https://test.com
AuthorizationStartTime String 授权书开始时间
示例值:2022-01-01 00:00:00
AuthorizationEndTime String 授权书结束时间
示例值:2025-01-01 00:00:00
ContentType String 内容格式,支持txt、doc等,表示Content的具体格式
示例值:txt
Content String 文件内容base64编码,该字段仅在无法提供下载链接时使用
示例值:xxx
MonitorEndTime String 监测结束时间
示例值:2025-01-01 00:00:00
ApplierId String 申请人ID,用于存证和取证
示例值:123456
ApplierName String 申请人姓名,用于存证和取证
示例值:张三
IsAutoRenew String 是否自动续期

3. 输出参数

参数名称 类型 描述
WorkId Integer 作品ID,一个作品对应唯一的workid
示例值:123
EvidenceId Integer 存证ID,忽略该字段
示例值:123
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建作品

新建作品

输入示例

POST / HTTP/1.1
Host: bma.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCRWork
<公共请求参数>

{
    "WhiteLists": [
        "xx"
    ],
    "IsMonitor": "xx",
    "MonitorUrl": "xx",
    "IsOriginal": "xx",
    "SampleDownloadURL": "xx",
    "ProducerID": 0,
    "IsRelease": "xx",
    "WorkCategory": "xx",
    "WorkDesc": "xx",
    "WorkName": "xx",
    "SamplePublicURL": "xx",
    "ProduceTime": "xx",
    "CertUrl": "xx",
    "ProduceType": "xx",
    "IsCert": "xx",
    "SampleContentURL": "xx",
    "GrantType": "xx",
    "WorkSign": "xx",
    "WorkPic": "xx",
    "WorkType": "xx",
    "ProducerName": "xx"
}

输出示例

{
    "Response": {
        "EvidenceId": 0,
        "RequestId": "xx",
        "WorkId": 0
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidAction 接口不存在。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
NoSuchVersion 接口版本不存在。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。