消息接口

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

asyncsend(msg_body, agent_id, userid_list=(), dept_id_list=(), to_all_user=False)

企业会话消息异步发送

参数:

• msg_body – BodyBase 消息体
• agent_id – 微应用的id
• userid_list – 接收者的用户userid列表
• dept_id_list – 接收者的部门id列表
• to_all_user – 是否发送给企业全部用户

返回:

任务id

asyncsend_v2(msg_body, agent_id, userid_list=(), dept_id_list=(), to_all_user=False)

企业会话消息异步发送

参数:

• msg_body – BodyBase 消息体
• agent_id – 微应用的id
• userid_list – 接收者的用户userid列表
• dept_id_list – 接收者的部门id列表
• to_all_user – 是否发送给企业全部用户

返回:

任务id

asyncsendbycode(code, msg_body, agent_id, userid_list=(), dept_id_list=(), to_all_user=False)

通过用户授权码异步向企业会话发送消息

参数:

• code – 用户操作产生的授权码
• msg_body – BodyBase 消息体
• agent_id – 微应用的id
• userid_list – 接收者的用户userid列表
• dept_id_list – 接收者的部门id列表
• to_all_user – 是否发送给企业全部用户

返回:

任务id

static get_pc_url(url, pc_slide=True)

消息链接能在PC端打开

参数:

• url – 要打开的链接
• pc_slide – 如果为true代表在PC客户端打开，为false或者不写代表用浏览器打开

返回:

getsendprogress(agent_id, task_id)

获取异步发送企业会话消息的发送进度

参数:

• agent_id – 发送消息时使用的微应用的id
• task_id – 发送消息时钉钉返回的任务id

返回:

getsendresult(agent_id=None, task_id=None)

获取异步向企业会话发送消息的结果

参数:

• agent_id – 微应用的agentid
• task_id – 异步任务的id

返回:

list_message_status(message_id)

获取企业通知消息已读未读状态

参数:message_id – 消息id 返回:

media_download_file(media_id)

获取媒体文件

参数:media_id – 媒体文件的唯一标示 返回:requests 的 Response 实例

media_upload(media_type, media_file)

上传媒体文件

参数:

• media_type – 媒体文件类型，分别有图片（image）、语音（voice）、普通文件(file)
• media_file – 要上传的文件，一个 File-object

返回:

recall(agent_id, msg_task_id)

撤回工作通知消息

参数:

• agent_id – 发送工作通知的微应用agentId
• msg_task_id – 发送工作通知返回的taskId

send(agentid, msg_body, touser_list=(), toparty_list=())

发送企业通知消息

参数:

• agentid – 企业应用id，这个值代表以哪个应用的名义发送消息
• msg_body – BodyBase 消息体
• touser_list – 员工id列表
• toparty_list – 部门id列表

返回:

send_by_code(code, msg_body)

企业通知消息接口（用户反馈式）

参数:

• code – 用户操作产生的授权码
• msg_body – BodyBase 消息体

返回:

send_to_conversation(sender, cid, msg_body)

发送普通消息

参数:

• sender – 消息发送者员工ID
• cid – 群消息或者个人聊天会话Id
• msg_body – BodyBase 消息体

返回: