API : IPTV : Settings : Upload background image

Introduction

This request is used to upload a background image for the customer, to be used as the background on STBs.

The picture will be stored as a 1280×720 pixels PNG, if the uploaded picture does not conform to this size, it will be scaled and cropped to fit the size.

The upload must be performed as a multipart/form-data post request.

Request

URL	https://api.telecomx.dk/iptv/settings/CUSTOMER_ID/backgroundimage
Method	POST
Access level	MANAGER or OWNER if customer has feature IPTVBUSINESS RESELLER if customer has IPTVBUSINESS or IPTVPRIVATE ADMIN
Params	CUSTOMER_ID	Id of the customer to upload the logo to
Body	file	Binary image data

Request example

POST https://api.telecomx.dk/iptv/settings/1234567890ABCDEF1234578/backgroundimage

Response

Json object
success	Boolean	True on success.

Example

{
  success: true,
  backgroundImage: '123456789012345678901234',
  backgroundImageUrl: 'https:/api.telecomx.dk/iptv/settings/12345678901234567890ABCD/smalllogo'
}

Errors

Error code	Message	Description
404	id	Not found
409	customer	Customer cannot host common IPTV settings
404	file	The file was missing or invalid
422	file	Filetype must be PNG or JPG
403	access_denied	Insufficient access level
500	internal_error	Failed to scale/crop image
500	internal_error	<unspecified>

WIKI

Table of Contents