alicebot.adapter.dingtalk.event

DingTalk 适配器事件。

class UserInfo

Bases: pydantic.main.BaseModel

用户信息

• Attributes

  • dingtalkId (str)

  • staffId (str | None)

class Text

Bases: pydantic.main.BaseModel

文本消息

• Attributes

  • content (str)

class DingTalkEvent

Bases: alicebot.event.MessageEvent[DingTalkAdapter]

DingTalk 事件基类

• Attributes

  • type (str | None)

  • msgtype (str)

  • msgId (str)

  • createAt (str)

  • conversationType (Literal['1', '2'])

  • conversationId (str)

  • conversationTitle (str | None)

  • senderId (str)

  • senderNick (str)

  • senderCorpId (str | None)

  • sessionWebhook (str)

  • sessionWebhookExpiredTime (int)

  • isAdmin (bool | None)

  • chatbotCorpId (str | None)

  • isInAtList (bool | None)

  • senderStaffId (str | None)

  • chatbotUserId (str)

  • atUsers (list[alicebot.adapter.dingtalk.event.UserInfo])

  • text (Text)

  • response_msg (None | str | dict[str, typing.Any] | alicebot.adapter.dingtalk.message.DingTalkMessage)

  • response_at (None | dict[str, typing.Any] | alicebot.adapter.dingtalk.message.DingTalkMessage)

method get_plain_text(self)

获取消息的纯文本内容。

• Returns

  Type: str

  消息的纯文本内容。

method get_sender_id(self)

获取消息的发送者的唯一标识符。

• Returns

  Type: str

  消息的发送者的唯一标识符。

readonly property message

Type: alicebot.adapter.dingtalk.message.DingTalkMessage

返回 message 字段。

async method reply(self, message, at = None)

回复消息。

• Arguments

  • message (str | dict[str, typing.Any] | alicebot.adapter.dingtalk.message.DingTalkMessage) - 回复消息的内容，可以是 str, Dict 或 DingTalkMessage。

  • at (None | dict[str, typing.Any] | alicebot.adapter.dingtalk.message.DingTalkMessage) - 回复消息时 At 的对象，必须时 at 类型的 DingTalkMessage，或者符合标准的 Dict。

• Returns

  Type: dict[str, typing.Any]

  调用 Webhook 地址后钉钉服务器的响应。

• Raises

  • WebhookExpiredError - 当前事件的 Webhook 地址已经过期。

  • ... - 同 DingTalkAdapter.send() 方法。