发送消息

使用场景： 适用于给用户发送通知类的消息。

支持站内信、邮件、短信、微信公众号模板消息、企业微信应用消息、钉钉应用消息六种消息通道；

其中，企业微信应用消息、钉钉应用消息支持发送文本、卡片、Markdown格式消息；消息通道和类型参见下列描述。

该接口是异步发送消息，接口返回成功并不表示用户一定会收到消息。

权限说明

请求方式： POST（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/v2/open/message/send?access_token=ACCESS_TOKEN

返回结果：

{
  "errcode": 0,
  "errmsg": "ok",
  "id": 180
}

参数说明：

消息通道

站内信

请求包体：

{
  "channel_type": "CHANNEL_SITE",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag": 1,
  "site_info": {
    "content": "2023年12月15日英语作业：复习第一章重点词语，完成第一章课后习题。",
    "author": "英语老师",
    "summary": "英语作业通知",
    "cover": "https://dev-1.cos.ap-guangzhou.myqcloud.com/2023/202312/20231215/english_homework.txt",
    "attachments": [
      {
        "name": "第一章重点词语",
        "url": "https://dev-1.cos.ap-guangzhou.myqcloud.com/2023/202312/20231215/english_words.txt"
      }
    ],
    "external_links": [
      {
        "name": "课外拓展",
        "url": "https://www.qq.com/"
      }
    ]
  }
}

参数说明：

邮件

注意：当前邮件服务商只支持腾讯云。

请求包体：

{
  "channel_type": "CHANNEL_EMAIL",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "登录通知",
  "tag":1,
  "email_info": {
    "subject": "登录通知",
    "template_id": "12345",
    "template_data": {
      "username": "小明",
      "os": "Windows",
      "browser": "Chrome",
      "code": "ASXS"
    }
  }
}

参数说明：

短信

注意：当前短信服务商只支持腾讯云、自建通道。

请求包体：

{
  "channel_type": "CHANNEL_SMS",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "活动通知",
  "tag":1,
  "sms_info": {
    "content": "",
    "template_id": "930029",
    "template_params": [
      "12月15日下午3点",
      "风雨礼堂"
    ]
  }
}

参数说明：

微信公众号模板消息

请求包体：

{
  "channel_type": "CHANNEL_WECHAT_TEMPLATE",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "工作通知",
  "tag":1,
  "wechat_template_info": {
    "template_id": "Ks9qzhOpTQo0uk8tSq",
    "data": {
      "keyword1": "12月15日下午3点",
      "keyword2": "2911会议室"
    },
    "url": "https://www.qq.com/",
    "mini_program": {
      "app_id": "Ks9qzhOpTQo0uk8tSq",
      "page_path": "https://www.qq.com/"
    }
  }
}

参数说明：

企业微信应用消息

文本消息

请求包体：

{
  "channel_type": "CHANNEL_QYWX",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "qywx_info": {
    "msg_type": "text",
    "text": {
      "content": "2023年12月15日英语作业：复习第一章重点词语，完成第一章课后习题。"
    }
  }
}

参数说明：

文本卡片消息

请求包体：

{
  "channel_type": "CHANNEL_QYWX",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "qywx_info": {
    "msg_type": "textcard",
    "textcard": {
      "title": "作业通知",
      "description": "2023年12月15日英语作业：复习第一章重点词语，完成第一章课后习题。",
      "url": "https://www.qq.com/",
      "btntxt": "查看详细内容"
    }
  }
}

参数说明：

Markdown消息

请求包体：

{
  "channel_type": "CHANNEL_QYWX",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "qywx_info": {
    "msg_type": "markdown",
    "markdown": {
      "content": "您的会议室已经预定，稍后会同步到`邮箱`  \n>**事项详情**  \n>事　项：<font color=\"info\">开会</font>  \n>组织者：@miglioguan  \n>参与者：@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang  \n>  \n>会议室：<font color=\"info\">广州TIT 1楼 301</font>  \n>日　期：<font color=\"warning\">2018年5月18日</font>  \n>时　间：<font color=\"comment\">上午9:00-11:00</font>  \n>  \n>请准时参加会议。  \n>  \n>如需修改会议信息，请点击：[修改会议信息](https://work.weixin.qq.com)"
    }
  }
}

参数说明：

钉钉应用消息

文本消息

请求包体：

{
  "channel_type": "CHANNEL_DINGTALK",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "dingtalk_info": {
    "msg_type": "text",
    "text": {
      "content": "2023年12月15日英语作业：复习第一章重点词语，完成第一章课后习题。"
    }
  }
}

参数说明：

文本卡片消息

请求包体：

{
  "channel_type": "CHANNEL_DINGTALK",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "dingtalk_info": {
    "msg_type": "action_card",
    "action_card": {
      "title": "作业通知",
      "markdown": "您的会议室已经预定，稍后会同步到`邮箱`  \n>**事项详情**  \n>事　项：<font color=\"info\">开会</font>  \n>组织者：@miglioguan  \n>参与者：@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang  \n>  \n>会议室：<font color=\"info\">广州TIT 1楼 301</font>  \n>日　期：<font color=\"warning\">2018年5月18日</font>  \n>时　间：<font color=\"comment\">上午9:00-11:00</font>  \n>  \n>请准时参加会议。  \n>  \n>如需修改会议信息，请点击：[修改会议信息](https://work.weixin.qq.com)",
      "single_title": "查看详情",
      "single_url": "https://www.qq.com",
      "btn_orientation": "1",
      "btn_json_list": [
        {
          "title": "一个按钮",
          "action_url": "https://www.qq.com"
        },
        {
          "title": "两个按钮",
          "action_url": "https://www.qq.com"
        }
      ]
    }
  }
}

