纷享销客开发者手册 纷享销客开发者手册
  • 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 是 消息类型,取值为:composite
    composite Object 是 二级对象,文本数据详情
    composite.head.title String 是 头部标题
    composite.first.content String 否 内容标题
    composite.form List 否 内容列表
    composite.form.label String 否 列表标签
    composite.form.value String 否 列表值
    composite.remark.content String 否 内容摘要
    composite.link.title String 是 点击消息时跳转链接标题
    composite.link.url String 是 点击消息时跳转链接地址,可以使用纷享内部跳转地址 对象数据地址结构: fs://CRM/udobj?{"objDescApiName":"AccountObj","objDataId":"5ff2780b7132bb0001bade16"}

    # 请求示例

    {
       "toUser":[
        "TOUSER1",
        "TOUSER2"
       ],
       "msgType":"composite",
       "composite":{
          "head":{
             "title":"运营日报"
          },
          "first":{
             "content":"红包数据"
          },
          "form":[
             {
                "label":"CRM (日点击次数)",
                "value":"100000"
             },
             {
                "label":"会议助手 (日点击次数)",
                "value":"200000"
             },
             {
                "label":"CRM (日点击次数)",
                "value":"300000"
             },
             {
                "label":"PK助手 (日点击次数)",
                "value":"400000"
             }
          ],
          "remark":{
             "content":"remark"
          },
          "link":{
             "title":"详情",
             "url":"http://www.fxiaoke.com"
          }
       }
    }
    

    # 返回参数

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

    # 返回示例

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

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    发送文本消息
    发送图文消息

    ← 发送文本消息 发送图文消息→

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