# 查询素材包详情

```
POST https://qw-openapi-tx.dustess.com/market/v1/material/group/detail?accessToken=
```

**接口限制**

  每分钟请求600次

**请求header**

| 字段         | 值               |
| ------------ | ---------------- |
| Content-Type | application/json |

**请求参数**

| 参数            | 类型     | 描述                                                         | 是否必须 |
| --------------- | -------- | ------------------------------------------------------------ | -------- |
| id              | `String` | 分组id                                                       | 是       |
| uid             | `String` | 员工id（尘锋系统的id）。传后会换取企微员工id，用于 mediaId 获取等 | 否       |
| enhanceMode     | `Int[]`  | 详情增强模式，可多选，1:标签（开启后返回素材、企业文件夹的标签信息） | 否       |
| isContainsDel   | `Bool`   | 是否过滤下线、结束、删除的附件                               | 否       |
| isGetMediaId    | `Bool`   | 是否需要获取 mediaId（欢迎语、群发场景使用，内部接口才会返回） | 否       |
| isCompoudPoster | `Bool`   | 是否启用海报合成                                             | 否       |
| targetId        | `String` | 目标id                                                       | 否       |
| targetType      | `String` | 类型                                                         | 否       |
| shareType       | `Int`    | 分享类型 1: H5 2: 小程序 4: 图片                             | 否       |

**请求示例**

```json
{
    "id": "49b17dab-5488-4392-9370-d7dcc4ca5b76",
    "uid": "10001",
    "enhanceMode": [1],
    "isContainsDel": false,
    "isGetMediaId": true
}
```

**响应结果**

| 参数               | 类型       | 描述                                                         |
| ------------------ | ---------- | ------------------------------------------------------------ |
| success            | `Bool`     | 是否成功                                                     |
| code               | `Int`      | 状态码                                                       |
| msg                | `String`   | 状态信息                                                     |
| traceId            | `String`   | 跟踪id                                                       |
| data               | `Object`   | 响应内容（DetailGroupRes）                                   |
| data.id            | `String`   | 组id                                                         |
| data.content       | `String`   | 文本内容                                                     |
| data.status        | `Int`      | 状态                                                         |
| data.domain        | `String`   | 业务域 mk                                                    |
| data.subDomain     | `String`   | 子业务域 welcome(欢迎语)、SOP、mass(群发)、living(直播)、qrcode(活码) |
| data.txtVars       | `String[]` | 文本变量列表                                                 |
| data.isOpenTxtVars | `Bool`     | 是否开启文本变量                                             |
| data.entitys       | `Object[]` | 组内实体列表（见下）                                         |

**data.entitys 列表项字段**

| 参数          | 类型     | 描述                                                         |
| ------------- | -------- | ------------------------------------------------------------ |
| entityId      | `String` | 实体ID                                                       |
| mediaId       | `String` | mediaId，欢迎语和群发使用，内部接口才会返回                  |
| type          | `String` | 附件类型 activity(活动)、link(链接)、small-program(小程序)、material(内容)、image(图片)、video(视频)、goods(商品)、smart-card(名片)、file(文件)、ordinary(普通素材)、text(文本) |
| shareType     | `Int`    | 分享形式 1: H5 2: 小程序 4: 图片                             |
| sortId        | `Int`    | 排序字段                                                     |
| isDelete      | `Bool`   | 是否已删除，true表示删除                                     |
| statusCode    | `Int`    | 素材状态 0:正常 1:已删除 2:已下架 3:活动已结束 4:未绑定小程序 5:员工名片不存在 |
| link          | `Object` | 链接信息（type=link 时返回）                                 |
| video         | `Object` | 视频信息（type=video 时返回）                                |
| image         | `Object` | 图片信息（type=image 时返回）                                |
| file          | `Object` | 文件信息（type=file 时返回）                                 |
| material      | `Object` | 素材信息（type=material 时返回）                             |
| goods         | `Object` | 商品信息（type=goods 时返回）                                |
| card          | `Object` | 名片信息（type=smart-card 时返回）                           |
| ordinary      | `Object` | 普通素材信息（type=ordinary 时返回）                         |
| activity      | `Object` | 活动信息（type=activity 时返回）                             |
| text          | `Object` | 文本信息（type=text 时返回）                                 |
| shareWithMini | `Object` | 小程序信息（仅 shareType=2 时返回，后端拼接用，前端不要用）  |

**link 文本/链接对象**

