To update a Switchboard provide the switchboard_id and a new priority stream list of streams to play when they are published.
Changes will be pushed to active switchboards, but will not take effect until the current stream is unpublished or a higher priority stream is published. To force an update set recheck_list to true.
$request = array( 'command' => 'switchboard.update', 'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE', 'timestamp' => time(), 'cdn' => 158, 'switchboard_id' => 1, 'stream_list' => array("stream1","stream2","stream3"), 'recheck_list' => true, //optional 'origin_url' => 'jb-chorigin.secdn.net', // optional 'ga_key' => '', //optional ); //Create request signature $json_request = json_encode($request); $sig = base64_encode(hash_hmac('sha256', $json_request, '8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f', true)); $request['signature'] = $sig; $json_request = json_encode($request); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://api.scaleengine.net/stable/'); // Set the URL curl_setopt($ch, CURLOPT_POST, true); // Perform a POST curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // If not set, curl prints output to the browser curl_setopt($ch, CURLOPT_HEADER, false); // If set, curl returns headers as part of the data stream curl_setopt($ch, CURLOPT_POSTFIELDS, array('json' => $json_request)); //'Json' string or 'PHP' serialized return //If your PHP host does not have a proper SSL certificate bundle, you will need to turn off SSL Certificate Verification //This is dangerous, and should only be done temporarily until a proper certificate bundle can be installed //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate. //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate. $response = curl_exec($ch); //Execute the API Call if (!$response) { die('Failed to connect to ScaleEngine API'); } //Decode the response as an associative array $arrResponse = json_decode($response, true); if ($arrResponse) { //Operation completed successfully //TODO Add work here print_r($arrResponse); } else { //Operation failed echo 'An error occured processing your request:'; print_r($response); }
command | [REQUIRED] [string] - API command to execute |
cdn | [REQUIRED] [int] - The ScaleEngine CDN ID of your account |
api_key | [REQUIRED] [string] - The API key provided as part of your account |
switchboard_id | [REQUIRED] [int] - The ID of Switchboard |
stream_list | [REQUIRED] [array] - Array of Stream Names |
timestamp | [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed |
recheck_list | [OPTIONAL] [boolean] - Servers are notified when a list is added, modified, or removed, but will not interrupt the current source unless set to true. Default false. |
origin_url | [REQUIRED] [string] - Defines the url address of an origin to be called. Defaults to jb-origin.secdn.net for origins and jb-chorigin.secdn.net for channels. |
ga_key | [OPTIONAL] [String] - The Google analytics (GA) key to be used when a stream or channel is viewed. This key is used to capture viewer data and send it to the associated GA account. GA Keys saved to a channel will be applied to all playlists on that channel, and if no key is provided the default GA key for the your ScaleEngine account will be used. (default "") |
{ "message": "Switchboard updated", "status": "success", "handle_time":"0.3795 seconds" }
message | [string] - Debugging message |
status | [string] - "success" or "failure" |
switchboard_id | [int] - ID of the Switchboard |
handle_time | [float] - The amount of time spent processing your request |