服务端开放接口
  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调用指南

03 通用错误码

通用Http响应码#

最后更新于 2023-03-10
以下是通用的Http响应码
响应码响应信息详细说明
0成功业务请求成功
400参数错误参数错误,请确保请求方法、请求信息、请求数据格式等是正确的
401Token失效,认证失败需要重新通过接口获取token&刷新token
403禁止访问请求异常,请稍后重试
404服务不存在需要详细检查接口路径是否正确
500服务端错误系统异常,请稍后重试
599请求处理未完成请求异常,请稍后重试

服务端错误码说明#

最后更新于 2023-03-10
以下是服务端常用错误码列表-部分未列入的错误码可以在具体 API 接口文档中查询到
错误码错误信息排查建议
401Invalid access token: xxxToken失效,需要重新通过接口获取token&刷新token
10001System exception系统异常,请稍后再试
10002System maintenance系统维护中,请稍后再试
10003System busy系统繁忙,请稍后再试
10004System running exception系统运行异常,请稍后再试
10005Service not found服务未注册,请联系管理员进行注册
10006Bad request传参错误,请确保请求方法、请求信息、请求数据格式等是正确的
10008Internal error内部错误,请稍后重试
20001Client not found应用未注册,请联系管理员进行注册
20003Invalid access_token查看token是否填写正确,是否过期
20004Client do not have permission to access this service应用没有访问此服务的权限,请联系管理员进行注册
20005Client config error应用配置错误,请联系管理员进行修改
20006Invalid client应用已失效,请联系管理员重新注册
20007Request repeated请求重复,请稍后再试
20008System timestamp is null系统时间戳为空,请检查参数的正确性
20009Verify fail验签失败,请检查应用信息是否正确
20010Api timeoutAPI访问超时,请稍后再试
20011Request parameter error请求参数错误,请检查参数的正确性
20012The client information is empty应用信息为空,请检查应用参数的正确性
20013refresh_token cannot be nullrefresh_token不能为空,请检查参数的正确性
20014access_token cannot be nullaccess_token不能为空,请检查参数的正确性
20015timeout cannot be nulltimeout不能为空,请检查参数的正确性
20016salt cannot be nullsalt不能为空,请检查参数的正确性
20017open cannot be nullopen不能为空,请检查参数的正确性
20018type: {} does not exist应用类型不存在,请检查参数的正确性
20019AK/SK authentication cannot be obtained access_token应用鉴权类型不匹配,请检查应用的鉴权类型是否正确
修改于 2023-09-07 07:20:33
上一页
02 通用参数
下一页
01 获取访问令牌
Built with