List Broadcasts

GET

https://platform-api.convirza.com/v3/broadcast

SMS Broadcasts

Last modified:2026-04-03 14:27:57

Returns a paginated list of SMS broadcasts with optional filtering.

Date filtering (optional, defaults to last 7 days):

By default, returns broadcasts from the last 7 days (UTC).

Use start and end parameters to specify a custom date range (ISO 8601, UTC).

Supported filters:

broadcast_name: partial case-insensitive match.

agent_name: partial case-insensitive match against sender name.

status: exact status value filter (scheduled, pending, cancelled, sent).

Pagination:

offset: number of records to skip (default: 0).

limit: maximum records to return (default: 100, max: 200).

Timestamps:

All timestamps (created_at, updated_at) are returned in ISO 8601 UTC format (e.g., "2026-03-29T12:00:00.000Z").

Response includes:

total: number of records matching current filters.

Per-broadcast delivery metrics such as messages_sent and responses.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Broadcast list fetched successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/broadcast?offset&limit&broadcast_name&agent_name&status&start&end' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "records": [
            {
                "bulk_sms_conversations_id": 1,
                "broadcast_name": "Spring Campaign",
                "agent_name": "John Doe",
                "status": "scheduled",
                "messages_sent": 1,
                "responses": 1,
                "created_at": "2026-03-29T12:00:00.000Z",
                "updated_at": "2026-03-29T12:30:00.000Z"
            }
        ],
        "total": 45
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Partial Update Provisioned Route

Create Broadcast