Get Broadcast
Get the status of your broadcast message
The Get Broadcast API is for users to get the status of the broadcast message that is sent via API. The {id} is the broadcast id obtained after calling the Send Broadcast Message API
get
Query parameters
sessionstringRequired
The session key generated by your admin for controlling which channel is allowed to send message across API
Header parameters
X-USER-TOKENstringRequired
The secret key provided by iSlash for accessing the iSlash API platform
Responses
200
Success
application/json
get
GET /api/public/broadcast/{id} HTTP/1.1
Host: {islash_api_endpoint}
X-USER-TOKEN: text
Accept: */*
200
Success
{
"meta": {
"code": "text",
"message": "text"
},
"data": {
"broadcast": {
"id": 1,
"name": "text",
"status": "text",
"attach_label": {},
"total_recipients": 1,
"progress": 1,
"scheduled_at": 1,
"started_at": 1,
"ended_at": 1,
"reply_count": {}
}
}
}
{
"meta": {
"code": "RESP_OKAY",
"message": "Success",
"trace_id": "a28d8bd80c5950ce"
},
"data": {
"broadcast": {
"id": 95,
"name": "API Broadcast",
"status": "pending",
"attach_label": {
"id": 2,
"text": "Pending Payment",
"color": "blue"
},
"total_recipients": 2,
"progress": 0,
"scheduled_at": 1667793600,
"started_at": null,
"ended_at": null,
"reply_count": {
"12_hours": 0,
"24_hours": 0,
"48_hours": 0
}
}
}
}
Last updated