v5.0_Tally
- Ramya Raman
Owned by Ramya Raman
Tally supports GET, POST and DELETE API calls. PUT is not supported.
GET tally/command
Resource Information
Requires Authentication? | Yes |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all Tally in the system, with its main configuration data.
Resource URL
http://{{ip_address}}:{{port}}/api/{{version}}/tally/command
Example Request
GET
{
"data": [
{
"label": "TSL_0_2",
"duration": "Permanent",
"items": [
{
"type": "Tally",
"index": 0,
"color": "#CC2222",
"blink": null
},
{
"type": "Tally",
"index": 1,
"color": "#22CC22",
"blink": "#CC22CC"
},
{
"type": "UMD",
"index": 0,
"color": "#2222DD",
"text": "sample text",
"blink": null
},
{
"type": "UMD",
"index": 1,
"color": "#ff22cc",
"text": "#bitrate#",
"blink": null
},
{
"type": "UMD",
"index": 2,
"color": "#f0a0a0",
"text": "#resolution# #bitrate#",
"blink": null
},
{
"type": "UMD",
"index": 3,
"color": "#f0f0f0",
"text": "#RGBa02020##T1#",
"blink": null
},
{
"type": "Timer",
"index": 0,
"timestamp": "1970-01-01T00:27:18.000Z",
"color": "#80f080",
"blink": "#EE22EE"
},
{
"type": "Timer",
"index": 1,
"timestamp": "2021-03-07T14:44:41.000Z",
"color": "#80f080",
"blink": "#ffffff"
},
{
"type": "Image",
"index": 0,
"url": "logo[00..99].jpg"
}
]
}
]
}
POST tally/command
Resource Information
Requires Authentication? | Yes |
Response Formats | json |
HTTP Methods | POST |
Add a new Tally, configured according to the attached data request.
Resource URL
http://{{ip_address}}:{{port}}/api/{{version}}/tally/command
Example Request
POST
Body
{
"data": {
"label": "TSL_0_2",
"duration": 0,
"items": [
{
"type": "tally",
"index": 0,
"color": "#CC2222"
},
{
"type": "tally",
"index": 1,
"color": "#22CC22",
"blink": "#CC22CC"
},
{
"type": "umd",
"index": 0,
"color": "#2222DD",
"text": "sample text"
},
{
"type": "umd",
"index": 1,
"color": "#ff22cc",
"text": "#bitrate#"
},
{
"type": "umd",
"index": 2,
"color": "#f0a0a0",
"text": "#resolution# #bitrate#"
},
{
"type": "umd",
"index": 3,
"color": "#f0f0f0",
"text": "#RGBa02020##T1#"
},
{
"type": "timer",
"index": 0,
"timestamp": 1638,
"color": "#80f080",
"blink": "#EE22EE"
},
{
"type": "timer",
"index": 1,
"timestamp": 1615128281,
"color": "#80f080",
"blink": "#ffffff"
},
{
"type": "image",
"index": 0,
"url": "logo[00..99].jpg"
}
]
}
}Response
{
"data": {
"label": "TSL_0_2",
"duration": "Permanent",
"items": [
{
"type": "Tally",
"index": 0,
"color": "#CC2222",
"blink": null
},
{
"type": "Tally",
"index": 1,
"color": "#22CC22",
"blink": "#CC22CC"
},
{
"type": "UMD",
"index": 0,
"color": "#2222DD",
"text": "sample text",
"blink": null
},
{
"type": "UMD",
"index": 1,
"color": "#ff22cc",
"text": "#bitrate#",
"blink": null
},
{
"type": "UMD",
"index": 2,
"color": "#f0a0a0",
"text": "#resolution# #bitrate#",
"blink": null
},
{
"type": "UMD",
"index": 3,
"color": "#f0f0f0",
"text": "#RGBa02020##T1#",
"blink": null
},
{
"type": "Timer",
"index": 0,
"timestamp": "1970-01-01T00:27:18.000Z",
"color": "#80f080",
"blink": "#EE22EE"
},
{
"type": "Timer",
"index": 1,
"timestamp": "2021-03-07T14:44:41.000Z",
"color": "#80f080",
"blink": "#ffffff"
},
{
"type": "Image",
"index": 0,
"url": "logo[00..99].jpg"
}
]
},
"metadata": {
"config_version": 0
}
}
DELETE tally/command/{label}
Resource Information
Requires Authentication? | Yes |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific Tally.
Resource URL
http://{{ip_address}}:{{port}}/api/{{version}}/tally/command/{label}
Parameters
Parameter | Data Type | Description |
|---|---|---|
label | string | The UUID of the channel to be deleted. |
Example Request
DELETE