Camel.toolkits.dingtalk

​

_get_dingtalk_access_token

def _get_dingtalk_access_token():

​

_make_dingtalk_request

def _make_dingtalk_request(method: Literal['GET', 'POST'], endpoint: str, **kwargs):

• method (Literal["GET", "POST"]): HTTP method to use.
• endpoint (str): API endpoint path. **kwargs: Additional arguments passed to requests.

• Exception: If API request fails or returns error.

​

_generate_signature

def _generate_signature(secret: str, timestamp: str):

• secret (str): Webhook secret.
• timestamp (str): Current timestamp.

​

DingtalkToolkit

class DingtalkToolkit(BaseToolkit):

​

init

def __init__(self, timeout: Optional[float] = None):

• timeout (Optional[float]): Timeout for API requests in seconds.

​

_initialize_token_safely

def _initialize_token_safely(self):

​

dingtalk_send_text_message

def dingtalk_send_text_message(self, userid: str, content: str):

• userid (str): The user’s userid.
• content (str): Message content.

​

dingtalk_send_markdown_message

def dingtalk_send_markdown_message(
    self,
    userid: str,
    title: str,
    markdown_content: str
):

• userid (str): The user’s userid.
• title (str): Message title.
• markdown_content (str): Markdown formatted content.

​

dingtalk_get_user_info

def dingtalk_get_user_info(self, userid: str):

• userid (str): The user’s userid.

​

dingtalk_get_department_list

def dingtalk_get_department_list(self, dept_id: Optional[int] = None):

• dept_id (Optional[int]): Department ID. If None, gets root departments.

​

dingtalk_get_department_users

def dingtalk_get_department_users(
    self,
    dept_id: int,
    offset: int = 0,
    size: int = 100
):

• dept_id (int): Department ID.
• offset (int): Offset for pagination (default: 0). (default: 0)
• size (int): Number of users to retrieve (default: 100, max: 100). (default: 100, max: 100)

​

dingtalk_search_users_by_name

def dingtalk_search_users_by_name(self, name: str):

• name (str): User name to search for.

​

dingtalk_send_webhook_message

def dingtalk_send_webhook_message(
    self,
    content: str,
    msgtype: Literal['text', 'markdown', 'link', 'actionCard'] = 'text',
    title: Optional[str] = None,
    webhook_url: Optional[str] = None,
    webhook_secret: Optional[str] = None
):

• content (str): Message content.
• msgtype (Literal): Message type (text, markdown, link, actionCard).
• title (Optional[str]): Message title (required for markdown).
• webhook_url (Optional[str]): Webhook URL. If None, uses env var.
• webhook_secret (Optional[str]): Webhook secret. If None, uses env var.

​

dingtalk_create_group

def dingtalk_create_group(
    self,
    name: str,
    owner: str,
    useridlist: List[str]
):

• name (str): Group name.
• owner (str): Group owner’s userid.
• useridlist (List[str]): List of user IDs to add to the group.

​

dingtalk_send_group_message

def dingtalk_send_group_message(
    self,
    chatid: str,
    content: str,
    msgtype: Literal['text', 'markdown'] = 'text'
):

• chatid (str): Group chat ID.
• content (str): Message content.
• msgtype (Literal["text", "markdown"]): Message type.

​

dingtalk_send_link_message

def dingtalk_send_link_message(
    self,
    userid: str,
    title: str,
    text: str,
    message_url: str,
    pic_url: Optional[str] = None
):

• userid (str): The user’s userid.
• title (str): Link title.
• text (str): Link description text.
• message_url (str): URL to link to.
• pic_url (Optional[str]): Picture URL for the link.

​

dingtalk_send_action_card_message

def dingtalk_send_action_card_message(
    self,
    userid: str,
    title: str,
    text: str,
    single_title: str,
    single_url: str
):

• userid (str): The user’s userid.
• title (str): Card title.
• text (str): Card content text.
• single_title (str): Action button title.
• single_url (str): Action button URL.

​

dingtalk_get_user_by_mobile

def dingtalk_get_user_by_mobile(self, mobile: str):

• mobile (str): User’s mobile number. Should be a valid Chinese mobile number format (11 digits starting with 1).

​

dingtalk_get_user_by_unionid

def dingtalk_get_user_by_unionid(self, unionid: str):

• unionid (str): User’s unique identifier across all DingTalk organizations. This is a global identifier that remains consistent even if the user belongs to multiple DingTalk organizations, unlike userid which is organization-specific.

​

dingtalk_get_department_detail

def dingtalk_get_department_detail(self, dept_id: int):

• dept_id (int): Department ID.

​

dingtalk_send_oa_message

def dingtalk_send_oa_message(
    self,
    userid: str,
    message_url: str,
    head_bgcolor: str,
    head_text: str,
    body_title: str,
    body_content: str
):

• userid (str): The user’s userid.
• message_url (str): URL for the message action.
• head_bgcolor (str): Header background color (hex format).
• head_text (str): Header text.
• body_title (str): Body title.
• body_content (str): Body content.

​

dingtalk_get_group_info

def dingtalk_get_group_info(self, chatid: str):

• chatid (str): Group chat ID.

​

dingtalk_update_group

def dingtalk_update_group(
    self,
    chatid: str,
    name: Optional[str] = None,
    owner: Optional[str] = None,
    add_useridlist: Optional[List[str]] = None,
    del_useridlist: Optional[List[str]] = None
):

• chatid (str): Group chat ID.
• name (Optional[str]): New group name.
• owner (Optional[str]): New group owner userid.
• add_useridlist (Optional[List[str]]): List of user IDs to add.

​

dingtalk_send_work_notification

def dingtalk_send_work_notification(
    self,
    userid_list: List[str],
    msg_content: str,
    msg_type: Literal['text', 'markdown'] = 'text'
):

• userid_list (List[str]): List of user IDs to send to.

​

dingtalk_get_userid_by_phone

def dingtalk_get_userid_by_phone(self, phone_number: str):

• phone_number (str): User’s phone number.

​

dingtalk_get_userid_by_name

def dingtalk_get_userid_by_name(self, user_name: str):

• user_name (str): User’s display name.

​

dingtalk_get_department_id_by_name

def dingtalk_get_department_id_by_name(self, department_name: str):

• department_name (str): Department name to search for.

​

dingtalk_get_chatid_by_group_name

def dingtalk_get_chatid_by_group_name(self, group_name: str):

• group_name (str): Group name to search for.

​

get_tools

def get_tools(self):