Skip to main content

Channel Messages (List/Create)

Use these endpoints to read channel messages and create external messages.

Get Channel Messages​

Request​

  • Method: GET
  • URL: https://chattz.net/api/v1/channels/{CHANNEL_ID}/messages
  • Auth: Required (the community API key)

Path parameters:

  • CHANNEL_ID (required): 12-digit channel ID

Query parameters:

  • limit (optional): 1-100, default 50
  • offset (optional): >=0, default 0

Success Fields​

  • channel_id
  • limit
  • offset
  • messages (array)

Message object fields:

  • message_id
  • channel_id
  • sender_username
  • sender_profile_picture_data_url
  • username
  • avatar
  • timestamp (unix)
  • content
  • external_user (present on external messages)

Example​

curl "https://chattz.net/api/v1/channels/123456789012/messages?limit=20&offset=0" \
  -H "X-Chattz-Api-Key: YOUR_KEY"

Create External Message​

Request​

  • Method: POST
  • URL: https://chattz.net/api/v1/channels/{CHANNEL_ID}/messages
  • Auth: Required (the community API key)

Path parameters:

  • CHANNEL_ID (required): 12-digit channel ID

JSON body:

  • content (required, max 4000 chars)
  • external_user (required, object)
  • external_user.username (required, max 120 chars)
  • external_user.avatar (required, data URL image)

Success​

  • HTTP 201
  • code: "message_created"
  • message object (same structure as message list entries)

Example​

curl -X POST "https://chattz.net/api/v1/channels/123456789012/messages" \
  -H "Content-Type: application/json" \
  -H "X-Chattz-Api-Key: YOUR_KEY" \
  -d '{
    "content": "Hello from external integration",
    "external_user": {
      "username": "Integration Bot",
      "avatar": "data:image/png;base64,..."
    }
  }'