Text message

./scripts/send_text.sh <access_token> "Hello World"

Rich text message

./scripts/send_rich_text.sh <access_token> '[{"tag":"text","style":["bold"],"text":"Bold"}]'

Card message

./scripts/send_card.sh <access_token> <template_uuid> <instance_uuid> [variable_map]


## Available Scripts

### Authentication (2 APIs)
| Script | API | Description |
|--------|-----|-------------|
| `get_token.sh` | POST /robots/v1/token | Get access token |
| `refresh_token.sh` | POST /robots/v1/token/refresh | Refresh access token |

### Message APIs (8 APIs)
| Script | API | Description |
|--------|-----|-------------|
| `send_text.sh` | POST /robots/v1/im/send-msg | Send text message |
| `send_rich_text.sh` | POST /robots/v1/im/send-msg | Send rich text with styles |
| `send_card.sh` | POST /robots/v1/im/send-msg | Send card message |
| `send_image.sh` | POST /robots/v1/im/send-msg | Send image message |
| `send_file.sh` | POST /robots/v1/im/send-msg | Send file/audio/image |
| `update_card.sh` | PUT /robots/v1/im/msg-card | Update card message |
| `config_callback.sh` | POST /robots/v1/im/msg-card/callback | Configure card callback |
| `recall_message.sh` | POST /robots/v1/im/{msgId}/recall | Recall message |
| `get_read_status.sh` | POST /robots/v1/im/{msgId}/read-ack-detail | Get read/unread status |

### File APIs (3 APIs)
| Script | API | Description |
|--------|-----|-------------|
| `upload_file_info.sh` | POST /robots/v1/im/file | Register file upload |
| `upload_file_content.sh` | POST {uploadUrl} | Upload file content |
| `download_file.sh` | POST /robots/v1/im/file/{fileId}/download | Get download URL |

### Group/Team APIs (8 APIs)
| Script | API | Description |
|--------|-----|-------------|
| `create_team.sh` | POST /robots/v1/team | Create a new group |
| `invite_to_team.sh` | POST /robots/v1/team/{tid}/invite | Invite users to group |
| `drop_team.sh` | DELETE /robots/v1/team/{tid}/drop | Delete/dismiss group |
| `get_group_info.sh` | GET /robots/v1/team/{teamId}/info | Get group info |
| `get_group_members.sh` | GET /robots/v1/team/{teamId}/members | Get group members |
| `get_group_list.sh` | GET /robots/v1/team/list | Get group list |
| `update_team_info.sh` | PUT /robots/v1/team/{tid}/info | Update group info |
| `update_team_management.sh` | POST /robots/v1/team/{tid}/management | Update group settings |

### Instruction APIs (2 APIs)
| Script | API | Description |
|--------|-----|-------------|
| `get_instructions.sh` | GET /robots/v1/instruction/list | Get instruction list |
| `trigger_instruction.sh` | POST /robots/v1/instruction/trigger | Trigger instruction |

### View Scope APIs (2 APIs)
| Script | API | Description |
|--------|-----|-------------|
| `get_view_scope.sh` | GET /robots/v1/view-scope | Get view scope |
| `update_view_scope.sh` | PUT /robots/v1/view-scope | Update view scope |

## Message Types Reference

### Rich Text Styles
- `bold` - Bold text
- `italic` - Italic text
- `underline` - Underlined text
- `strikethrough` - Strikethrough text
- `font_color` - Colored text (red, orange, purple, green)
- `background_color` - Background color
- `link` - Hyperlink

### Rich Text Tags
- `text` - Plain text with optional styles
- `at` - @mention user (email: "user@corp.netease.com" or "all")
- `image` - Inline image (url)

## Complete API Reference

See [references/api_reference.md](references/api_reference.md) for:
- Full API documentation
- Request/response examples
- Error codes
- Rate limits

## Common Workflows

### Send a Simple Text Message
```bash
TOKEN=$(./scripts/get_token.sh $POPO_APP_KEY $POPO_APP_SECRET | jq -r '.data.accessToken')
./scripts/send_text.sh "$TOKEN" "user@corp.netease.com" "Hello from POPO API!"

Send Rich Text with Formatting

CONTENT='[
  {"tag":"text","style":["bold","underline"],"text":"Title"},
  {"tag":"text","text":"\nNormal text "},
  {"tag":"text","style":["italic"],"text":"italic"},
  {"tag":"text","text":"\n@"},
  {"tag":"at","email":"user@corp.netease.com"}
]'
./scripts/send_rich_text.sh "$TOKEN" "user@corp.netease.com" "$CONTENT"

Upload and Send a File

# 1. Calculate MD5
MD5=$(md5 -q file.pdf)

# 2. Register file
RESPONSE=$(./scripts/upload_file_info.sh "$TOKEN" "pdf" "document.pdf" "$MD5")
FILE_KEY=$(echo $RESPONSE | jq -r '.data.fileKey')
UPLOAD_URL=$(echo $RESPONSE | jq -r '.data.uploadUrl')

# 3. Upload content
./scripts/upload_file_content.sh "$UPLOAD_URL" "$TOKEN" "file.pdf"

# 4. Send file message
./scripts/send_file.sh "$TOKEN" "user@corp.netease.com" "$FILE_KEY" "file"

Send a Card Message

TEMPLATE_UUID="your_template_uuid"
INSTANCE_UUID="unique_instance_$(date +%s)"
VARIABLES='{"title":{"zh-CN":"卡片标题"},"content":"卡片内容"}'

./scripts/send_card.sh "$TOKEN" "user@corp.netease.com" "$TEMPLATE_UUID" "$INSTANCE_UUID" "$VARIABLES"

Create a Group/Team

# Create group with at least 2 members
./scripts/create_team.sh "$TOKEN" "owner@corp.netease.com" "My Group" '["user1@corp.netease.com","user2@corp.netease.com"]'

# Response: {"tid": "8194891", "passNum": 2, "failList": {}}

Invite Users to Group

./scripts/invite_to_team.sh "$TOKEN" "8194891" '["newuser@corp.netease.com"]' 1 "Welcome!"

Error Handling

Common error codes:

42001 - Access token expired, refresh or re-acquire
42002 - Refresh token expired, re-acquire token
65338 - Message too long
65341 - Receiver not a POPO user
65347 - No API permission
65611 - Receiver not found
65612 - User not in robot's view scope

Limits

Text message: 3000 characters
Rich text: 5000 characters (including tags)
File upload: 20MB max
Rate limit: 60 messages/minute per robot
Token validity: 24 hours
Refresh token: 30 days

popo-robot-api

POPO Robot API Skill

Quick Start

1. Set Environment Variables (Optional)

2. Get Access Token

3. Send a Message