Yach开放平台

# 群聊

# 创建群

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/create?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_name String 是 群名称
group_owner String 是 群主userid 例如yach091805
group_userids String 是 群成员列表，半角竖线分割开来，group_userids 人数不得超过1000人
source Int 否 群类型（0:普通群 3:审批群 4:项目群，102:应用模版群，默认0）
tpl_id String 否 当模版群时，必填，这个字段目前只能群组服务手动提供,联系 李东军(197237) 获取
tpl_ext String 否 非必填，如果群应用跳转需要业务参数，必填
unique_key String 否 唯一值，用于验证幂等性，没有该参数，每个请求会自动生成一个

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "group_id": "2771361680",//群ID，即group_tid
        "name": "测试建群",
        "pic": "群头像链接地址"
    }
}

# 修改群聊

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/edit?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
group_name String 否 群名称
group_owner String 否 群主userid 例如yach091805
invite_uid String 否 邀请人的userid 例如yach091805
tpl_id String 否 当模版群时，必填，这个字段目前只能群组服务手动提供,联系 李东军(197237) 获取
tpl_ext String 否 非必填，如果群应用跳转需要业务参数，必填
del_useridlist String 否 删除群成员列表，竖线分割开来，del_useridlist 人数不得超过40人
add_useridlist String 否 添加群成员列表，竖线分割开来，add_useridlist 人数不得超过40人

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "group_yach_id": 49560636174241884 //本次更新唯一ID
    }
}

# 获取群基本信息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/info?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "group": {
                  "group_tid": "2771348607",
                  "group_name": "好好学习",
                  "group_icon": "",
                  "group_users_count": 3,
                  "group_owner": "Yach076429",
                  "group_manager":{
                      "Yach111",
                      "Yach222"
                  }
              },
              "uidlist": [ // 该接口只返回20个群成员，如需获取全部成员请使用群成员列表接口
                  "Yach137620",
                  "Yach076429",
                  "Yach091805"
              ]
    }
}

# 查询用户是否在群里

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/checkin?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
user_id String 是 员工yach唯一标识，示例：yach076429

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "status": 1（1:在群里面 0:不在群里面）
    }
}

# 获取群成员列表

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/users/list?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
page String 否 当前页数，默认1
count String 否 每页显示条数，最大100

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "total":100, // 群成员总数
        "list": [
            {
                 "uuid": "Yach137620", // 用户yachid
                 "name": "好好学习", // 用户姓名
                 "pic": "", // 用户头像
                 "group_users_type": 0 // 用户在群里的类型（0:群主 1:管理员 2:普通用户）
            },
            {
                 "uuid": "Yach076429", // 用户yachid
                 "name": "天天向上", // 用户姓名
                 "pic": "", // 用户头像
                 "group_users_type": 2 // 用户在群里的类型（0:群主 1:管理员 2:普通用户）
            }
    }
}

# 获取群管理员和群主

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/manager?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id

返回值

{
    "code": 200,
    "msg": "",
    "obj": [
            {
                 "uuid": "Yach137620", // 用户yachid
                 "name": "好好学习", // 用户姓名
                 "work_code": "123001", // 用户工号
                 "group_users_type": 0 // 用户在群里的类型（0:群主 1:管理员 2:普通用户）
            },
            {
                 "uuid": "Yach076429", // 用户yachid
                 "name": "天天向上", // 用户姓名
                 "work_code": "456001", // 用户工号
                 "group_users_type": 2 // 用户在群里的类型（0:群主 1:管理员 2:普通用户）
            }
    ]
}

# 获取/搜索用户所管理的群列表

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/manage/list
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
user_id String 是 用户的yachid
group_name String 否 群名称

返回值

{
    "code": 200,
    "msg": "",
    "obj": [
        {
             "group_tid": "3821638765", // 群组id
             "group_name": "好好学习", // 群组名称
             "group_icon": "", // 群组头像
             "group_users_count": 10 // 群人数
        }
    ]
}

# 添加群成员

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/users/add?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
userid_list String 是 用户的yachid列表，Json字符串，示例：['Yach076429', 'Yach137620']
op_uid String 是 邀请人的yachid
group_type int 否 1为话题群，否则为普通群

返回值

{
    "code": 200,
    "msg": "",
    "obj": {}
}

