聆客开放平台

#自定义群组机器人开发

使用自定义机器人
1、通过创建群组机器人获取到Webhook地址后,用户可以向这个地址发起HTTP POST 请求,即可实现给该群组发送消息。注意,发起POST请求时,必须将字符集编码设置成UTF-8。

2、当前自定义机器人支持文本 (text)、链接 (link)、新富文本(NewRich) 消息类型,大家可以根据自己的使用场景选择合适的消息类型,达到最好的展示样式。

# 请求示例

POST  https://notificationapi.bingolink.biz:443/notificationapi/hook/send?token=xxxxxxxx 
Content-Type: application/json

{
    "msgType":"text",
    "content": {
     "text" : "这是text类型消息"      //消息内容
    }
}

Ps:需要将xxxxxxxx替换为真实生成的token

#消息类型及数据格式

###Text类型

{
    "msgType":"text",
    "content": {
     "text" : "这是text类型消息"
    }
}

# 参数说明

参数 参数类型 必填 属性说明
msgType string 消息类型
content string 消息内容

###Link类型

{
    "msgType":"links",
    "content": {
        "text" : "这是text类型消息",
        "link" : "打开的url地址"
    }
}

# content参数说明

参数 参数类型 必填 属性说明
text string 消息内容
link string url链接地址

###NewRich类型

{
    "msgType":"rich",
    "content": {
         "text"  : "这是text类型消息",
         "link"  : "打开的url地址",
         "title" : "消息标题",
         "image" : "图片地址"
    }
}

# content参数说明

参数 参数类型 必填 属性说明
text string 消息内容
link string url链接地址
title string 消息标题
image string 图片地址

###卡片模板消息类型(卡片模板消息说明

{
    "msgType":"card_template",
    "content": {
         "brief": "这是摘要信息",
         "templateId": "xxxxxxxxxxxxxxxx",
         "templateCode": "xxxx",
         "data": {
             "key1": "value1",
             "key2": "value2"
         }
    }
}

# content参数说明

参数 参数类型 必填 属性说明
brief string 摘要信息
templateId string 与卡片模板Code二者其中一个必填 卡片模板ID(优先)
templateCode string 与卡片模板id二者其中一个必填 卡片模板Code(会根据该code获取最新的模板ID)
data Map 模板数据(key,对应模板中的值)