| 参数     | 类型     | 描述        |
| -------- | -------- | ----------- |
| title    | `String` | 标题        |
| desc     | `String` | 描述        |
| url      | `String` | 链接地址    |
| name     | `String` | 文件名字    |
| mediaUrl | `String` | 媒体文件url |

**video 视频对象**

| 参数       | 类型     | 描述        |
| ---------- | -------- | ----------- |
| name       | `String` | 文件名字    |
| mediaUrl   | `String` | 媒体文件url |
| cover      | `String` | 视频封面    |
| size       | `Int`    | 文件大小    |
| suffix     | `String` | 文件后缀    |
| firstFrame | `String` | 视频首帧    |

**image / file 对象（媒体文件基础信息）**

| 参数       | 类型     | 描述                                                         |
| ---------- | -------- | ------------------------------------------------------------ |
| name       | `String` | 文件名字                                                     |
| mediaUrl   | `String` | 媒体文件url                                                  |
| type       | `Int`    | 文件类型 1:文档 2:表格 3:pdf 4:txt 5:幻灯片 6:图片 7:音频 8:视频 9:压缩包 |
| size       | `Int`    | 文件大小                                                     |
| suffix     | `String` | 文件后缀                                                     |
| firstFrame | `String` | 视频首帧                                                     |

**material 素材对象**

| 参数               | 类型       | 描述                                                         |
| ------------------ | ---------- | ------------------------------------------------------------ |
| type               | `String`   | 素材类型 form(表单)、H5、article(文章)、poster(海报)、friend(朋友圈)、brochure(宣传册)、video-markting(视频)、ordinary(普通素材)、template-poster(模板海报平台素材)、upload-video、upload-images、crawler-article(企业文章/行业文章)、company-folder(企业文件夹)、small-routine(小程序)、link(任意链接) |
| materialShareShape | `Int[]`    | 分享形式                                                     |
| title              | `String`   | 标题                                                         |
| cover              | `String`   | 封面                                                         |
| desc               | `String`   | 描述                                                         |
| url                | `String`   | URL，一般是内容链接                                          |
| smallRoutineId     | `String`   | 尘锋系统内部小程序id，只有小程序素材才有                     |
| isDelete           | `Bool`     | 是否已删除，true表示删除                                     |
| statusCode         | `Int`      | 素材状态 0:正常 1:已删除 2:已下架 3:活动已结束 4:未绑定小程序 5:员工名片不存在 |
| behaviorTagIds     | `String[]` | 行为标签id                                                   |
| tags               | `Object[]` | 行为标签                                                     |
| path               | `String`   | 小程序path                                                   |
| appId              | `String`   | 小程序id                                                     |
| name               | `String`   | 小程序名字                                                   |
| logo               | `String`   | 小程序logo                                                   |
| originalId         | `String`   | 小程序原始id                                                 |
| confSetting        | `Object`   | 素材设置 publishTime(发布时间)、offShelfTime(下架时间)、timingOfPublish(定时发布时间) |

**tags 行为标签对象**

| 参数            | 类型     | 描述       |
| --------------- | -------- | ---------- |
| id              | `String` | id         |
| name            | `String` | 标签名     |
| order           | `Int`    | 排序       |
| backgroundColor | `String` | 背景色     |
| textColor       | `String` | 字体颜色   |
| parentId        | `String` | 父级标签id |
| enable          | `Bool`   | 是否启用   |

**goods 商品对象**

| 参数        | 类型     | 描述                                         |
| ----------- | -------- | -------------------------------------------- |
| goodsId     | `String` | 商品id                                       |
| goodsSource | `String` | 商品来源 cf=尘锋，youzan=有赞，dock=三方商城 |
| status      | `Int`    | 商品状态 1:上架 2:下架                       |
| title       | `String` | 标题                                         |
| cover       | `String` | 封面                                         |
| desc        | `String` | 描述                                         |
| url         | `String` | URL                                          |
| isDelete    | `Bool`   | 是否删除                                     |
| statusCode  | `Int`    | 素材状态                                     |
| goodsAttr   | `Object` | 商品额外属性                                 |

**card 名片对象**

| 参数                   | 类型     | 描述                                                         |
| ---------------------- | -------- | ------------------------------------------------------------ |
| type                   | `String` | 类型 company(公司名片)、user(指定员工名片)、share-user(分享员工名片) |
| uid                    | `String` | 指定员工id，仅当 type 为 user 时使用                         |
| noOpenUserCardSolution | `String` | 分享员工未开通名片时处理方案，仅当 type 为 share-user 时使用 no-send(不发送)、send-company(发送公司默认名片) |
| title                  | `String` | 标题                                                         |
| userName               | `String` | 员工名字                                                     |
| isDelete               | `Bool`   | 名片是否已删除                                               |
| path                   | `String` | 小程序path                                                   |
| appId                  | `String` | 小程序id                                                     |
| name                   | `String` | 小程序名字                                                   |
| logo                   | `String` | 小程序logo                                                   |

