机器人
发送webhook群消息
接口说明:通过该接口,用户可以给指定群发送消息,详情参考webhook机器人使用说明。请求方式:POST (HTTPS),Content-Type: application/json请求地址:https://apigw-example.domain/v1/bot/hook/messages/create?app_token=APP_ACCESS_TOKEN&hook_token=HOOK_TOKENquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 否 | 应用调用接口的凭证,当创建webhook机器人时选择的安全设置为关联蓝信应用访问凭证时必填 |
| hook_token | 是 | webhook机器人的token,创建webhook机器人时获得,必填 |
请求数据示例:
{
"timestamp": "1599360473",
"sign": "xxxxxxxxxxxxxxxxxxxxx",
"msgType": "type",
"msgData":{
"type" :{
}
}
}
请求参数字段说明:|参数|类型|必须|说明 | |-------------|---------|---------|-------------------------------------------| | timestamp | string | 否 | 时间戳,精确到秒,当webhook机器人的安全设置为加签时必填 | | sign | string | 否 | 签名数据,当webhook机器人的安全设置为加签时必填,具体签名算法参考: webhook机器人使用说明 | | msgType | string | 是 | 发送的消息格式,支持以下几种:text、document、linkCard、appCard、oaCard, appArticles | | msgData | object | 是 | 消息概要信息,内容根据type具体定义,消息体类型 |
返回参数字段说明:|参数|类型|描述 | |----------|---------|-----------------------| | msgId | string | 消息标识,供其它接口查询等使用 |
返回数据示例:
业务正常返回:
{
"errCode":0 ,
"errMsg":"ok",
"data":{
"msgId":"678590-xxxxxxxxxxx"
}
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
对应可能的错误码说明:
智能机器人发送私聊消息
接口说明:通过该接口,应用可以给指定的人和分支以智能机器人的身份发送系统定义的几种消息,使用场景参考智能机器人使用说明。请求方式:POST (HTTPS),Content-Type: application/json请求地址:https://apigw-example.domain/v1/bot/messages/create?app_token=APP_TOKENquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
| user_token | 否 | 非必填字段, 人员TOKEN |
请求数据示例:
{
"userIdList": [ "524288-8euoAJ1avCqrpqSyyV2FVYJVB" ,"524288-8euoAJ1avCqrpqSyyV2FVYJVC" ],
"departmentIdList":["524288-vAuMGGePYt7Oz7urrExFJxaVA"],
"msgType": "type",
"msgData":{
"type" :{
}
},
"//": "以下字段为选填字段,普通单入口应用不需要填",
"entryId":"154741",
}
请求参数字段说明:|参数|类型|必须|说明 | |------------------|----------|-------------|-----------------------------------------------------------------------| | userIdList | string array | 否 | 接收者人员列表,指定消息接收者时使用,可选,与departmentIdList二者间必选一个, 最多支持1000个| | departmentIdList | string array | 否 | 接收者分支列表(分支下的所有人),可选,与userIdList二者间必选一个,如果需要全组织广播,则填根分支Id:orgId-0,例如:524288-0, 最多支持100个, 全组织广播时,只支持1个组织 | | msgType | string | 是 | 发送的消息格式,支持以下几种:"text","oacard","linkCard","appCard" | | msgData | json obj | 是 | 和 type 类型名对应的同名的格式化数据。每种格式都有对应的数据类型。消息体类型 | | 以下字段选填| - |否|对于只有单入口的自建应用不需要填充该字段 | | entryId | string | 否 | 单应用多入口情况,如果不同入口有不同消息通道,可以使用该参数指定入口对应的消息通道。其他情况组织自研应用不需要填 |
返回参数字段说明:|参数|类型 |描述 | |-------------------|----------|---------------------------------------------------------------------------| | invalidStaff | string array | 请求staffIdList 列表中的人员ID 无效,无法发送 | | invalidDepartment | string array | 请求departmentIdList列表中的分支ID 无效,无法发送 | | msgId | string | 消息标识,供其他接口查询进度使用。目前只有组织内应用支持返回消息ID,ISV应用不返回ID |
返回数据示例:
业务正常返回:
{
"errCode":0 ,
"errMsg":"ok",
"data":{
"invalidStaff":["staffid1","staffid2"],
"invalidDepartment":["id1","id2"],
"msgId":"678590"
}
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
智能机器人发送群消息
接口说明:通过该接口,以智能机器人的身份给智能机器人所在的群发送系统定义的几种消息,使用场景参考智能机器人使用说明。当user_token不为空时,该接口同时支持以人员(自然人,需要是群成员)身份向群内发送消息。请求方式:POST (HTTPS),Content-Type: application/json请求地址:https://apigw-example.domain/v1/messages/group/create?app_token=APP_TOKEN&user_token=USER_TOKENquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
| user_token | 否 | 如果user_token不为空,则以人的身份发送群消息。支持智能机器人发送群消息,需要开启智能机器人能力,此时user_token不填 |
请求数据示例:
{
"groupId":"524288-AB4DDDABBKHIM",
"outlines":"[通知]xxx: xxxxxx",
"msgType": "type",
"msgData":{
"type" :{
}
}
}
请求参数字段说明:|参数|类型|必须|说明 | |------------|-------------|---------|---------------------------------------------------------------------------------| | groupId | string | 是 | 群openId,应用通过两种方式获取群Id,1,智能机器人群消息回调事件信息中包含群Id。2,可以通过开放平台接口查询智能机器人所在的群Id列表 获取机器人所在群列表 | | outlines | string | 否 | 目前只用于群通知的摘要信息 | | entryId | string | 否 | 单应用多入口情况,如果不同入口有不同消息通道,可以使用该参数指定入口对应的消息通道 | | msgType | string | 是 | 发送的消息格式,支持以下几种:text ,oacard | | msgData | json obj | 是 | 和 type 类型名对应的同名的格式化数据。每种格式都有对应的数据类型。消息体类型 |
返回参数字段说明:|参数|类型|描述 | |------------|------------|---------------------------------------| | msgId | string | 消息标识。供其他接口查询进度使用 |
返回数据示例:
业务正常返回:
{
"errCode":0 ,
"errMsg":"ok",
"data":{
"msgId":"678590"
}
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
查询智能机器人所属群ID列表
接口说明:查询智能机器人所属的群列表,分页接口请求方式:GET (HTTPS)请求地址:https://apigw-example.domain/v2/groups/fetch?app_token=APP_TOKEN&page_offset=PAGE_OFFSET&page_size=PAGESIZEquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
| page_offset | 否 | 分页查询页码,不填时默认第一页 |
| page_size | 否 | 分页查询的单页数量,最大值100,不填时默认100 |
返回参数字段说明:|参数|类型|描述 | |---------------|--------|----------| | totalGroupIds | int | 机器人所属的群的总数量 | | groupIds | string array | 群ID列表 |
返回数据示例:
业务正常返回:
{
"errCode": 0,
"errMsg": "ok",
"data": {
"totalGroupIds":2,
"groupIds": ["524288-xxxxxxxxxxx","524288-xxxxxxxxxx"]
}
}
业务异常返回:
{
"errCode": 错误码,
"errMsg": 对应的统一错误码描述
}
对应可能的错误码说明: