 | TABLE OF CONTENTS |
Recordings (VIA HTML)
A "VIA HTML recording" is a reconstruction of a Via HTML activity as it took place. They are named "playback" in the API. |  |
Playback/edit
 | Modifies information about an existing recording. |
Request
Example of request call content to modify information about a recording:
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"title": {
"texts": [
{
"text": "enregistrement1",
"languageId": 1
},
{
"text": "recording1",
"languageId": 2
}
]
},
"expirationDate": "2020-10-10T09:00:00",
"accessType": 1,
"hyperlink": "2dhfwwoh6jqh"
}Field descriptions
Name | Required | Comments/description |
id | X | Unique identifier of the recording. |
title text languageId |
| Text : Title of the recording. (String type) languageId: The title can be multilingual:
(Number type) |
| expirationDate | End date of the ability to access the recording. The date provided is included. (String YYYY-MM-DDTHH:MM:SSZ) | |
hyperlink |
| Public hyperlink of the recording. Modifies only the end of the link. For example: if "2dhfwwoh6jqh" is specified, the generated link would look like https://www.domaine.com/lienactivité/2dhfwwoh6jqh |
accessType |
| Defines the access level for this recording.
(Number type) |
Response
Example of the response call content for a request to modify information about a recording:
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Field descriptions
Name | Required | Comments/description |
id | Unique identifier of the recording. |
Playback/get
 | Retrieves information about an existing recording. |
Request
Example of request call content for information about a recording:
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d"
}Field descriptions
Name | Required | Comments/description |
id | X | Unique identifier of the recording. |
Response
Example of the response call content for an information request about a recording:
{
"PlaybackIDNoEnc": 28710,
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d",
"sessionId": "9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"title": {
"texts": [
{
"text": "Enregistrement #93",
"languageId": 1
},
{
"text": "Recording #93",
"languageId": 2
},
{
"text": "Grabación nro.93",
"languageId": 3
},
{
"text": "Enregistrement #93",
"languageId": 4
}
],
"ErrorID": 0
},
"startDate": "2024-05-06T14:00:11.057",
"endDate": "2024-05-06T14:14:17.057",
"duration": 846,
"hyperlink": "https://domaine.com/salle/nbblzfygdxkp",
"state": 1,
"accessType": 1
}Field descriptions
Name | Required | Comments/description |
| PlaybackIDNoEnc | ||
id | Unique identifier of the recording. (String type) | |
sessionID | Unique identifier of the session where the recording is located, if applicable. (String type) | |
title text languageId | Text: Title of the recording. (String type) languageId: The title can be multilingual:
(Number type) | |
startDate | Start date and time of the recording. | |
endDate | End date and time of the recording. | |
duration | Duration of the recording, in minutes. | |
hyperlink | Public hyperlink of the recording. Modifies only the end of the link. For example: if "2dhfwwoh6jqh" is specified, the generated link would look like https://www.domaine.com/lienactivité/2dhfwwoh6jqh | |
state | State of this recording.
(Number type) | |
parentId | Unique identifier of the parent recording, if applicable. (String type) | |
accessType | Defines the access level for this recording.
(Number type) |
Playback/delete
 | Deletes an existing recording. |
Request
Example of request call content to delete a recording:
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d"
}Field descriptions
Name | Required | Comments/description |
id | X | Unique identifier of the recording. |
Response
Example of the response call content for a request to delete a recording:
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d"
}Field descriptions
Name | Required | Comments/description |
id | Unique identifier of the recording. (String type) |
Playback/getlist
 | Retrieves information about a list of recordings. |
Request
Example of request call content for information about a list of recordings:
{
"filterId":"9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"filterStartDate":"2023-01-01",
"filterEndDate":"2028-01-01",
"filterindex":1
}Field descriptions
Name | Required | Comments/description |
filterId | X OR X | Unique identifier of the Via HTML session. Returns the list of recordings of a specific Via HTML activity. |
filterStartDate | Retrieves all recordings that start after a specific date. (String YYYY-MM-DDTHH:MM:SSZ) | |
filterEndDate |
| Retrieves all recordings that started before a specific date. |
filterIndex |
| The index filter parameter is optional and corresponds to pagination of 100 recordings. The method returns the list of 100 objects based on the index passed as a filter. An index filter of 1 returns meetings 1 to 100, and an index filter of 2 returns users 101 to 200. |
Response
Example of the response call content for a request to delete a recording:
[
{
"id": "UdT7%2fS42rdRl9MxaCZDTDQ%3d%3d",
"sessionId": "9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"title": {
"texts": [
{
"text": "Enregistrement #94",
"languageId": 1
},
{
"text": "Recording #94",
"languageId": 2
},
{
"text": "Grabación nro.94",
"languageId": 3
},
{
"text": "Enregistrement #94",
"languageId": 4
}
],
"ErrorID": 0
},
"startDate": "2024-05-06T15:29:10.387",
"endDate": "2024-05-06T15:54:46.387",
"duration": 1536,
"hyperlink": "https://viahtml.sviesolutions.com/vlkyuikuymdjqiazn",
"state": 1,
"accessType": 1
},
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d",
"sessionId": "9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"title": {
"texts": [
{
"text": "Enregistrement #93",
"languageId": 1
},
{
"text": "Recording #93",
"languageId": 2
},
{
"text": "Grabación nro.93",
"languageId": 3
},
{
"text": "Enregistrement #93",
"languageId": 4
}
],
"ErrorID": 0
},
"startDate": "2024-05-06T14:00:11.057",
"endDate": "2024-05-06T14:14:17.057",
"duration": 846,
"hyperlink": "https://viahtml.sviesolutions.com/nbblzfbdfbdgdxkp",
"state": 1,
"accessType": 1
}
]Field descriptions
| Name | Required | Comment/description |
| id | Unique identifier of the recording. (String type) | |
| sessionId | Unique identifier of the Via HTML session. (String type) | |
title text languageId | Text: Title of the recording. (String type) languageId: The title can be multilingual:
(Number type) | |
| startDate | Start date of the recording. | |
| endDate | End date of the recording. | |
| duration | Duration of the recording. (Number type) | |
| hyperlink | Unique link to the recording. (String type) | |
| state | State of this recording.
(Number type) | |
| accessType | Defines the access level for this recording.
(Number type) |
Error code descriptions for recording methods
Number | Message | Comments/description |
1800 | Required id | You must provide an identifier for the recording. |
1801 | Invalid id | The identifier provided for the recording is invalid. |
1802 | Required parameters | Parameters are required in order to make the call. |
1803 | Hyperlink is not available | The specified hyperlink is already in use. |
1804 | Invalid hyperlink | The specified hyperlink is invalid. |
1805 | Invalid title length | The title is invalid; it must be between 3 and 100 characters. |
1806 | Invalid accessType | The specified access type is invalid. |
1807 | Invalid filterId | The filter identifier is invalid. |
1808 | Invalid expirationDate | The expiry date provided is invalid. |