API Documentation

Status

Use status APIs to publish text, image, voice, and video updates from a connected dashboard session. Add contacts when you want to target specific contacts.

Common rules

Authentication

Send Authorization: Bearer YOUR_API_KEY with every request.

Session

Use the dashboard session name, such as {session}, or the session ID.

Media

For image, voice, and video, file must include mimetype plus url or data.

Endpoints

Method Endpoint Purpose
POST https://chatflow.zeltacode.com/api/v1/status/text Publish a text status. Omit contacts to send to the default status audience.
POST https://chatflow.zeltacode.com/api/v1/status/image Publish an image status by URL or base64 data.
POST https://chatflow.zeltacode.com/api/v1/status/voice Publish a voice status by URL or base64 data.
POST https://chatflow.zeltacode.com/api/v1/status/video Publish a video status by URL or base64 data.

1. Send text status

Publish a text status. Omit contacts to send to the default status audience.

API name

Send text status

Purpose

Publish a text status. Omit contacts to send to the default status audience. Use this when your application needs to publish temporary updates from a connected session.

Endpoint

POST https://chatflow.zeltacode.com/api/v1/status/text
curl 
curl -X POST "https://chatflow.zeltacode.com/api/v1/status/text" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "session": "{session}",
    "text": "Have a look! https://chatflow.zeltacode.com",
    "backgroundColor": "#38b42f",
    "font": 1,
    "contacts": [
        "{number}@c.us"
    ]
}'
JSON body 
{
    "session": "{session}",
    "text": "Have a look! https://chatflow.zeltacode.com",
    "backgroundColor": "#38b42f",
    "font": 1,
    "contacts": [
        "{number}@c.us"
    ]
}
Example response 
{
    "success": true,
    "message": "Status action completed.",
    "data": {
        "action": "text",
        "session": "{session}",
        "status_response": {
            "id": "false_status@broadcast_STATUS_MESSAGE_ID"
        }
    }
}

2. Send image status

Publish an image status by URL or base64 data.

API name

Send image status

Purpose

Publish an image status by URL or base64 data. Use this when your application needs to publish temporary updates from a connected session.

Endpoint

POST https://chatflow.zeltacode.com/api/v1/status/image
curl 
curl -X POST "https://chatflow.zeltacode.com/api/v1/status/image" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "session": "{session}",
    "file": {
        "mimetype": "image/jpeg",
        "url": "https://picsum.photos/600/600"
    },
    "caption": "Image status test",
    "contacts": [
        "{number}@c.us"
    ]
}'
JSON body 
{
    "session": "{session}",
    "file": {
        "mimetype": "image/jpeg",
        "url": "https://picsum.photos/600/600"
    },
    "caption": "Image status test",
    "contacts": [
        "{number}@c.us"
    ]
}
Example response 
{
    "success": true,
    "message": "Status action completed.",
    "data": {
        "action": "image",
        "session": "{session}",
        "status_response": {
            "id": "false_status@broadcast_STATUS_MESSAGE_ID"
        }
    }
}

3. Send voice status

Publish a voice status by URL or base64 data.

API name

Send voice status

Purpose

Publish a voice status by URL or base64 data. Use this when your application needs to publish temporary updates from a connected session.

Endpoint

POST https://chatflow.zeltacode.com/api/v1/status/voice
curl 
curl -X POST "https://chatflow.zeltacode.com/api/v1/status/voice" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "session": "{session}",
    "file": {
        "mimetype": "audio/mpeg",
        "url": "https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3"
    },
    "contacts": [
        "{number}@c.us"
    ]
}'
JSON body 
{
    "session": "{session}",
    "file": {
        "mimetype": "audio/mpeg",
        "url": "https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3"
    },
    "contacts": [
        "{number}@c.us"
    ]
}
Example response 
{
    "success": true,
    "message": "Status action completed.",
    "data": {
        "action": "voice",
        "session": "{session}",
        "status_response": {
            "id": "false_status@broadcast_STATUS_MESSAGE_ID"
        }
    }
}

4. Send video status

Publish a video status by URL or base64 data.

API name

Send video status

Purpose

Publish a video status by URL or base64 data. Use this when your application needs to publish temporary updates from a connected session.

Endpoint

POST https://chatflow.zeltacode.com/api/v1/status/video
curl 
curl -X POST "https://chatflow.zeltacode.com/api/v1/status/video" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "session": "{session}",
    "file": {
        "mimetype": "video/mp4",
        "url": "https://samplelib.com/lib/preview/mp4/sample-5s.mp4"
    },
    "caption": "Video status test",
    "backgroundColor": "#38b42f",
    "contacts": [
        "{number}@c.us"
    ]
}'
JSON body 
{
    "session": "{session}",
    "file": {
        "mimetype": "video/mp4",
        "url": "https://samplelib.com/lib/preview/mp4/sample-5s.mp4"
    },
    "caption": "Video status test",
    "backgroundColor": "#38b42f",
    "contacts": [
        "{number}@c.us"
    ]
}
Example response 
{
    "success": true,
    "message": "Status action completed.",
    "data": {
        "action": "video",
        "session": "{session}",
        "status_response": {
            "id": "false_status@broadcast_STATUS_MESSAGE_ID"
        }
    }
}