# 群聊管理接口

# 获取群列表

GET https://hub.juzibot.com/api/v1/groupChat/list?token=*&current=*&pageSize=*

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
current string 当前页数
pageSize string 每页数据条数

TIP

该API支持批量拉取群信息,最大pageSize为100

# 返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data":[{
    "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ",
    "name": "群名称",
    "owner": "owner",
    "createTime": 1532336327,
    "notice": "群公告",
    "memberList": [{
      "type": 1,
      "userId": "userId",
      "joinTime": 1605001966,
      "joinScene": 1
    }, {
      "type": 2,
      "userId": "externalUserId",
      "joinTime": 1605001977,
      "joinScene": 1
    }]
  }],
  "total": 10
}

# 返回参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容
data.chatId string 客户群ID
data.name string 群名
data.owner string 群主ID
data.createTime number 群的创建时间
data.notice string 群公告
data.memberList.userid string 群成员id
data.memberList.type string 成员类型。1 - 企业成员, 2 - 外部联系人
data.memberList.joinTime number 入群时间
data.memberList.joinScene number 入群方式。1 - 由成员邀请入群(直接邀请入群, 2 - 由成员邀请入群(通过邀请链接入群), 3 - 通过扫描群二维码入群

# 获取群信息

POST https://hub.juzibot.com/api/v1/groupChat/get?token=*

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
groupChatIds array 群聊id列表

TIP

该API支持批量拉取群信息,groupChatIds的数组长度最大为100

# 返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data":[{
    "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ",
    "name": "群名称",
    "owner": "owner",
    "createTime": 1532336327,
    "notice": "群公告",
    "memberList": [{
      "type": 1,
      "userId": "userId",
      "joinTime": 1605001966,
      "joinScene": 1
    }, {
      "type": 2,
      "userId": "externalUserId",
      "joinTime": 1605001977,
      "joinScene": 1
    }]
  }],
  "total": 10
}

# 返回参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容
data.chatId string 客户群ID
data.name string 群名
data.owner string 群主ID
data.createTime number 群的创建时间
data.notice string 群公告
data.memberList.userid string 群成员id
data.memberList.type string 成员类型。1 - 企业成员, 2 - 外部联系人
data.memberList.joinTime number 入群时间
data.memberList.joinScene number 入群方式。1 - 由成员邀请入群(直接邀请入群, 2 - 由成员邀请入群(通过邀请链接入群), 3 - 通过扫描群二维码入群

# 绑定句客宝ID

POST https://hub.juzibot.com/api/v1/groupChat/bindWxId?token=*

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
jkbChatId string 句客宝ID
wxId string 微信群官方ID

# 请求示例:

{
  "jkbChatId": "worRhyBgAAO1az2jnN1xa44DIliYPetQ",
  "wxId": "R:10696051011030627"
}

# 返回示例:

{
  "errcode": 0,
  "errmsg": "ok"
}
错误码 说明
-1 根据token找不到有效的corp
404 wxId没有找到
500 调用存储过程中失败
最近更新: 2021/8/18 下午3:38:26