This request is used in mobile device widgets to retrieve the objects based on a list of IDs.
If IDs are provided that do not belong to the user, no error will occur, and those IDs will be excluded from the response.
GET/api/v1/intercom/showsHeaders |
Authorization | Bearer token |
Accept | application/json |
X-Client | ios-cctv|android-cctv|thick-legal|web |
X-UUID | unique device id |
Body |
idsrequired | array | Array of intercom IDs, maximum of 25 IDs can be sent |
Response |
|
200 | Successful response |
JSON
[
{
"id": 180,
"title": "Home",
"is_online": true,
"is_enabled": true,
"timetable": {
"days": [
{
"to": "23:59:59+05:00",
"from": "00:00:00+05:00",
"type": "tuesday"
},
{
"to": "23:59:59+05:00",
"from": "00:00:00+05:00",
"type": "wednesday"
},
{
"to": "23:59:59",
"from": "00:00:00+05:00",
"type": "saturday"
}
],
"intervals": []
},
"department": 100,
"address": "Cameras",
"camera": {
"id": 833,
"group_id": 124,
"status": "active",
"type": "media_server_v2",
"start_at": "2022-04-19 16:43:15",
"created_at": "2022-02-18 15:05:53",
"billing_id": null,
"pretty_name": "Intercom",
"lat": null,
"lng": null,
"azimuth": null,
"is_archive_recording": true,
"is_bridge": false,
"is_favorite": false,
"user_status": "active",
"name": "Intercom"
},
"status": "confirmed",
"created_at": null,
"updated_at": "2022-04-20T12:34:32.000000Z"
}
]
|
|
401 | Authorization token not provided or invalid, see Obtaining a token |
|
422 | Returns a JSON object with an error, see Validation |
JSON
{
"message": "There won't be any informative message here",
"errors": {
"any_key": [
"Here the error cause will be described"
]
}
}
|
Example |
JSON
curl -k --location --request GET 'https://vms.local/api/v1/intercom/shows?ids=array' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
|