**activity 活动对象**

| 参数              | 类型       | 描述                                                         |
| ----------------- | ---------- | ------------------------------------------------------------ |
| type              | `String`   | 活动类型 readPacket(红包)、fissionEvent(裂变)、lottery(抽奖)、coupon(优惠券) |
| url               | `String`   | 活动链接                                                     |
| name              | `String`   | 活动名称                                                     |
| shareType         | `Int`      | 分享形式 1: H5 2: 小程序                                     |
| shareTitle        | `String`   | 分享标题                                                     |
| shareCopyWriting  | `String`   | 分享文案                                                     |
| shareCoverPicture | `String`   | 分享封面图                                                   |
| beginTime         | `String`   | 开始时间                                                     |
| endTime           | `String`   | 结束时间                                                     |
| isDelete          | `Bool`     | 是否已删除                                                   |
| statusCode        | `Int`      | 素材状态                                                     |
| receiveType       | `Int`      | 优惠券领取方式 0:免费领取 1:付费购买                         |
| name              | `String`   | 优惠券标题                                                   |
| discount          | `Int`      | 折扣券打折百分比                                             |
| activeAfterDays   | `Int`      | 限N天内使用                                                  |
| validityType      | `Int`      | 券有效期类型 10:指定时间范围 20:N天后结束                    |
| threshold         | `Int`      | 使用金额门槛                                                 |
| couponStatus      | `String`   | 优惠券方案状态                                               |
| couponType        | `Int`      | 优惠券方案类型 1:满减 2:折扣 3:到店核销                      |
| obtainRange       | `String[]` | 优惠券可用位置 1:productDetail 2:storePage 3:sidebar         |

**text 文本对象**

| 参数    | 类型     | 描述     |
| ------- | -------- | -------- |
| content | `String` | 文本内容 |

**成功响应结果**

```json
{
    "success": true,
    "code": 0,
    "msg": "ok",
    "traceId": "b9219dca-dffe-9ac4-be25-ca3bbe1fdce9",
    "data": {
        "id": "49b17dab-5488-4392-9370-d7dcc4ca5b76",
        "content": "欢迎使用尘锋素材",
        "status": 1,
        "domain": "mk",
        "subDomain": "welcome",
        "txtVars": ["nickname", "time"],
        "isOpenTxtVars": true,
        "entitys": [
            {
                "entityId": "e001",
                "mediaId": "media_xxx",
                "type": "text",
                "shareType": 1,
                "sortId": 1,
                "isDelete": false,
                "statusCode": 0,
                "text": {
                    "content": "欢迎语正文"
                }
            },
            {
                "entityId": "e002",
                "mediaId": "media_yyy",
                "type": "image",
                "shareType": 4,
                "sortId": 2,
                "isDelete": false,
                "statusCode": 0,
                "image": {
                    "name": "海报.png",
                    "mediaUrl": "https://cdn.dustess.com/xxx.png",
                    "type": 6,
                    "size": 102400,
                    "suffix": "png"
                }
            },
            {
                "entityId": "e003",
                "mediaId": "media_zzz",
                "type": "material",
                "shareType": 1,
                "sortId": 3,
                "isDelete": false,
                "statusCode": 0,
                "material": {
                    "type": "form",
                    "title": "shh-欢迎语2.0冒烟-表单",
                    "cover": "https://cdn.dustess.com/cover.png",
                    "desc": "表单描述",
                    "url": "https://qw.dustess.com/form/xxx",
                    "materialShareShape": [1, 4],
                    "smallRoutineId": "",
                    "isDelete": false,
                    "statusCode": 0,
                    "behaviorTagIds": ["t1"],
                    "tags": [
                        {
                            "id": "t1",
                            "name": "高意向",
                            "order": 1,
                            "backgroundColor": "#FF0000",
                            "textColor": "#FFFFFF",
                            "parentId": "",
                            "enable": true
                        }
                    ],
                    "confSetting": {
                        "publishTime": 1700000000,
                        "offShelfTime": 0,
                        "timingOfPublish": 0
                    }
                }
            }
        ]
    }
}
```

**失败响应结果**

```json
{
    "success": false,
    "code": 10001,
    "msg": "system unknown error",
    "data": null
}
```
