服务端开放接口
  1. API调用指南
服务端开放接口
  • 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 查询内容区块信息(不推荐)
      • 02 搜索内容区块中内容(不推荐)
      • 03 获取单个内容详情(不推荐)
  • 历史版本(不推荐)
    • 素材
      • 上传
        • 01 获取上传临时令牌
        • 02 创建资源
        • 03 素材入库
      • 检索
        • 01 素材检索
        • 02 查询素材详情
        • 03 查询文档类型素材的pageInfo
        • 04 查询素材名称和所在素材组
        • 05 查询素材列表
      • 编辑
        • 01 素材批量编辑
    • 素材组
      • 01 素材组检索
    • 用户
      • 01 查询用户列表
  • 日常测试
    • 晖致素材列表
  • 测试
    POST
  1. API调用指南

02 通用参数

通用参数#

📌
为了满足多样化的应用场景,特赞开放平台提供了丰富的 API 和事件,供开发者调用或订阅。这些 API 和事件会涉及到一些通用参数,在此进行统一介绍。通用参数可能作为请求参数,也可能作为响应参数。在使用特赞开放平台提供的 API 和事件之前,建议先了解一下这些通用参数的含义。

应用相关#

client_id
client_id 是特赞开放平台应用的唯一标识。在创建应用时,由系统自动生成,用户不能自行修改。
client_key
client_key 是应用的秘钥。在创建应用时,由系统自动生成,在调用某些 API 时,需要将 app_secret 作为请求参数之一。

企业相关#

tenant_id
tenant_id 是租户唯一标识,在实际应用场景中,对应一个企业。

访问凭证#

💡
为了提升 API 调用的安全性,特赞开放平台设计了访问凭证机制。在调用接口前,需要先获取所需的访问凭证。访问凭证我们也称为 access_token。访问凭证代表应用从平台、租户(公司或者团队)、用户手中获取的授权。
应用访问凭证,参数名为 : access_token
获取访问凭证,请访问接口:获取访问令牌
默认有效期:3600s

开放环境#

📌
特赞域名:https://open-auth.tezign.com; 私有化部署客户的域名需联系开发或运维

请求参数#

通用请求头设置#

请求头Key请求头Value请求头描述
Content-Typeapplication/json请求头的内容类型
Access-token获取访问令牌接口中的 access_token服务端API的验签token
Token-type获取访问令牌接口中的 token_type接口验证类型,默认为bearer
x-asm-prefer-tag指定测试环境开放接口有多套测试环境,可咨询开发传指定测试环境值

通用请求体包装#

请求体键请求体类型是否必须描述
paramJSONN统一请求体包装
{
 "token": "yourAccessToken", 
 "param": {}
} 

通用响应体包装#

响应体健响应体类型是否必须描述
codeStringY业务响应码
messageStringY业务响应信息
resultJSONN业务响应体
{
 "code": "0", 
 "message": "success", 
 "result": {} 
} 
上一页
01 API 调用流程
下一页
03 通用错误码
Built with