发送消息

接口说明
消息类型
      文字消息
          单发文字消息
          群发文字消息
          给部分人发文字消息
      图片消息
          单发图片消息
          群发图片消息
          给部分人发图片消息
      文本卡片消息
          单发文本卡片消息
          给部分人发文本卡片消息
      图文消息
          单发图文消息
          群发图文消息
          给部分人发图文消息
      key-value消息
          单发key-value消息
          给部分人发key-value消息
      文件消息
          单发文件消息
          群发文件消息
          给部分人发文件消息
      待办消息
          单发待办消息
          给部分人发待办消息
          待办消息置为已处理

接口说明

轻推轻应用/订阅号支持发送文本、图片、文本卡片、图文、key-value、文件、待办等消息类型。本接口针对各种消息类型和发送的对象(单发、群发以及给部分人发送)进行了定义。

注:openid是用户关注某个轻应用/订阅号后生成的唯一id,单发和给部分人发送消息必须携带此参数,可以通过如下接口来获取:

消息类型

文字消息

效果图展示:

单发文字消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/single/send?access_token=ACCESS_TOKEN

请求包体示例:

{
    "touser":"OPENID1",
   "text":{
      "content":"这是一条文本消息"
   },
   "msgtype":"text"
}

参数说明:

参数 必须 说明
touser 要发送的用户openid
content 发送的文本消息内容
msgtype 消息种类,文本消息固定为text
access_token 调用接口凭证

正确返回结果示例:

{
   "errcode":0,
   "errmsg":"请求成功",
   "msg_id":"3233dfefaefadedejhksad"
}

出错返回结果示例:

{
    "errcode": 43004,
    "errmsg": "需要接收者关注"
}

群发文字消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/service/send?access_token=ACCESS_TOKEN

请求包体示例:

{
   "text":{
      "content":"这是一条文本消息"
   },
    "msgtype":"text"
}

参数说明:

参数 必须 说明
content 发送的文本消息内容
msgtype 消息种类,文本消息固定为text
access_token 调用接口凭证

正确返回结果示例:

{
   "errcode":0,
   "errmsg":"请求成功",
   "msg_id":"3233dfefaefadedejhksad"
}

出错返回结果示例:

{
    "errcode": -1,
    "errmsg": "系统繁忙"
}

备注:群发对象包括轻应用/订阅号的所有关注者。

给部分人发文字消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/mass/send?access_token=ACCESS_TOKEN

请求包体示例:

{
    "touser":[
    "OPENID1",
    "OPENID2"
   ],
   "text":{
      "content":"这是一条文本消息"
   },
    "msgtype":"text"
}

参数说明:

参数 必须 说明
touser 要发送的用户openid列表
content 发送的文本消息内容
msgtype 消息种类,文本消息固定为text
access_token 调用接口凭证

正确返回结果示例:

{
   "errcode":0, 
   "errmsg":"请求成功",
   "msg_id":"3233dfefaefadedejhksad"
}

出错返回结果示例:

{
    "errcode": 43004,
    "errmsg": "需要接收者关注"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

图片消息

效果图展示:

单发图片消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/single/send?access_token=ACCESS_TOKEN

请求包体示例:

{
   "touser":"OPENID1",
   "image":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"image"
}

参数说明:

参数 必须 说明
touser 要发送的用户openid
media_id 图片id,通过上传多媒体文件方法获得
msgtype 消息种类,图片消息固定为image
access_token 调用接口凭证

正确返回结果示例:

{
   "errcode":0,
   "errmsg":"请求成功",
   "msg_id":"3233dfefaefadedejhksad"
}

出错返回结果示例:

{
    "errcode": 43004,
    "errmsg": "需要接收者关注"
}

群发图片消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/service/send?access_token=ACCESS_TOKEN

请求包体示例:

{
   "image":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"image"
}

参数说明:

参数 必须 说明
media_id 图片id,通过上传多媒体文件方法获得
msgtype 消息种类,图片消息固定为image
access_token 调用接口凭证

正确返回结果示例:

{
   "errcode":0,
   "errmsg":"请求成功",
   "msg_id":"3233dfefaefadedejhksad"
}

出错返回结果示例:

{
    "errcode": -1,
    "errmsg": "系统繁忙"
}

备注:群发对象包括轻应用/订阅号的所有关注者。

给部分人发图片消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/mass/send?access_token=ACCESS_TOKEN

请求包体示例:

{
   "touser":[
    "OPENID1",
    "OPENID2"
   ],
   "image":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"image"
}

参数说明:

参数 必须 说明
touser 要发送的用户openid列表
media_id 图片id,通过上传多媒体文件方法获得
msgtype 消息种类,图片消息固定为image
access_token 调用接口凭证

正确返回结果示例:

{
   "errcode":0, 
   "errmsg":"请求成功",
   "msg_id":"3233dfefaefadedejhksad"
}

出错返回结果示例:

{
    "errcode": 43004,
    "errmsg": "需要接收者关注"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

文本卡片消息

使用场景: 开发者需要用文本+链接的方式通知用户,可使用文本卡片消息。

效果图展示:

单发文本卡片消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/textCard/send/single?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_user":"OPENID",
    "message":{
        "title":"标题\r标题第二行",
        "url":"https://www.qingtui.cn",
        "button_text":"这是按钮文字",
        "content_list":[
            {
                "text":"这是黑色文本",
                "attr":{
                    "color":"BLACK"
                }
            },
            {
                "text":"高亮消息文本",
                "attr":{
                    "color":"HIGHLIGHT"
                }
            },
            {
                "text":"这是灰色文本\n 换一行",
                "attr":{
                    "color":"GRAY"
                }
            }
        ]
    }
}

参数说明:

参数 必须 说明
to_user 要发送的用户openid
title 标题,最多45个字符
url 点击后的链接去向地址
button_text 按钮文本,默认为详情,最多6个字符
content_list 内容列表
text 内容,最多200个字符
color 内容的颜色值,支持高亮(HIGHLIGHT),灰色(GRAY),黑色(BLACK)
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "9BDAC87A40094D589E46D3CFBB191A00"
}

出错返回结果示例:

{
    "errcode": 45005,
    "errmsg": "color is error"
}

给部分人发文本卡片消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/textCard/send/mass?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_users":[
        "OPENID1",
        "OPENID2",
        "OPENID3",
        "OPENID4",
        "OPENID5"
    ],
    "message":{
        "title":"标题\r标题第二行",
        "url":"https://www.qingtui.cn",
        "button_text":"这是按钮文字",
        "content_list":[
            {
                "text":"这是黑色文本",
                "attr":{
                    "color":"BLACK"
                }
            },
            {
                "text":"高亮消息文本",
                "attr":{
                    "color":"HIGHLIGHT"
                }
            },
            {
                "text":"这是灰色文本\n 换一行",
                "attr":{
                    "color":"GRAY"
                }
            }
        ]
    }
}

参数说明:

参数 必须 说明
to_users 接收者,openid,逗号分隔
title 标题,最多45个字符
url 点击后的链接去向地址
button_text 按钮文本,默认为详情,最多6个字符
content_list 内容列表
text 内容,最多200个字符
color 内容的颜色值,默认黑色,支持高亮(HIGHLIGHT),灰色(GRAY),黑色(BLACK)
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "9BDAC87A40094D589E46D3CFBB191A00"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "to_user is required"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

图文消息

使用场景: 开发者需要用图文+链接的方式通知用户,可使用图文消息。

效果图展示:

单发图文消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/news/send/single?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_user":"OPENID",
    "message":{
        "article_list":[
            {
                "title":"路透社与Ipsos合作的调查显示,75%的美国用户仍然每天使用Facebook",
                "url":"https://www.qingtui.cn",
                "content":"该调查样本覆盖了美国大陆、夏威夷以及阿拉斯加2194位18岁以上用户,其中包括1938位其中包括1938",
                "thumbMediaId":"95ee6faef5d69"
            }
        ]
    }
}

参数说明:

参数 必须 说明
to_user 要发送的用户openid
article_list 文章列表
title 标题,最多45个字符
url 点击后的链接去向地址
content 摘要,最多120个字符
thumbMediaId 图片media_id
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "A3977A5CF1094037A1ECE67A8AD800"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "title is required"
}

给部分人发图文消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/news/send/mass?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_users":[
        "OPENID1",
        "OPENID2",
        "OPENID3",
        "OPENID4",
        "OPENID5"
    ],
    "message":{
        "article_list":[
            {
                "title":"路透社与Ipsos合作的调查显示,75%的美国用户仍然每天使用Facebook",
                "url":"https://www.qingtui.cn",
                "content":"该调查样本覆盖了美国大陆、夏威夷以及阿拉斯加2194位18岁以上用户,其中包括1938位其中包括1938",
                "thumbMediaId":"95ee6faef5d69"
            }
        ]
    }
}

参数说明:

参数 必须 说明
to_users 接收者,openid,逗号分隔
article_list 文章列表
title 标题,最多45个字符
url 点击后的链接去向地址
content 摘要,最多120个字符
thumbMediaId 图片media_id
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "A3977A5CF1094037A1ECE67A8AD800"
}

出错返回结果示例:

{
    "errcode": 45004,
    "errmsg": "openId not authority to appId"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

群发图文消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/news/send/service?access_token=ACCESS_TOKEN

请求包体示例:

{
    "message":{
        "article_list":[
            {
                "title":"路透社与Ipsos合作的调查显示,75%的美国用户仍然每天使用Facebook",
                "url":"https://www.qingtui.cn",
                "content":"该调查样本覆盖了美国大陆、夏威夷以及阿拉斯加2194位18岁以上用户,其中包括1938位其中包括1938",
                "thumbMediaId":"95ee6faef5d69"
            }
        ]
    }
}

参数说明:

参数 必须 说明
article_list 文章列表
title 标题,最多45个字符
url 点击后的链接去向地址
content 摘要,最多120个字符
thumbMediaId 图片media_id
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "A3977A5CF1094037A1ECE67A8AD800"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "url is invalid"
}

备注:群发对象包括轻应用/订阅号的所有使用者。

key-value消息

效果图展示:

单发key-value消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/keyValue/send/single?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_user":"OPENID",
     "message":{
        "title":"标题",
        "sub_title":{
            "text":"从这里内容开始\n\n",
            "color":"GRAY"
        },
        "url":"https://www.qingtui.cn",
        "content":[
            {
                "key":"栏目一",
                "value":"栏目一的值高亮显示",
                "valueColor":"HIGHLIGHT"
            },
            {
                "key":"栏目二",
                "value":"栏目二的值默认颜色显示\n"

            },
            {
                "key":"栏目三",
                "value":"栏目三的值灰色显示",
                "valueColor":"GRAY"

            }
        ],
        "footer":{
            "text":"\n\n结尾"

        },
        "button_text":"按钮文本"
    }
}

参数说明:

参数 必须 说明
to_user 要发送的用户openid
title 标题,最多45个字符
sub_title 首行说明
text 首行说明内容
color 首行说明颜色
url 点击后的链接去向地址
content 正文,最长支持6个键值对,含key,value和valueColor
key 左侧的栏目名称,最长8个字符
value 栏目对应的内容,最长45个字符
valueColor 栏目内容的颜色值,默认黑色,支持高亮(HIGHLIGHT),灰色(GRAY),黑色(BLACK)
footer 末尾说明,含text和color
button_text 按钮文本,默认为详情,最多6个字符
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "795BE20237CE47D283385080FF66C200"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "title is required"
}

给部分人发key-value消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/keyValue/send/mass?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_users":[
        "OPENID1",
        "OPENID2",
        "OPENID3",
        "OPENID4",
        "OPENID5"
    ],
    "message":{
        "title":"标题",
        "sub_title":{
            "text":"从这里内容开始\n\n",
            "color":"GRAY"
        },
        "url":"https://www.qingtui.cn",
        "content":[
            {
                "key":"栏目一",
                "value":"栏目一的值高亮显示",
                "valueColor":"HIGHLIGHT"
            },
            {
                "key":"栏目二",
                "value":"栏目二的值默认颜色显示\n"

            },
            {
                "key":"栏目三",
                "value":"栏目三的值灰色显示",
                "valueColor":"GRAY"

            }
        ],
        "footer":{
            "text":"\n\n结尾"

        },
        "button_text":"按钮文本"
    }
}

参数说明:

参数 必须 说明
to_users 接收者的openid,逗号分隔
title 标题,最多45个字符
sub_title 首行说明
text 首行说明内容
color 首行说明颜色
url 点击后的链接去向地址
content 正文,最长支持6个键值对,超过后报错,含key,value和valueColor
key 左侧的栏目名称,最长8个字符
value 栏目对应的内容,最长45个字符
valueColor 栏目内容的颜色值,默认黑色,支持高亮(HIGHLIGHT),灰色(GRAY),黑色(BLACK)
footer 末尾说明,含text和color
button_text 按钮文本,默认为详情,最多6个字符
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "D9E3942EC42E4EA8B5"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "title is required"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

文件消息

效果图展示:

单发文件消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/file/send/single?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_user":"OPENID",
    "message":{
        "media_id":"910c822e28c457ba95ee6f"
    }
}

参数说明:

参数 必须 说明
to_user 要发送的用户openid
media_id 文件id,通过上传多媒体文件方法获得
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "ECD4B0A645AD4368B"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "media_id is required"
}

群发文件消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/file/send/service?access_token=ACCESS_TOKEN

请求包体示例:

{
    "message":{
        "media_id":"910c822e28c457ba95ee6f"
    }
}

参数说明:

参数 必须 说明
media_id 文件id,通过上传多媒体文件方法获得
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "ECD4B0A645AD4368B"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "media_id is required"
}

备注:群发对象包括轻应用/订阅号的所有关注者。

给部分人发文件消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/file/send/mass?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_users":[
        "OPENID1",
        "OPENID2",
        "OPENID3",
        "OPENID4",
        "OPENID5"
    ],
    "message":{
        "media_id":"910c822e28c457ba95ee6f"
    }
}

参数说明:

参数 必须 说明
to_users 要发送的用户openid列表
media_id 文件id,通过上传多媒体文件方法获得
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "ECD4B0A645AD4368B"
}

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "media_id is required"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

待办消息

效果图展示:

单发待办消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/process/send/single?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_user":"OPENID",
    "message":{
        "title":"OA待办",
        "body":"2018/01/08 10:52\n赛迪信息-公司请假审批流程-文君-2018-04-16\n请假时间2018年4月17日至2018年4月20日",
        "url":"https://www.qingtui.cn"
    }
}

参数说明:

参数 必须 说明
to_user 要发送的用户openid
title 发送消息的标题
body 消息体
url 点击消息后跳转的链接
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "msg_id": "f4ee9f9ff4cc42dc866ce0cf1d8d7600"
    }
 }

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "title is required"
}

给部分人发待办消息

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/process/send/mass?access_token=ACCESS_TOKEN

请求包体示例:

{
    "to_users":[
        "OPENID1",
        "OPENID2",
        "OPENID3",
        "OPENID4",
        "OPENID5"
    ],
    "message":{
        "title":"OA待办",
        "body":"2018/01/08 10:52\n赛迪信息-公司请假审批流程-文君-2018-04-16\n请假时间2018年4月17日至2018年4月20日",
        "url":"https://www.qingtui.cn"
    }
}

参数说明:

参数 必须 说明
to_users 待接收用户的openid列表,最多50人
title 发送消息的标题
body 消息体
url 点击消息后跳转的链接
access_token 调用接口凭证

正确返回结果示例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": [
        {
            "open_id": "71b187da85b1494d83298627d860301",
            "msg_id": "728499ba04e340cfb6f099f5ac4cdc00"
        },
        {
            "open_id": "8c5e3d6b3e5b4162980c34a504d2200",
            "msg_id": "1128f921127145e6a8b647a78f915d40"
        },
        {
            "open_id": "c343d22b6308489cb3527d648788c03",
            "msg_id": "75c69bbd33e649dab37a4c580fa49f00"
        }
    ]
  }

出错返回结果示例:

{
    "errcode": 40100,
    "errmsg": "title is required"
}

备注: 目前一次性最多支持发送给50个人,如果有更多的人员要发送,可以拆分成多次循环发送。

待办消息置为已处理

请求方式: POST

请求地址: https://open.qingtui.cn/v1/message/process/complete?access_token=ACCESS_TOKEN

请求包体示例:

{
      "msg_id":"64d7324ed8114ff3ba0cffe9447bf500",
      "open_id":"5f356afd74e24ea3998ecb1dc278ed00"
}

参数说明:

参数 必须 说明
msg_id 此消息的id,发送待办消息后返回的消息id
open_id 消息对应的用户openid
access_token 调用接口凭证

正确返回结果示例:

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

出错返回结果示例:

{
    "errcode": -1,
    "errmsg": "system error"
}

results matching ""

    No results matching ""