# 移除群成员

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/users/del?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
userid_list String 是 用户的yachid列表，Json字符串，示例：["Yach076429", "Yach137620"]
op_uid String 是 操作用户的yachid

返回值

{
    "code": 200,
    "msg": "",
    "obj": {}
}

# 更换群主

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/changeowner?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
new_owner String 是 新群主的yachid
old_owner String 是 旧群主的yachid

返回值

{
    "code": 200,
    "msg": "",
    "obj": {}
}

# 设置群管理员

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/setadmin?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
admin_users String 是 要设置的管理员yachid列表，Json字符串（单次最多10个管理员）
owner_uid String 是 群主的yachid

返回值

{
    "code": 200,
    "msg": "",
    "obj": {}
}

# 取消群管理员

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /group/removeadmin?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
admin_users String 是 要取消的管理员yachid列表，Json格式（单次最多10个管理员）
owner_uid String 是 群主的yachid

返回值

{
    "code": 200,
    "msg": "",
    "obj": {}
}

# 获取群应用scheme

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /openapi/v2/group/app/info?access_token=ACCESS_TOKEN
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
group_tid String 是 群id
work_code String 是 操作人工号

返回值

{
  "code":200,
  "msg":"success",
  "obj":{
    "url":"yach://xxxxxxx?token=xxxx&group_tid=xxx"
  }
}

# 获取数字伙伴所在群聊

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /openapi/v2/dify/robot/groups?access_token=ACCESS_TOKEN
请求方式 GET
参数 无入参，只有access_token
返回值 见【返回值】

返回值

{
  "code":200,
  "msg":"success",
  "obj":[
    {
        "group_tid":"342432424",
        "group_name":"我是一个群",
        "group_owner":"我是群主",
        "group_type":100
    }
  ]
}

# 获取会话历史记录

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /openapi/v2/im/messages
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数（URL参数）

参数 参数类型 必须 说明
access_token String 是 调用接口凭证（示例值：NHhmZXp0VEtwMExJTzhxxxxxxx）
start_time Number 是 消息查询开始时间戳（秒级，示例值：1773331200）
end_time Number 是 消息查询结束时间戳（秒级，示例值：1773787125）
page_size Number 是 每页查询条数（示例值：100）
group_id String 是 群组ID（示例值：123456）
include_no_sense_msg Boolean 否 是否包含无意义消息（示例值：false）
descending Boolean 否 是否降序排列（示例值：false）
page_token String 否 分页令牌，用于翻页（示例值：xsVbx59PxsQ6wsnxxxxxxx）

# 请求示例（curl）

curl --request GET \
  --url 'https://yach-oapi-test.zhiyinlou.com/openapi/v2/im/messages?start_time=1773331200&end_time=1773787125&page_size=100&group_id=123456&access_token=NHhmZXp0VEtwMExJTzhjxxxxxx&include_no_sense_msg=false&descending=false&page_token=xsVbx59PxsQ6wsnRwERPxrxcwxxxxxxx' \
  --header 'Accept: */*' \
  --header 'Accept-Encoding: gzip, deflate, br' \
  --header 'Connection: keep-alive' \
  --header 'User-Agent: PostmanRuntime-ApipostRuntime/1.1.0'

# 返回值

（响应状态码200为请求成功（接口层面），非200为请求失败；业务层面需结合返回体中的code判断）

{
  "code": 200,
  "obj": {
    "messages": [
      {
        "senderName": "xxx",
        "uuid": "709828699444474149",
        "content": "<details>   <summary>点我展开看代码</summary>  # 方式1   <pre><code> code... </code></pre>   # 方式2   ```编程语言 code...```  </details>",
        "time": 1773632578585,
        "type": "card",
        "workCode": "xxx",
        "userType": 1
      },
      {
        "senderName": "xxx",
        "uuid": "709828699444474149",
        "content": "<details>   <summary>点我展开看代码</summary>  # 方式1   <pre><code> code... </code></pre>   # 方式2   ```编程语言 code...```  </details>",
        "time": 1773632549879,
        "type": "card",
        "workCode": "xxx",
        "userType": 1
      }
    ],
    "page_info": {
      "page_token": "",
      "has_more": false
    }
  },
  "msg": ""
}

← 普通消息 →

foo