wecom-cliis a command-line program provided by WeCom; all operations are completed by executing thewecom-clicommand.
Interact with the WeCom message system via wecom-cli msg <接口名> '<json入参>' .
Interface list
get_msg_chat_list — Get conversation list
wecom-cli msg get_msg_chat_list '{"begin_time": "2026-03-11 00:00:00", "end_time": "2026-03-17 23:59:59"}'
Query the list of conversations with messages by time range, with pagination support. See API details。
get_message — Retrieve conversation messages
wecom-cli msg get_message '{"chat_type": 1, "chatid": "zhangsan", "begin_time": "2026-03-17 09:00:00", "end_time": "2026-03-17 18:00:00"}'
Retrieve message records within a specified time range based on conversation type and ID, with pagination support. Supports text/image/file/voice/video message types, and only supports messages within 7 days. See API details。
get_msg_media — Get message file content
wecom-cli msg get_msg_media '{"media_id": "MEDIAID_xxxxxx"}'
Automatically download the file locally based on the file ID, and return the file's local path (local_path), name, type, size, and MIME type. Used to retrieve the actual content of non-text messages such as images, files, voice, and video. See API details。
send_message — Send text message
wecom-cli msg send_message '{"chat_type": 1, "chatid": "zhangsan", "msgtype": "text", "text": {"content": "hello world"}}'
Send a text message to a one-on-one chat or group chat. See API details。
Core rules
Time range rules
- Format: All time parameters use the
YYYY-MM-DD HH:mm:ssformat - Default range: When the user does not specify, use the last 7 days by default (7 days back from the current time)
- Limit: The start time cannot be earlier than 7 days before the current time, and cannot be later than the current time
- Relative time support: Supports automatic calculation such as "yesterday" and "the last three days"
chatid lookup rules
- When the user provides a person name or group name instead of an ID:
- Call
get_msg_chat_listto get the conversation list (the time range is consistent with the target query) - In
chats, match bychat_nameMatch - Matching strategy:
- Exact match with a unique result: use it directly
- Fuzzy match with multiple results: display the candidate list for the user to choose
- No match: inform the user that nothing was found
- Call
- chat_type determination:
get_msg_chat_listThe returned result does not contain a conversation type field, so it must be inferred from context: when the user explicitly mentions "group", usechat_type=2; otherwise default tochat_type=1(one-on-one chat)
userid to username
Process:
- Call
wecomcli-lookup-contact get_userlistto get the user list - Establish the mapping relationship from userid to username
- Display strategy:
- Exact match: display username
- No match: keep displaying userid
Mandatory interaction steps (cannot be skipped)
The following steps, when involving non-text message downloads,must be executed one by one, and must not be merged, omitted, or skipped, even if the user did not actively ask:
- Must proactively inform the file location: After the download is complete, the full paths and storage directories of all files must be immediately shown to the user
- Must ask whether to delete: After informing the location, must immediately ask the user whether the temporary files need to be cleaned up
Typical workflow
View session list
User query example:
- "See which chats I have had in the last week"
- "Who has sent me messages these past few days"
Execution process:
- Determine the time range (user-specified or default to the last 7 days)
- Call
get_msg_chat_listto get the session list - Display the session name, last message time, and message count
- If
has_moreistrue, tell the user there are more sessions they can continue viewing
View chat records
User query example:
- "Help me look at my recent chat records with Zhang San"
- "Look at the recent messages in the project group"
Execution process:
- Determine the time range (user-specified or default to the last 7 days)
- Using the chatid lookup rule determine the target session's
chatidandchat_type - Call
get_messageto pull the message list - Call
wecomcli-lookup-contact'sget_userlistto get the contacts and build a userid→name mapping - Count non-text messages: Traverse the message list and count the number and types of messages where
msgtypeis nottext(image/file/voice/video) - When displaying messages, replace
useridwith readable names, format:- Text message:
姓名 [时间]: 内容 - Image message:
姓名 [时间]:[图片] - File message:
姓名 [时间]:[文件] 文件名称 - Voice message:
姓名 [时间]:[语音] 语音内容 - Video message:
姓名 [时间]:[视频]
- Text message:
- Non-text message handling: After displaying the messages, if non-text messages exist:
- Proactively ask whether to download: Tell the user the number and types of non-text messages (e.g.: "The above chat contains 2 images and 1 file. Do you need to download them locally?")
- After the user confirms, call the
get_msg_mediainterface one by one; the interface will automatically download the file and returnlocal_path - Check the file extension: After each file is downloaded, check whether the file corresponding to
local_pathhas the correct extension:- Based on
get_msg_mediareturned bycontent_type(MIME type) and thenamefield, determine:- If the file name lacks an extension (e.g.
screenshotinstead ofscreenshot.png), based oncontent_typeautomatically add the correct extension (e.g.image/png→.png,application/pdf→.pdf,audio/amr→.amr,video/mp4→.mp4) - If the file name extension is inconsistent with
content_type, usecontent_typeas the standard for correction
- If the file name lacks an extension (e.g.
- After completing or correcting the extension, rename the file to the correct file name
- Confirm the file can be read normally (file size > 0). If the file is empty or corrupted, tell the user that the file download is abnormal
- Based on
- ⚠️ Do not use the
MEDIA:instruction on downloaded files: These files are historical attachments downloaded from the chat history; it is only necessary to inform the user of the local storage path,strictly prohibitedto resend them to the user via theMEDIA:instruction
- ⚠️ Must proactively inform the file location(this step cannot be skipped): after all files are downloaded and checked,must immediately and proactivelyshow the user the file storage directory and the complete path of each file in summary form; do not wait for the user to ask. Example:
📁 Files have been downloaded to the following locations:
- Images:
xxx/yyy.png - Files:
xxx/yyy.pdf
You can find all downloaded files in the
xxx/yyy/directory. - Images:
- ⚠️ Must ask whether to delete(this step cannot be skipped): after informing the file location,must immediately and proactivelyask the user whether the downloaded temporary files need to be deleted (e.g., "If you no longer need these files, would you like me to clean them up for you?")
- After the user confirms deletion, delete the file corresponding to
local_pathcorresponding file - If the user does not need deletion, keep the files
- After the user confirms deletion, delete the file corresponding to
- If
next_cursoris not empty, inform the user that there are more messages to continue viewing
Send message
User query example:
- "Help me send a message to Zhang San: tomorrow's meeting is changed to 3 PM"
- "Send a message in the project group: the meeting is at 3 PM today"
Execution flow:
- Determine the target session's chatid lookup rule and
chatidviachat_type - Confirm before sending: confirm the recipient and content with the user (e.g., "About to send to Zhang San: 'tomorrow's meeting is changed to 3 PM', confirm sending?"), and execute only after the user confirms
- Call
send_messageto send (msgtypeis fixed totext) - Display sending result
View messages and reply
User query example:
- "See what Zhang San sent me, then help me reply 'received'"
Execution flow:
- First execute the "View chat history" flow (reuse the already obtained
chatidandchat_type) - After displaying the messages, execute the "Send message" flow (must confirm before sending)
Error handling
- Time range exceeded: inform the user of the 7-day limit and adjust to a valid range
- Session not found: clearly inform the user that the corresponding session was not found
- API error: display the specific error information and retry if necessary
- Network issue: on HTTP errors, proactively retry up to 3 times`