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

GEThttps://{ISLASH_API_ENDPOINT}/api/public/broadcast/{id}

Query parameters

Header parameters

Response

200

Success

Body

application/json

metaobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://{ISLASH_API_ENDPOINT}/api/public/broadcast/{id}', {
    method: 'GET',
    headers: {
      "X-USER-TOKEN": "text"
    },
});
const data = await response.json();

Response

200

{
  "meta": {
    "code": "text",
    "message": "text"
  },
  "data": {
    "broadcast": {
      "id": 0,
      "name": "text",
      "status": "text",
      "total_recipients": 0,
      "progress": 0,
      "scheduled_at": 0,
      "started_at": 0,
      "ended_at": 0
    }
  }
}

Sample Response

{
    "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
            }
        }
    }
}