Poll Request Action
The Poll Request action provides a channel to push requests to a player instantly, and outside of the regular player poll mechanism. It can be used to get information such as information required to play campaigns, its configuration, and so on. Broadsign Control Player will also send its Proof-of-Plays and Incidents during that poll.
Note: The Poll Request action can be used only with the Broadsign Control Administrator /host/v17/push_request REST API method.
Note: The Poll Request action is used with Broadsign Control Live. However, we must enable it on your domain. For more information, contact your Sales representative or Broadsign Services.
You can put the following string in the /host/v17/push_request call of the REST API:
{
"rc": {
"version": "1",
"id": "1-adbc",
"action": "poll_request"
}
}
The API will respond with the following:
{
"host": [
{
"message": "Push request sent to player id <player_id>",
"player_id": "<player_id>"
}
],
"not_modified_since": "2017-12-06T15:36:32Z"
}
Poll Request Action - JSON Parameters
Parameter | Description |
---|---|
version | Mandatory. The version is always 1. |
id | Mandatory. Represents a client-generated unique identifier for the request. This will be passed back unchanged in the HTTP request headers. Maximum any 64 characters. |
action | Mandatory. The kind of action to be taken; always poll_request. |