纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

    • CRM对象接口

    • CRM对象通用接口

    • 通讯录接口

    • 其他接口

      • 任务待办接口

      • 考勤外勤接口

      • 协同审批接口

      • 企业互联接口

      • 消息接口

        • 服务号发消息
        • 撤回消息
        • 发送文本消息
        • 发送复合消息
        • 发送图文消息
        • 素材管理接口

        • 网盘接口

        • 营销通接口

        • 文件服务

        • ERP接口

        • BI接口

        • 下线接口

    • 免登集成方案

    • 客户端开发

    • 常见问题

    目录

    发送图文消息

    # 描述

    发送图文消息

    # 请求说明

    请求方式:POST + application/json

    请求路径:https://${填入所在云的域名}/cgi/message/send?thirdTraceId=${随机字符串}

    请求头填写 :参考公共参数填写

    # 请求参数

    参数 类型 是否必填 说明
    toUser List 是 开放平台员工ID列表(消息接收者,目前最多支持500人)
    msgType String 是 消息类型,取值为:articles
    articles List 是 图文条目列表 ,一次最多允许7条图文消息
    articles.title String 是 标题,最长45个字符
    articles.author String 否 作者,最长8个字符
    articles.description String 否 摘要,最长140字符。
    articles.coverImage String 是 封面图片对应的mediaId
    articles.coverImageInContent Boolean 否 当articles.type为"TEXT"时,内容中是否显示图片(false不包含,true包含,默认false)
    articles.type String 是 图文消息内容类型("TEXT","URL")
    articles.content String 是 图文消息内容,当imageTextType为"URL"时表示链接地址。

    # 请求示例

    {
       "toUser":[
          "TOUSER1",
          "TOUSER2"
       ],
       "msgType":"articles",
       "articles":[
          {
             "title":"这是标题",
             "author":"作者",
             "description":"这是普通文章样例",
             "coverImage":"mediaId",
             "coverImageInContent":true,
             "type":"TEXT",
             "content":"这是文章内容"
          },
          {
             "title":"这是标题",
             "author":"作者",
             "description":"这是跳转样例",
             "coverImage":"mediaId",
             "type":"URL",
             "content":"www.aaa.com"
          }
       ]
    }
    

    # 返回参数

    参数 类型 说明
    traceId string 请求唯一ID
    errorDescription string 错误描述
    errorMessage string 错误信息
    errorCode Int 查看错误码

    # 返回示例

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    发送复合消息
    上传消息素材文件

    ← 发送复合消息 上传消息素材文件 →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式