参数说明：

Markdown消息

请求包体：

{
  "channel_type": "CHANNEL_DINGTALK",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "dingtalk_info": {
    "msg_type": "markdown",
    "markdown": {
      "title": "作业通知",
      "text": "您的会议室已经预定，稍后会同步到`邮箱`  \n>**事项详情**  \n>事　项：<font color=\"info\">开会</font>  \n>组织者：@miglioguan  \n>参与者：@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang  \n>  \n>会议室：<font color=\"info\">广州TIT 1楼 301</font>  \n>日　期：<font color=\"warning\">2018年5月18日</font>  \n>时　间：<font color=\"comment\">上午9:00-11:00</font>  \n>  \n>请准时参加会议。  \n>  \n>如需修改会议信息，请点击：[修改会议信息](https://work.weixin.qq.com)"
    }
  }
}

参数说明：

更新消息

使用场景： 适用于对消息进行更新。

注意：该接口参数格式与发送消息接口类似，此处说明不再重复描述。

权限说明

请求方式： POST（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/v2/open/message/update?access_token=ACCESS_TOKEN

请求包体：

{
  "id": "1",
  "channel_type": "CHANNEL_SITE",
  "send_type": "TYPE_SEND",
  "schedule_send_time": "2023-12-15 14:30:00",
  "message_ranges": [
    {
      "range_type": "RANGE_USER",
      "range_id": 8348589
    }
  ],
  "title": "作业通知",
  "tag":1,
  "site_info": {
    "content": "2023年12月15日英语作业：复习第一章重点词语，完成第一章课后习题。",
    "author": "英语老师",
    "summary": "英语作业通知",
    "cover": "https://dev-1.cos.ap-guangzhou.myqcloud.com/2023/202312/20231215/english_homework.txt",
    "attachments": [
      {
        "name": "第一章重点词语",
        "url": "https://dev-1.cos.ap-guangzhou.myqcloud.com/2023/202312/20231215/english_words.txt"
      }
    ],
    "external_links": [
      {
        "name": "课外拓展",
        "url": "https://www.qq.com/"
      }
    ]
  }
}

参数说明：

返回结果：

{
  "errcode": 0,
  "errmsg": "ok"
}

参数说明：

获取消息列表

使用场景： 获取消息列表。

权限说明

请求方式： POST（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/v2/open/message/list?access_token=ACCESS_TOKEN

请求包体：

{
  "page_no": 1,
  "page_size": -1,
  "search_type": "SEARCH_SEND",
  "app_name": "教育",
  "title": "1",
  "channel_type": 3,
  "start_send_time": "2023-11-13 00:00:00",
  "end_send_time": "2023-11-14 00:00:00",
  "message_status":3,
  "tags":[1,2],
  "search_org":0
}

参数说明：

返回结果：

{
  "errmsg": "ok",
  "errcode": 0,
  "total": 1,
  "message_infos": [
    {
      "id": 1,
      "title": "消息标题",
      "tag":1,
      "app_name": "智慧校园",
      "send_time": "2024-01-22 11:52:50",
      "channel_type": "CHANNEL_WECHAT_TEMPLATE",
      "message_status": "MESSAGE_SUCCESS",
      "read": "-",
      "operator_name": "admin",
      "message_ranges": [
        {
          "org_id": 123,
          "range_type": "RANGE_USER",
          "range_id": 1234,
          "range_name": "user"
        }
      ],
      "create_time": "2024-01-22 11:52:50",
      "read_status": "UNDEFINED",
      "wechat_template_info": {
        "template_id": "xxxxid",
        "url": "https://www.qq.com",
        "mini_program": {
          "app_id": "",
          "page_path": ""
        },
        "data": {
          "keyword1": "2023",
          "keyword2": "2024"
        }
      }
    }
    ]
}

参数说明：

获取消息详情

使用场景： 获取消息列表。

权限说明

请求方式： POST（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/v2/open/message/get?access_token=ACCESS_TOKEN

请求包体：

{
  "id": 1
}

参数说明：

返回结果：

{
  "errcode": 0,
  "errmsg": "ok",
  "id": 1,
  "title": "消息标题",
  "tag":1,
  "app_name": "智慧校园",
  "send_time": "2024-01-22 11:52:50",
  "channel_type": "CHANNEL_WECHAT_TEMPLATE",
  "message_status": "MESSAGE_SUCCESS",
  "read": "-",
  "operator_name": "admin",
  "message_ranges": [
    {
      "org_id": 123,
      "range_type": "RANGE_USER",
      "range_id": 1234,
      "range_name": "user"
    }
  ],
  "create_time": "2024-01-22 11:52:50",
  "read_status": "UNDEFINED",
  "wechat_template_info": {
    "template_id": "xxxxid",
    "url": "https://www.qq.com",
    "mini_program": {
      "app_id": "",
      "page_path": ""
    },
    "data": {
      "keyword1": "2023",
      "keyword2": "2024"
    }
  }
}

参数说明：