Get broadcast information

Description

Retrieves detailed information about a broadcast campaign.

Request URL

Method: POST

https://example.com/api/v1.1/campaigns/broadcasts/get

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
id	int	11768	Yes	Campaign ID
format	string	"json"	No	Response data format. By default – json

Request example

{
    "id": 11768,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
    "data": {
        "aglimit_count": 0,
        "aglimit_percent": 0,
        "content": [
            {
                "from_email": "",
                "from_name": "",
                "message_id": 4,
                "replyto_email": "",
                "replyto_name": "",
                "subject": "Hello"
            }
        ],
        "content_type": "",
        "custom_tracking_domains": [],
        "data_id": 2416,
        "data_type": "segment",
        "id": 4428,
        "is_active": false,
        "is_random_tracking_prefix": false,
        "limit": 0,
        "name": "Broadcast campaign name",
        "resource_id": 1,         
		"send_channel": "email",
        "channel": "email",
        "start_schedule": {
            "start_hours": [
                0
            ],
            "start_mdays": [
                1
            ],
            "start_mins": [
                0
            ],
            "start_months": [
                12
            ],
            "start_wdays": [],
            "start_years": [
                2016
            ]
        },
        "subid": "api_campaign",
        "virtual_sender_id": 98,
        "watcher_limit": 0,
        "watcher_list_id": 0
    },
    "error": 0,
    "error_text": "Successful operation"
}

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Campaign ID
name	string	Campaign name
is_active	bool	Campaign active flag
resource_id	int	Resource ID
data_id	int	Audience source ID
data_type	string	Audience source type
content	JSON array	Message template object
send_channel	string	Sending channel
channel	string	Channel
for_confirm	bool	Messages with opt-in link flag
subid	string	Campaign SubID
start_schedule	JSON object	Start schedule object
limit	int	Campaign cycle limitation
aglimit_count	int	Increase limit each cycle - number
agllimit_percent	float	Increase limit each cycle - percent
policy_id	int	Sending policy ID
push_sending_mode	string	Push notification sending mode (push channels only)
descr	string	Campaign description
Smart settings
virtual_sender_id	int	Virtual sender ID (Smart accounts)
is_random_tracking_prefix	bool	Random tracking domain prefix (Smart accounts)
custom_tracking_domains	JSON array	Tracking domains list (Smart accounts)
blind_carbon_copy	JSON array	Hidden copy email addresses (Smart accounts)
unconditional_sending	bool	Send messages regardless of subscription status (Smart accounts)
watcher_list_id	int	Campaign watchers database ID (Smart accounts)
watcher_limit	int	Watchers limit (Smart accounts)