
# NoneBot.adapters.ding 模块
# exception DingAdapterException
基类:nonebot.exception.AdapterException
说明
钉钉 Adapter 错误基类
# exception ActionFailed
基类:nonebot.exception.ActionFailed
, nonebot.adapters.ding.exception.DingAdapterException
说明
API 请求返回错误信息。
参数
errcode: Optional[int]
: 错误码errmsg: Optional[str]
: 错误信息
# exception ApiNotAvailable
基类:nonebot.exception.ApiNotAvailable
, nonebot.adapters.ding.exception.DingAdapterException
# exception NetworkError
基类:nonebot.exception.NetworkError
, nonebot.adapters.ding.exception.DingAdapterException
说明
网络错误。
参数
retcode: Optional[int]
: 错误码
# exception SessionExpired
基类:nonebot.exception.ApiNotAvailable
, nonebot.adapters.ding.exception.DingAdapterException
说明
发消息的 session 已经过期。
# class Bot
钉钉 协议 Bot 适配。继承属性参考 BaseBot 。
# property type
- 返回:
"ding"
# async classmethod check_permission(driver, connection_type, headers, body)
说明
钉钉协议鉴权。参考 鉴权 (opens new window)
# async handle_message(body)
说明
处理上报消息的函数,转换为
Event
事件后调用nonebot.message.handle_event
进一步处理事件。参数
message: dict
: 收到的上报消息
# async call_api(api, event=None, **data)
说明
调用 钉钉 协议 API
参数
api: str
: API 名称**data: Any
: API 参数
返回
Any
: API 调用返回数据
异常
NetworkError
: 网络错误ActionFailed
: API 调用失败
# async send(event, message, at_sender=False, **kwargs)
说明
根据
event
向触发事件的主体发送消息。参数
event: Event
: Event 对象message: Union[str, Message, MessageSegment]
: 要发送的消息at_sender: bool
: 是否 @ 事件主体**kwargs
: 覆盖默认参数
返回
Any
: API 调用返回数据
异常
ValueError
: 缺少user_id
,group_id
NetworkError
: 网络错误ActionFailed
: API 调用失败
# class Event
钉钉 协议 Event 适配。继承属性参考 BaseEvent 。
# property raw_event
原始上报消息
# property id
类型:
Optional[str]
说明: 消息 ID
# property name
类型:
str
说明: 事件名称,由 type.`detail_type` 组合而成
# property self_id
类型:
str
说明: 机器人自身 ID
# property time
类型:
int
说明: 消息的时间戳,单位 s
# property type
类型:
str
说明: 事件类型
# property detail_type
类型:
str
说明: 事件详细类型
# property sub_type
类型:
None
说明: 钉钉适配器无事件子类型
# property user_id
类型:
Optional[str]
说明: 发送者 ID
# property group_id
类型:
Optional[str]
说明: 事件主体群 ID
# property to_me
类型:
Optional[bool]
说明: 消息是否与机器人相关
# property message
类型:
Optional[Message]
说明: 消息内容
# property reply
类型:
None
说明: 回复消息详情
# property raw_message
类型:
Optional[str]
说明: 原始消息
# property plain_text
类型:
Optional[str]
说明: 纯文本消息内容
# property sender
类型:
Optional[dict]
说明: 消息发送者信息
# class MessageSegment
基类:nonebot.adapters.BaseMessageSegment
钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
# static actionCardSingleMultiBtns(title, text, btns=[], hideAvatar=False, btnOrientation='1')
参数
btnOrientation
: 0:按钮竖直排列 1:按钮横向排列btns
: [{ "title": title, "actionURL": actionURL }, ...]
# static feedCard(links=[])
参数
links
: [{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...]
# static empty()
不想回复消息到群里
# class Message
基类:nonebot.adapters.BaseMessage
钉钉 协议 Message 适配。