第三方应用开发 服务端API 微信客服 会话分配与消息收发 发送欢迎语等事件响应消息
发送欢迎语等事件响应消息

目录

  • 概述
  • 接口定义
  • 消息类型
  •       文本消息
  •       菜单消息
  • 概述

    当特定的事件回调消息包含code字段,或通过接口变更到特定的会话状态,会返回code字段。
    开发者可以此code为凭证,调用该接口给用户发送相应事件场景下的消息如客服欢迎语、客服提示语和会话结束语等。
    除"用户进入会话事件"以外,响应消息仅支持会话处于获取该code的会话状态时发送,如将会话转入待接入池时获得的code仅能在会话状态为”待接入池排队中“时发送。

    目前支持的事件场景和相关约束如下:

    事件场景允许下发条数code有效期支持的消息类型获取code途径
    用户进入会话,用于发送客服欢迎语1条20秒文本、菜单事件回调
    进入接待池,用于发送排队提示语等1条48小时文本转接会话接口
    从接待池接入会话,用于发送非工作时间的提示语或超时未回复的提示语等1条48小时文本事件回调、转接会话接口
    结束会话,用于发送结束会话提示语或满意度评价等1条20秒文本、菜单事件回调、转接会话接口

     

    接口定义

    请求方式: POST(HTTPS)

    请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/send_msg_on_event?access_token=ACCESS_TOKEN

    请求示例

    {
    	"code": "CODE",
    	"msgid": "MSG_ID",
    	"msgtype": "MSG_TYPE"
    }

    参数说明:

    参数是否必须类型说明
    access_tokenstring调用接口凭证
    codestring事件响应消息对应的code。通过事件回调下发,仅可使用一次。
    msgidstring消息ID。如果请求参数指定了msgid,则原样返回,否则系统自动生成并返回。
    不多于32字节
    字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
    msgtypestring消息类型。对不同的msgtype,有相应的结构描述,详见消息类型
    「进入会话事件」响应消息:
    如果满足通过API下发欢迎语条件(条件为:用户在过去48小时里未收过欢迎语,且未向客服发过消息),则用户进入会话事件会额外返回一个welcome_code,开发者以此为凭据调用接口(填到该接口code参数),即可向客户发送客服欢迎语。

     

    权限说明:

    • 企业需要使用“微信客服”secret所获取的accesstoken来调用(accesstoken如何获取?),同时开启“会话消息管理”开关
    • 第三方应用需具有“微信客服->管理帐号、分配会话和收发消息”权限
    • 代开发自建应用需具有“微信客服->管理帐号、分配会话和收发消息”权限

     

    返回结果:

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

    参数说明:

    参数类型说明
    errcodeint32返回码
    errmsgstring错误码描述
    msgidstring消息ID

    消息类型

    文本消息

    请求示例:

    {
       "code": "CODE",
       "msgid": "MSG_ID",
       "msgtype" : "text",
       "text" : {
           "content" : "欢迎咨询"
       }
    }

    参数说明:

    参数是否必须类型说明
    msgtypestring消息类型,此时固定为:text
    textobj文本消息
    text.contentstring消息内容,最长不超过2048个字节

     

    菜单消息

    请求示例:

    {
      "code": "CODE",
      "msgid": "MSG_ID",
      "msgtype": "msgmenu",
      "msgmenu": {
        "head_content": "欢迎咨询",
        "list": [
          {
    	    "type": "click",
    		"click":
    		{
            	"id": "101",
            	"content": "接入人工"
    		}
          },
          {
    	    "type": "click",
    		"click":
    		{
            	"id": "102",
            	"content": "继续跟机器人聊天"
    		}
          },
    	  {
    	    "type": "view",
    		"view":
    		{
            	"url": "https://work.weixin.qq.com",
            	"content": "点击跳转到自助查询页面"
    		}
          },
    	  {
    	    "type": "miniprogram",
    		"miniprogram":
    		{
            	"appid": "wx123123123123123",
    			"pagepath": "pages/index?userid=zhangsan&orderid=123123123",
            	"content": "点击打开小程序查询更多"
    		}
          }
        ],
        "tail_content": "如有问题,随时转人工服务"
      }
    }

     

    参数说明:

    参数必须类型说明
    msgtypestring消息类型,此时固定为:msgmenu
    msgmenuobj菜单消息
    msgmenu.head_contentstring起始文本
    不多于1024字节
    msgmenu.listobj[]菜单项配置
    msgmenu.list.typestring菜单类型。
    click-回复菜单 view-超链接菜单 miniprogram-小程序菜单
    msgmenu.list.clickobjtype为click的菜单项
    msgmenu.list.click.idstring菜单ID。
    不少于1字节
    不多于128字节
    msgmenu.list.click.contentstring菜单显示内容
    不少于1字节
    不多于128字节
    msgmenu.list.viewobjtype为view的菜单项
    msgmenu.list.view.urlstring点击后跳转的链接。
    不少于1字节
    不多于2048字节
    msgmenu.list.view.contentstring菜单显示内容。
    不少于1字节
    不多于1024字节
    msgmenu.list.miniprogramobjtype为miniprogram的菜单项
    msgmenu.list.miniprogram.appidstring小程序appid。
    不少于1字节
    不多于32字节
    msgmenu.list.miniprogram.pagepathstring点击后进入的小程序页面。
    不少于1字节
    不多于1024字节
    msgmenu.list.miniprogram.contentstring菜单显示内容。
    不多于1024字节
    msgmenu.tail_contentstring结束文本
    不多于1024字节
    上一篇
    发送消息
    下一篇
    「升级服务」配置