会话接口

class dingtalk.client.api.Chat(client=None)

create(name, owner, useridlist, show_history_type=False, searchable=0, validation_type=0, mention_all_authority=0, chat_banned_type=0, management_type=0)

创建会话

参数:

• name – 群名称。长度限制为1~20个字符
• owner – 群主userId，员工唯一标识ID；必须为该会话useridlist的成员之一
• useridlist – 群成员列表，每次最多支持40人，群人数上限为1000
• show_history_type – 新成员是否可查看聊天历史消息（新成员入群是否可查看最近100条聊天记录）
• searchable – 群可搜索，0-默认，不可搜索，1-可搜索
• validation_type – 入群验证，0：不入群验证（默认） 1：入群验证
• mention_all_authority – @all 权限，0-默认，所有人，1-仅群主可@all
• chat_banned_type – 群禁言，0-默认，不禁言，1-全员禁言
• management_type – 管理类型，0-默认，所有人可管理，1-仅群主可管理

返回:

群会话的id

get(chatid)

获取会话

参数:chatid – 群会话的id 返回:群会话信息

get_read_list(message_id, cursor=0, size=100)

查询群消息已读人员列表

参数:

• message_id – 发送群消息接口返回的加密消息id
• cursor – 分页查询的游标，第一次传0，后续传返回结果中的next_cursor。返回结果中没有next_cursor时，表示没有后续的数据了
• size – 分页查询的大小，最大可以传100

返回:

send(chatid, msg_body)

发送群消息

参数:

• chatid – 群会话的id
• msg_body – BodyBase 消息体

返回:

加密的消息id

update(chatid, name=None, owner=None, add_useridlist=(), del_useridlist=(), icon='', chat_banned_type=0, searchable=0, validation_type=0, mention_all_authority=0, show_history_type=False, management_type=0)

修改会话

参数:

• chatid – 群会话的id
• name – 群名称。长度限制为1~20个字符，不传则不修改
• owner – 群主userId，员工唯一标识ID；必须为该会话成员之一；不传则不修改
• add_useridlist – 添加成员列表，每次最多支持40人，群人数上限为1000
• del_useridlist – 删除成员列表，每次最多支持40人，群人数上限为1000
• icon – 群头像mediaid
• chat_banned_type – 群禁言，0-默认，不禁言，1-全员禁言
• searchable – 群可搜索，0-默认，不可搜索，1-可搜索
• validation_type – 入群验证，0：不入群验证（默认） 1：入群验证
• mention_all_authority – @all 权限，0-默认，所有人，1-仅群主可@all
• show_history_type – 新成员是否可查看聊天历史消息（新成员入群是否可查看最近100条聊天记录）
• management_type – 管理类型，0-默认，所有人可管理，1-仅群主可管理

返回: