ChatWork Scraper

Extract conversations, member lists, and tasks from ChatWork rooms via the ChatWork API v2. Export team collaboration data for analysis, archiving, and integration.

Features

• Extract Room Data: Retrieve all room information including message counts, file counts, and task counts
• Message Export: Fetch and export messages with sender details, timestamps, and message bodies
• Member Management: Extract room member lists with roles, departments, and organization info
• Task Tracking: Download tasks with assignments, deadlines, and status information
• Flexible Filtering: Target specific rooms or process all rooms in your workspace
• Configurable Limits: Control message retrieval limits (1-1000 per room)
• Rate Limiting: Built-in delays to respect ChatWork API rate limits
• Structured Output: JSON format ready for integration with downstream tools

Use Cases

• Team Communication Audit: Extract and analyze conversation history for compliance and documentation
• Knowledge Base Building: Export team discussions and decisions for internal wikis and knowledge repositories
• Project Handover: Collect room data, members, and task status for project transitions
• Data Backup: Create comprehensive backups of ChatWork conversations and collaboration data
• Analytics Integration: Export team communication metrics to BI tools and analytics platforms
• Migration Support: Prepare ChatWork data for integration with other communication platforms

Input

{
  "apiToken": "your-chatwork-api-token",
  "roomIds": ["123456", "789012"],
  "includeMessages": true,
  "includeMembers": true,
  "includeTasks": true,
  "messageLimit": 100
}

Input Parameters

Parameter	Type	Required	Default	Description
apiToken	string	Yes	-	ChatWork API token for authentication. Get this from ChatWork Account Settings > API Token
roomIds	array	No	-	Specific room IDs to scrape. If empty, all accessible rooms will be fetched
includeMessages	boolean	No	true	Whether to fetch messages for each room
includeMembers	boolean	No	false	Whether to fetch member list for each room
includeTasks	boolean	No	false	Whether to fetch tasks for each room
messageLimit	integer	No	100	Maximum number of messages to fetch per room (1-1000)

Output

{
  "roomId": 123456,
  "roomName": "Development Team",
  "roomType": "group",
  "role": "admin",
  "messageCount": 1520,
  "fileCount": 45,
  "taskCount": 12,
  "lastUpdateTime": "2024-02-12T15:30:45.000Z",
  "messages": [
    {
      "messageId": "msg123456",
      "senderName": "John Doe",
      "senderId": 98765,
      "body": "Great work on the project!",
      "sendTime": "2024-02-12T14:20:00.000Z",
      "updateTime": "2024-02-12T14:21:00.000Z"
    }
  ],
  "members": [
    {
      "accountId": 98765,
      "name": "John Doe",
      "chatworkId": "john.doe",
      "role": "admin",
      "organizationName": "Engineering",
      "department": "Backend Team"
    }
  ],
  "tasks": [
    {
      "taskId": 54321,
      "body": "Review pull request",
      "assignedTo": "Jane Smith",
      "assignedBy": "John Doe",
      "status": "open",
      "limitTime": "2024-02-15T17:00:00.000Z",
      "limitType": "time"
    }
  ]
}

Pricing

$2.50 per 1,000 API calls

Example Costs

Scenario	API Calls	Cost
10 rooms, messages only	11	$0.03
50 rooms with members	101	$0.25
100 rooms with messages + members + tasks	301	$0.75
500 rooms, all data types	1,501	$3.75

Note: Each room data fetch = 1 call, each message fetch = 1 call, each member fetch = 1 call, each task fetch = 1 call.

Tips

1. Get Your API Token: Log in to ChatWork, go to Account Settings > API Token tab, and copy your personal API token
2. Start with Small Tests: Use roomIds parameter to test with 1-2 rooms before processing all rooms
3. Control Message Volume: Adjust messageLimit based on your needs. Lower values (50-100) are faster; higher values (500+) extract more history
4. Optimize with Flags: Disable includeMembers and includeTasks if you only need messages to reduce API calls
5. Handle Rate Limits: The scraper includes 500ms delays between API requests to respect ChatWork's rate limits
6. Room IDs as Strings: Convert numeric room IDs to strings when specifying in roomIds array
7. Export Frequency: Consider scheduling this actor to run daily or weekly for backup and monitoring use cases

Integrations

Export your extracted ChatWork data to:

• Google Sheets: Use Apify's Google Sheets integration to automatically append rows
• Excel/CSV: Download dataset as CSV and open in Excel or Google Sheets
• Webhooks: Send data to your custom webhooks for real-time processing
• REST API: Query extracted data via Apify's API
• Zapier/Make: Connect via webhooks to automate downstream workflows
• Data Warehouse: Export to BigQuery, Snowflake, or PostgreSQL
• Slack: Post summaries to Slack channels using webhooks

Support

For issues, feature requests, or questions:

• Check the Apify community forum
• Review ChatWork API documentation
• Open an issue on the project repository

License

Apache-2.0 License