官文相关接口
更新时间：2023-11-24
获取官文列表
接口描述
本接口用于获取官文列表
请求结构
Plain Text
1> POST https://tms-api.baidu.com/v1/tms/openapi/document/list
2> Authorization: authorization string
3> Host: tms-api.baidu.com
4> x-bce-console-rpc-id: e69c8fff-166b-4c82-87c1-7aa3ba309d5c
5> x-bce-date: 2020-04-27T02:43:18Z
6{
7 "pageNo" : 1,
8 "pageSize" : 10,
9 "trademarkId" : "",
10 "receiveStartTimestamp" : "",
11 "receiveEndTimestamp" : ""
12}| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | integer | 否 | BODY | 页码，默认为 1 |
| pageSize | integer | 否 | BODY | 页大小，默认为 10 |
| trademarkId | string | 否 | BODY | 商标id 用于筛选官文 |
| receiveStartTimestamp | string | 否 | BODY | 上传时间 开始毫秒时间戳，如 "2023-11-11 11:11:11" |
| receiveEndTimestamp | string | 否 | BODY | 上传时间 结束毫秒时间戳 |
响应结果
Plain Text
1< Cache-Control: no-cache
2< Content-Length: 0
3< Date: Mon, 27 Apr 2020 11:48:34 GMT
4< Server: BWS
5< x-bce-request-id: de3f0c3e-86f6-43e7-b1bd-35a837f4b84f
6{
7 "pageNo": 1,
8 "pageSize": 10,
9 "documents": [
10 {
11 "name" : "商标注册回执",
12 "trademarkId" : "TTR-2GEHBFmeGzL",
13 "documentId" : "TDO-ra7aCRwgFeQ",
14 "documentUrl" : "https://bj.bcebos.com/v1/tms-custom/xxx",
15 "type" : 1,
16 "status" : "ELECTRONIC",
17 "associationDocumentId" : "",
18 "receiveTime" : "2023-11-11 00:00:00",
19 "createTime" : "2023-11-11 00:00:00"
20 }
21 ],
22 "totalCount": 1
23}| 参数名称 | 类型 | 描述 |
|---|---|---|
| pageNo | integer | 页码 |
| pageSize | integer | 页大小 |
| documents | array | 文件列表 |
| → name | string | 文件名称 |
| → trademarkId | string | 商标ID |
| → documentId | string | 文件唯一id |
| → documentUrl | string | 文件下载链接，30分钟有效时间 |
| → type | integer | 文件类型（1-电子，2-纸质） |
| → status | string | 文件索取状态，可参考DocumentTaskStatus |
| → associationDocumentId | string | 纸质文件关联的电子文件id（仅当type为2时才有） |
| → receiveTime | string | 文件上传UTC时间 |
| → createTime | string | 文件创建时间 |
| totalCount | integer | 总数量 |
根据官文id获取官文下载链接
接口描述
本接口用于获取官文列表
请求结构
Plain Text
1> POST https://tms-api.baidu.com/v1/tms/openapi/document/get
2> Authorization: authorization string
3> Host: tms-api.baidu.com
4> x-bce-console-rpc-id: e69c8fff-166b-4c82-87c1-7aa3ba309d5c
5> x-bce-date: 2020-04-27T02:43:18Z
6{
7 "documentId" : "TDO-ra7aCRwgFeQ"
8}| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| documentId | string | 是 | BODY | 官文ID |
响应结果
Plain Text
1< Cache-Control: no-cache
2< Content-Length: 0
3< Date: Mon, 27 Apr 2020 11:48:34 GMT
4< Server: BWS
5< x-bce-request-id: de3f0c3e-86f6-43e7-b1bd-35a837f4b84f
6{
7 "documentUrl" : "https://bj.bcebos.com/v1/tms-custom/xxx"
8}| 参数名称 | 类型 | 描述 |
|---|---|---|
| documentUrl | string | 文件下载链接，30分钟有效时间 |
官文索取
接口描述
本接口用于获取官文列表
请求结构
Plain Text
1> POST https://tms-api.baidu.com/v1/tms/openapi/document/claim
2> Authorization: authorization string
3> Host: tms-api.baidu.com
4> x-bce-console-rpc-id: e69c8fff-166b-4c82-87c1-7aa3ba309d5c
5> x-bce-date: 2020-04-27T02:43:18Z
6{
7 "name" : "王小虎",
8 "address" : "北京北京市海淀区上地十街10号百度大厦三层",
9 "contactNumber" : "010-59928888",
10 "documentIds" : [
11 "TDO-ra7aCRwgFeQ",
12 "TDO-d3dfdCrlJDf"
13 ],
14 "remark" : "放家门口，谢谢"
15}| 参数名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | string | 是 | 姓名 |
| address | string | 是 | 地址 |
| contactNumber | string | 是 | 联系电话 |
| documentIds | array | 是 | 索取文件id列表 |
| remark | string | 否 | 备注 |
响应结果
Plain Text
1< Cache-Control: no-cache
2< Content-Length: 0
3< Date: Mon, 27 Apr 2020 11:48:34 GMT
4< Server: BWS
5< x-bce-request-id: de3f0c3e-86f6-43e7-b1bd-35a837f4b84f
6{
7 "result" : true
8}| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | boolean | 操作结果：true-成功 false-失败 |