Skip to content

alicebot.adapter.dingtalk

DingTalk 协议适配器。

本适配器适配了钉钉企业自建机器人协议。 协议详情请参考:钉钉开放平台

class DingTalkAdapter

Bases: alicebot.adapter.Adapter

钉钉协议适配器。

  • Attributes

    • name (str)

    • app (aiohttp.web_app.Application)

    • runner (aiohttp.web_runner.AppRunner)

    • site (aiohttp.web_runner.TCPSite)

    • session (aiohttp.client.ClientSession)

class Config

Bases: alicebot.config.ConfigModel

DingTalk 配置类,将在适配器被加载时被混入到机器人主配置中。

  • Attributes

    • host (str) - 本机域名。

    • port (int) - 监听的端口。

    • url (str) - 路径。

    • api_timeout (int) - 进行 API 调用时等待返回响应的超时时间。

    • app_secret (str) - 机器人的 appSecret

method __init__(__pydantic_self__, **data) {#BaseModel.__init__}

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

  • Arguments

    • data (Any)
  • Returns

    Type: None

method __init__(self, bot) {#Adapter.__init__}

初始化。

  • Arguments

    • bot (Bot) - 当前机器人对象。
  • Returns

    Type: None

method get_sign(self, timestamp) {#DingTalkAdapter.get_sign}

计算签名。

  • Arguments

    • timestamp (str) - 时间戳。
  • Returns

    Type: str

    签名。

async method handler(self, request)

处理 aiohttp 服务器的接收。

  • Arguments

    • request (aiohttp.web_request.Request) - aiohttp 服务器的 Request 对象。
  • Returns

    Type: aiohttp.web_response.Response

async method run(self)

运行 aiohttp 服务器。

  • Returns

    Type: None

async method send(self, webhook, conversation_type, msg, at = None)

发送消息。

  • Arguments

    • webhook (str) - Webhook 网址。

    • conversation_type (Literal['1', '2']) - 聊天类型,"1" 表示单聊,"2" 表示群聊。

    • msg (Union[str, Dict[str, Any], alicebot.adapter.dingtalk.message.DingTalkMessage]) - 消息。

    • at (Union[NoneType, Dict[str, Any], alicebot.adapter.dingtalk.message.DingTalkMessage]) - At 对象,仅在群聊时生效,默认为空。

  • Returns

    Type: Dict[str, Any]

    钉钉服务器的响应。

  • Raises

    • TypeError - 传入参数类型错误。

    • ValueError - 传入参数值错误。

    • NetworkError - 调用 Webhook 地址时网络错误。

async method shutdown(self)

清理 aiohttp AppRunner。

  • Returns

    Type: None

async method startup(self)

创建 aiohttp Application。

  • Returns

    Type: None

Released under the MIT License.