68 lines
2.6 KiB
Markdown
68 lines
2.6 KiB
Markdown
# im +flag-create
|
|
|
|
> **Prerequisite:** Read [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) for authentication, global parameters, and security rules.
|
|
|
|
This skill maps to shortcut: `lark-cli im +flag-create`. Underlying API: `POST /open-apis/im/v1/flags`.
|
|
|
|
## Default Behavior
|
|
|
|
- **Message-layer flag** (default): `item_type=default, flag_type=message`
|
|
- **Feed-layer flag**: Use `--flag-type feed` — automatically detects chat type to determine `item_type`:
|
|
- Topic-style chat (`chat_mode=topic`) → `item_type=thread`
|
|
- Regular chat (`chat_mode=group`) → `item_type=msg_thread`
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
# Flag a message (default: message-layer)
|
|
lark-cli im +flag-create --as user --message-id om_xxx
|
|
|
|
# Create feed-layer flag (auto-detects chat type)
|
|
lark-cli im +flag-create --as user --message-id om_xxx --flag-type feed
|
|
|
|
# Explicit item-type override (rarely needed)
|
|
lark-cli im +flag-create --as user --message-id om_xxx --item-type thread --flag-type feed
|
|
|
|
# Preview request (dry-run, doesn't send)
|
|
lark-cli im +flag-create --as user --message-id om_xxx --dry-run
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Required | Description |
|
|
|------|------|------|
|
|
| `--message-id <om_xxx>` | Required | Message ID |
|
|
| `--flag-type <name>` | No | `message` (default) or `feed` |
|
|
| `--item-type <name>` | No | Override auto-detection: `default\|thread\|msg_thread` (rarely needed) |
|
|
| `--as user` | Required | Currently only supports user identity |
|
|
|
|
## Valid Combinations
|
|
|
|
The server only accepts these `(item_type, flag_type)` pairs:
|
|
|
|
- `(default, message)` — regular message flag
|
|
- `(thread, feed)` — feed flag in topic-style chat
|
|
- `(msg_thread, feed)` — feed flag in regular chat
|
|
|
|
## Permissions
|
|
|
|
- Required scopes: `im:feed.flag:write`, `im:message.group_msg:get_as_user`, `im:message.p2p_msg:get_as_user`, `im:chat:read`
|
|
- The message/chat read scopes are used when `--flag-type feed` is used without explicit `--item-type` so the CLI can auto-detect chat type.
|
|
- If missing, CLI will prompt with `lark-cli auth login --scope "..."`
|
|
|
|
## Note
|
|
|
|
- **Do not call +flag-list for verification**: If the create API returns success, the flag is created. Calling +flag-list to verify is expensive (requires full pagination) and unnecessary.
|
|
|
|
## Finding Message ID Efficiently
|
|
|
|
If you have message content but not the message ID:
|
|
|
|
1. **Use `+messages-search`** to find the message by content, then extract `message_id` from the result
|
|
2. **Do NOT use `+flag-list`** to find the message — it requires full pagination and is very inefficient
|
|
|
|
```bash
|
|
# Search by message content to find message_id
|
|
lark-cli im +messages-search --as user --query "message content here" -q '.data.items[0].message_id'
|
|
```
|