服务端开放接口
  1. 内容分发看板
服务端开放接口
  • API调用指南
    • 01 API 调用流程
    • 02 通用参数
    • 03 通用错误码
  • 鉴权(访问令牌)
    • 01 获取访问令牌
      POST
    • 02 刷新访问令牌
      POST
  • 素材
    • 素材相关说明
    • 上传
      • 02 上传资源到云服务器
      • 01 获取上传文件临时令牌
      • 03 (case1)创建内容原子
      • 03 (case2)创建文本内容原子
      • 03 (case3)创建组合内容原子
      • 03 (case4)创建网页内容原子
      • 04 素材入库
      • 05上传附件
    • 检索
      • 素材动态格式及大小转换
      • 01 素材检索
      • 02 查询素材详情
      • 03 素材标签检索
      • 04 查询素材信息和所在组信息
      • 素材拉取
      • 回收站素材检索
    • 编辑
      • 01 素材批量编辑
      • 02 删除素材
      • 03 删除素材标签
      • 04 素材内容编辑
  • 联动打标
    • 联动打标指南
    • 01 获取已配置的关联字段
      GET
    • 02 对指定素材重新进行联动打标
      POST
    • 03 刷新标签关联关系
      POST
  • 素材组
    • 检索
      • 01 素材组检索
      • 02 获取素材组内素材链接
    • 创建
      • 01 创建素材组
    • 编辑
      • 01 删除素材组
      • 02 素材组新增素材
      • 03 素材组移除素材
  • 元数据(Metadata)
    • 检索
      • 01 查询metadata标签
      • 02 查询筛选模板元数据
      • 03 查询编辑模板元数据
    • 编辑
      • 02 删除metadata标签
      • 01 新增metadata标签
      • 03 更新metadata标签
  • 内容分发
    • 01 分发看板
      • 01 分页查询内容
      • 02 获取内容详情
      • 03 根据内容ID列表获取内容统计值
      • 04 批量查询内容详情
      • 05 查询内容区块渠道标签配置
      • 06 查询内容模块点位信息
      • 07 查询内容模块基础信息(包含导航信息)
      • 08 批量添加Portal协作者
      • 09 新增/更改 Portal
      • 10 移除Portal
      • 11 批量保存/编辑Block
      • 12 根据人群标签获取内容标签
    • 02 内容中心
      • 内容中心业务说明
      • 01 分页查询内容
      • 02 查询内容详情
    • 03 私域中心
      • 01 人群包
        • 01 查询人群包列表
        • 02 添加人群包
        • 03 修改人群包
        • 04 删除人群包
        • 05 向人群包中添加人群
        • 06 根据人群包ID查询人群信息
        • 07 根据人群包删除人群
      • 02 营销计划
        • 01 新建私域计划
        • 02 修改私域计划
        • 03 删除私域计划
      • 03 营销任务
        • 01 新建私域任务
        • 02 修改私域任务
        • 03 删除私域任务
        • 04 创建企微群发消息
      • 04 营销任务数据
        • 01 客户与内容互动数据
        • 02 群发失败原因详情
        • 03 群发转发任务报表
    • 04社媒分发
      • 获取统计数据
      • 获取热门内容
  • 消息
    • 邮件/短信
      • 01 消息统一分发
    • 小铃铛
      • 检索
        • 01 查询消息列表
      • 编辑
        • 01 新增小铃铛消息
        • 02 消息设置已读
    • 待办事项
      • 检索
        • 01 查询待办消息列表
      • 编辑
        • 01 设置待办消息为已完成
  • 租户基础信息
    • 01 查询租户配置
    • 02 租户检索
  • 用户信息
    • 用户
      • 01 用户检索
      • 02 通过邮箱/手机获取用户信息
    • 部门
      • 01 部门检索
    • 角色
      • 01 检验用户角色权限
  • 埋点
    • 01 服务端埋点上报
    • 02 客户端埋点上报
    • 03 查询埋点数据
  • 审批中心
    • 01 获取审批模板
    • 02 审批项目获取
    • 03 查询审批任务列表
    • 04 发起审批
    • 05 发起入库审批(外部)
  • 规则引擎
    • 01 匹配规则
  • 冷库归档
    • 素材组
      • 检索
        • 获取根素材组信息
        • 获取非根素材组信息
    • 素材
      • 上传
        • 上传&入库流程详解
        • 上传资源到云服务器
        • 上传资源到云服务器
        • 归档库上传
      • 检索
        • 素材查询
  • 客户端开放接口
    • 接口验签
    • 内容分发看板
      • 01 查询内容区块信息(不推荐)
        GET
      • 02 搜索内容区块中内容(不推荐)
        POST
      • 03 获取单个内容详情(不推荐)
        POST
  • 历史版本(不推荐)
    • 素材
      • 上传
        • 01 获取上传临时令牌
        • 02 创建资源
        • 03 素材入库
      • 检索
        • 01 素材检索
        • 02 查询素材详情
        • 03 查询文档类型素材的pageInfo
        • 04 查询素材名称和所在素材组
        • 05 查询素材列表
      • 编辑
        • 01 素材批量编辑
    • 素材组
      • 01 素材组检索
    • 用户
      • 01 查询用户列表
  • 日常测试
    • 晖致素材列表
  • 测试
    POST
  1. 内容分发看板

