Get Broadcast Details

GET

https://platform-api.convirza.com/v3/broadcast/{broadcast_id}

SMS Broadcasts

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

Fetches complete details for one broadcast by conversation ID.

Returned dataset includes:

Broadcast metadata: name, message, tracking number, agent ring-to number.

Unique recipient destination numbers for this broadcast.

Aggregated recipient count (total_recipients).

Schedule information (next_run_date) when a pending schedule exists.

Validation and errors:

broadcast_id must be a positive integer.

Returns 400 when the broadcast does not exist.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Broadcast details fetched successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/broadcast/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "broadcast_name": "string",
        "message": "string",
        "phone_number": "string",
        "agent_ring_to": "string",
        "contact_list_id": 1,
        "destination_numbers": [
            "string"
        ],
        "total_recipients": 1,
        "schedule": {
            "next_run_date": "string"
        }
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

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

Create Broadcast

Update Broadcast