02 搜索内容区块中内容(不推荐)

POST
https://vms-exapi.tezign.com/portal/open/block/search
客户端开放接口
在内容区块中进行内容检索

请求参数

Header 参数
X-App-Key
string 
必需
示例值:
16cjm234de0gye1dtlrv60clexna544w
S-Sign
string 
必需
示例值:
0hm1d6dx
S-Timestamp
string 
必需
示例值:
1660892101000
S-Nonce
string 
必需
示例值:
UUID
Content-Type
string 
必需
示例值:
application/json
x-asm-prefer-tag
string 
可选
默认值:
version-env-07
Body 参数application/json
blockId
integer 
模块id
必需
pageNum
integer 
页码
必需
默认为1
pageSize
integer 
每页的数量
必需
min = 1,max = 20,default = 20
searchText
string 
搜索文本: min = 0 , max = 32
必需
filterConditionList
array [object {3}] 
筛选条件
必需
type
integer 
导航类型
可选
1-素材组;2-metadata;3-自定义导航;4-内容Metadata
code
string 
字段code
可选
value
array[string]
选项value值
可选
pictureParam
object 
图片参数
必需
width
integer 
宽(单位像素)
必需
high
integer 
高(单位像素)
必需
示例
{
    "blockId": 327,
    "pageNum": 1,
    "pageSize": 20,
    "searchText": "3月31号正式开启全面推送",
    "filterConditionList": [
        {
            "type": 3,
            "code": "tags",
            "value": ["238"]
        }
    ],
      "pictureParam":{
        "width":800,
        "high":800
    }  
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://vms-exapi.tezign.com/portal/open/block/search' \
--header 'X-App-Key: 16cjm234de0gye1dtlrv60clexna544w' \
--header 'S-Sign: 0hm1d6dx' \
--header 'S-Timestamp: 1660892101000' \
--header 'S-Nonce: UUID' \
--header 'x-asm-prefer-tag: version-env-07' \
--header 'Content-Type: application/json' \
--data-raw '{
    "blockId": 327,
    "pageNum": 1,
    "pageSize": 20,
    "searchText": "3月31号正式开启全面推送",
    "filterConditionList": [
        {
            "type": 3,
            "code": "tags",
            "value": ["238"]
        }
    ],
      "pictureParam":{
        "width":800,
        "high":800
    }  
}'

返回响应

🟢200成功
application/json
Body
code
string 
必需
message
string 
必需
result
object 
必需
pageNum
integer 
页码
必需
pageSize
integer 
每页的数量
必需
totalCount
integer 
总数
必需
totalPage
integer 
必需
records
array [object {7}] 
返回结果
必需
示例
{
    "code": "0",
    "message": "in pariatur occaecat minim eiusmod",
    "result": {
        "pageNum": 80,
        "pageSize": 89,
        "totalCount": 17,
        "totalPage": 90,
        "records": [
            {
                "blockId": 36,
                "metadataInfo": {
                    "CUSTOMER_PORTAL_PUBLISH_TIME": 1191478958300
                },
                "coreId": 67,
                "name": "正矿积书门",
                "id": 47,
                "portalId": "85",
                "coverPicture": "http://dummyimage.com/400x400"
            },
            {
                "id": 80,
                "coreId": 19,
                "portalId": "40",
                "blockId": 65,
                "coverPicture": "http://dummyimage.com/400x400",
                "metadataInfo": {
                    "CUSTOMER_PORTAL_PUBLISH_TIME": 362755394050
                },
                "name": "己备省"
            },
            {
                "blockId": 58,
                "id": 8,
                "metadataInfo": {
                    "CUSTOMER_PORTAL_PUBLISH_TIME": 1536663798814
                },
                "portalId": "41",
                "name": "物军内住",
                "coreId": 84,
                "coverPicture": "http://dummyimage.com/400x400"
            }
        ]
    }
}
修改于 2023-09-07 07:17:58
上一页
01 查询内容区块信息(不推荐)
下一页
03 获取单个内容详情(不推荐)
Built with