Intercom update Intersvyaz

PATCH/api/admin/v1/intercoms/{intercom}

Headers
Authorization		Bearer token
Accept		application/json
X-Client		ios-cctv\|android-cctv\|thick-legal\|web
X-UUID		unique device id

Body
json	JSON { "title": "title", "department": 2, "camera_id": 6180, "collecting_keys": true, "group_id": 217498, "switch": "metakom", "door_open_time_general": 500, "department_type": "main", "department_name": "department_name", "address": "City, Street 1", "sip_credentials": { "server": "televoip-core.is74.ru", "login": "0813c0000082", "password": "5eh2270j4fb0d", "port": 7777 }, "is_crossbar_switchers_enabled": true, "commutators_count": 2, "matrix": [ { "id": 1, "auto": false, "capacity": 20, "flat_from": 1, "items": [ [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], [ 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ] ] }, { "id": 2, "auto": true, "capacity": 20, "flat_from": 21, "is_last_item_first": true } ], "sip_options": { "talk_duration": 180, "ring_duration": 61, "dtmf": [ { "id": 1, "value": "/" }, { "id": 2, "value": "/" } ] }, "connection_type": "matrix_switching" }
intercom^optional	int	Unique identifier of the intercom
title^required	string	Name of the intercom
department^required	integer	Entrance
camera_id^required	integer	Camera ID associated with the intercom
collecting_keys^required	boolean	Key collection
group_id^required	integer	Group ID in which the intercom is located
switch^required	string	Switch type. All types are listed in the Main configurations
door_open_time_general^required	integer	Time that the door will remain open after being opened by the user (specified in seconds)
department_type^required	string	Entry type
department_name^required	string	Entry name
address^required	string	Address
sip_credentials^required	string	SIP server settings, when changing one field, all others must also be sent
*sip_credentials..server^required**	string	SIP server address (IP)
*sip_credentials..login^required**	string	User login
*sip_credentials..password^required**	string	User password
*sip_credentials..port^required**	string	SIP server port
is_crossbar_switchers_enabled^required	bool	Is the coordinate-matrix line enabled? (Enabling it allows for matrix flat settings)
commutators_count^required	integer	Number of switches on the intercom (maximum of 2 switches)
matrix^required	array	Intercom flat matrix, the number of elements in the matrix is equal to the number of switches. When changing one field, all others must also be sent
*matrix..id^required**	integer	Switch ID
*matrix..auto^required**	boolean	Is the matrix automatically filled? If false – a request should be made to Getting a matrix to retrieve the matrix for the user to fill in, and only after that, update the intercom with this matrix If true – the matrix will be automatically filled and displayed after updating the intercom
*matrix..capacity^required**	integer	Number of flats within 1 switc, in Main configurations under the key intercom_flat_capacity
*matrix..flat_from^required**	integer	Number of the first flat in the matrix
*matrix..is_last_item_first^required**	boolean	Is the last element of the matrix the first
sip_options^required	integer	Additional SIP server settings, when changing one field, all others must also be sent
*sip_options..talk_duration^required**	integer	Call duration
*sip_options..ring_duration^required**	integer	Conversation duration
*sip_options..dtmf^required**	array	Array of DTMF codes for opening the door for each relay
*sip_options..dtmf..id^required*	integer	Relay ID
*sip_options..dtmf..value^required*	string	DTMF code for opening the door
flat_from^required	integer	Flats from
flat_to^required	integer	Flats to
connection_type^required	string	Intercom connection scheme, found in Main configurations under the key intercom_connection_types

Response
200	Successful response
JSON { "id": 31, "title": "metakom_intercom", "is_online": false, "group_id": 217500, "camera_id": 6180, "flat_from": null, "flat_to": null, "flat_offset": null, "department": 10, "department_name": null, "department_type": "main", "department_type_pretty": "Entrance", "uuid": "75ce7e03-dda7-44fe-88b0-fdc7fe72942c", "address": "City, Street 1", "group": { "id": 217500, "name": "intercom_new_sub", "full_pretty": "intercom_new_main, intercom_new_sub", "is_house": 1, "cameras_count": 0, "parent_id": 217499, "csa_id": null, "intercoms_count": 1 }, "camera": { "id": 6180, "group_id": 3, "status": "active", "type": "flussonic", "start_at": "2022-09-24 15:48:35", "created_at": "2018-06-15 19:01:58", "name": "Camera", "streams": [ { "id": 12390, "type": "high", "camera_id": 6180, "status": "active", "url": "rtsp://admin:Cisco123@10.9.0.8:554/Streaming/Channels/101", "bitrate": 675, "resolution": "1280x960", "output_rate": 0, "ip": "10.9.0.8", "uuid": "cb46e1d3-7c92-41cb-bd65-3175497aae11", "sound": "tracks-v1", "streams_count": 0, "server": { "id": 30, "type": "flussonic", "schema": "https", "domain": "host-name-1.vms.local", "internal": "62122", "external": "62121", "m4f": "62124", "rtsp": "554", "publish": "7554", "traffic_in": 346164, "traffic_out": 6702, "status": 1, "is_enabled": 0, "is_main": 1, "has_cache": 1, "proxy": "host-name-1.vms.local", "created_at": "2019-09-10 17:56:55", "updated_at": "2022-08-02 02:59:02", "group_type":"all", "can_delete": false, "streams_limit": 610, "bitrate_limit": 700000, "extra": { "id": "7ddb12a4-e07b-4635-954c-478384c1a282", "dvr": true, "net": [], "iptv": true, "rtsp": 554, "build": 0, "disks": [ "loop0", "sda", "sdb", "sdc" ], "event": "server.info", "https": 62125, "vsaas": false, "ffmpeg": true, "rproxy": false, "status": [], "uptime": 14571431, "config2": true, "version": "20.03", "hostname": "host-name-1.vms.local", "cpu_usage": 55, "admin_http": 62124, "auth_token": "token", "input_kbit": 346164, "partitions": [ { "path": "root", "usage": 40, "total_mb": 140676 }, { "path": "_cache", "usage": 12, "total_mb": 7122733 }, { "path": "_storage", "usage": 64, "total_mb": 102583300 }, { "path": "_storage2", "usage": 59, "total_mb": 102583300 } ], "started_at": 1644816115, "transcoder": true, "ad_injector": true, "admin_https": 62122, "license_txt": "odcgaO...", "output_kbit": 6702, "capabilities": { "url_publish": true }, "iptv_running": false, "memory_usage": 7, "next_version": "22.08", "opened_files": 0, "total_clients": 30, "total_streams": 1109, "vsaas_running": false, "online_streams": 546, "rproxy_running": false, "vsaas_branding": false, "retroview_enabled": false, "transcoder_devices": [ { "id": 0, "name": "CPU Encoder", "type": "cpu" } ], "retroview_configured": false }, "is_editable": true }, "sub_servers": [ { "id": 33, "type": "flussonic", "schema": "https", "domain": "host-name-2.vms.local", "internal": "62122", "external": "62121", "m4f": "62124", "rtsp": "554", "publish": "7554", "traffic_in": 300240, "traffic_out": 4331, "status": 1, "is_enabled": 0, "is_main": 0, "has_cache": 1, "proxy": "host-name-2.vms.local", "created_at": "2019-09-10 17:56:55", "updated_at": "2022-08-02 02:59:02", "group_type":"all", "can_delete": false, "streams_limit": 650, "bitrate_limit": 700000, "extra": { "id": "7a605bc8-6f6d-4ef3-9835-525e8e108dec", "dvr": true, "net": [], "iptv": true, "rtsp": 554, "build": 0, "disks": [ "loop0", "sda", "sdb", "sdc" ], "event": "server.info", "https": 62125, "vsaas": false, "ffmpeg": true, "rproxy": false, "status": [], "uptime": 14571266, "config2": true, "version": "20.03", "hostname": "host-name-2.vms.local", "cpu_usage": 55, "admin_http": 62124, "auth_token": "token", "input_kbit": 300240, "partitions": [ { "path": "root", "usage": 40, "total_mb": 140676 }, { "path": "_cache", "usage": 8, "total_mb": 7122733 }, { "path": "_storage2", "usage": 54, "total_mb": 102583300 }, { "path": "_storage", "usage": 51, "total_mb": 102583300 } ], "started_at": 1644816280, "transcoder": true, "ad_injector": true, "admin_https": 62122, "license_txt": "odcgaO...", "output_kbit": 4331, "capabilities": { "url_publish": true }, "iptv_running": false, "memory_usage": 8, "next_version": "22.08", "opened_files": 0, "total_clients": 17, "total_streams": 1109, "vsaas_running": false, "online_streams": 514, "rproxy_running": false, "scheduler_load": 9, "vsaas_branding": false, "retroview_enabled": false, "transcoder_devices": [ { "id": 0, "name": "CPU Encoder", "type": "cpu" } ], "retroview_configured": false }, "is_editable": true }, { "id": 33, "type": "flussonic", "schema": "https", "domain": "host-name-2.vms.local", "internal": "62122", "external": "62121", "m4f": "62124", "rtsp": "554", "publish": "7554", "traffic_in": 300240, "traffic_out": 4331, "status": 1, "is_enabled": 0, "is_main": 0, "has_cache": 1, "proxy": "host-name-2.vms.local", "created_at": "2019-09-10 17:56:55", "updated_at": "2022-08-02 02:59:02", "group_type":"all", "can_delete": false, "streams_limit": 650, "bitrate_limit": 700000, "extra": { "id": "7a605bc8-6f6d-4ef3-9835-525e8e108dec", "dvr": true, "net": [], "iptv": true, "rtsp": 554, "build": 0, "disks": [ "loop0", "sda", "sdb", "sdc" ], "event": "server.info", "https": 62125, "vsaas": false, "ffmpeg": true, "rproxy": false, "status": [], "uptime": 14571266, "config2": true, "version": "20.03", "hostname": "host-name-2.vms.local", "cpu_usage": 55, "admin_http": 62124, "auth_token": "token", "input_kbit": 300240, "partitions": [ { "path": "root", "usage": 40, "total_mb": 140676 }, { "path": "_cache", "usage": 8, "total_mb": 7122733 }, { "path": "_storage2", "usage": 54, "total_mb": 102583300 }, { "path": "_storage", "usage": 51, "total_mb": 102583300 } ], "started_at": 1644816280, "transcoder": true, "ad_injector": true, "admin_https": 62122, "license_txt": "odcgaO...", "output_kbit": 4331, "capabilities": { "url_publish": true }, "iptv_running": false, "memory_usage": 8, "next_version": "22.08", "opened_files": 0, "total_clients": 17, "total_streams": 1109, "vsaas_running": false, "online_streams": 514, "rproxy_running": false, "scheduler_load": 9, "vsaas_branding": false, "retroview_enabled": false, "transcoder_devices": [ { "id": 0, "name": "CPU Encoder", "type": "cpu" } ], "retroview_configured": false }, "is_editable": true } ], "transfer_servers": [], "transfer_sub_servers": [], "created_at": "2019-10-22 04:36:19", "updated_at": "2022-08-02 02:59:23", "is_preview_from_server": true, "is_archive_from_server": null, "is_enabled": true, "is_can_transfer": true, "source": "manual", "is_sound_enabled": null, "reconnect_attempt": null, "reconnect_total": null, "reconnect_time": "", "disconnections_count": 0, "is_actual": true }, { "id": 32448, "type": "low", "camera_id": 6180, "status": "active", "url": "rtsp://admin:Cisco123@10.9.0.8:554/Streaming/Channels/102", "bitrate": 86, "resolution": "640x480", "output_rate": 0, "ip": "10.9.0.8", "uuid": "fb57d3de-ef51-468d-8ee1-f0d264f9e639", "sound": "tracks-v1", "streams_count": 0, "server": { "id": 50, "type": "flussonic", "schema": "https", "domain": "host-name-3.vms.local", "internal": "62122", "external": "62121", "m4f": "62124", "rtsp": "554", "publish": "7554", "traffic_in": 317034, "traffic_out": 21757, "status": 1, "is_enabled": 0, "is_main": 0, "has_cache": 1, "proxy": "host-name-3.vms.local", "created_at": "2019-11-29 22:44:10", "updated_at": "2022-08-02 02:59:03", "group_type": "all", "can_delete": false, "streams_limit": 600, "bitrate_limit": 700000, "extra": { "id": "904f9678-7640-4deb-99a7-471bf71c4a12", "dvr": true, "net": [], "iptv": true, "rtsp": 554, "build": 0, "disks": [ "loop0", "sda", "sdb", "sdc" ], "event": "server.info", "https": 62125, "vsaas": false, "ffmpeg": true, "rproxy": false, "status": [], "uptime": 14571261, "config2": true, "version": "20.03", "hostname": "host-name-3.vms.local", "cpu_usage": 59, "admin_http": 62124, "auth_token": "token", "input_kbit": 317034, "partitions": [ { "path": "root", "usage": 37, "total_mb": 140676 }, { "path": "_cache", "usage": 17, "total_mb": 7122733 }, { "path": "_storage2", "usage": 61, "total_mb": 102583300 }, { "path": "_storage", "usage": 49, "total_mb": 102583300 } ], "started_at": 1644816285, "transcoder": true, "ad_injector": true, "admin_https": 62122, "license_txt": "odcgaO...", "output_kbit": 21757, "capabilities": { "url_publish": true }, "iptv_running": false, "memory_usage": 8, "next_version": "22.08", "opened_files": 0, "total_clients": 312, "total_streams": 985, "vsaas_running": false, "online_streams": 473, "rproxy_running": false, "scheduler_load": 10, "vsaas_branding": false, "retroview_enabled": false, "transcoder_devices": [ { "id": 0, "name": "CPU Encoder", "type": "cpu" } ], "retroview_configured": false }, "is_editable": true }, "sub_servers": [ { "id": 48, "type": "flussonic", "schema": "https", "domain": "host-name-4.vms.local", "internal": "62122", "external": "62121", "m4f": "62124", "rtsp": "554", "publish": "7554", "traffic_in": 326600, "traffic_out": 20900, "status": 1, "is_enabled": 0, "is_main": 1, "has_cache": 1, "proxy": "host-name-4.vms.local", "created_at": "2019-11-29 22:44:10", "updated_at": "2022-08-02 02:59:02", "group_type": "all", "can_delete": false, "streams_limit": 600, "bitrate_limit": 700000, "extra": { "id": "a9fd9c75-3359-4744-8943-ca074743857e", "dvr": true, "net": [], "iptv": true, "rtsp": 554, "build": 0, "disks": [ "loop0", "sda", "sdb", "sdc" ], "event": "server.info", "https": 62125, "vsaas": false, "ffmpeg": true, "rproxy": false, "status": [], "uptime": 14571287, "config2": true, "version": "20.03", "hostname": "host-name-4.vms.local", "cpu_usage": 55, "admin_http": 62124, "auth_token": "token", "input_kbit": 326600, "partitions": [ { "path": "root", "usage": 36, "total_mb": 140676 }, { "path": "_cache", "usage": 11, "total_mb": 7122733 }, { "path": "_storage2", "usage": 55, "total_mb": 102583300 }, { "path": "_storage", "usage": 57, "total_mb": 102583300 } ], "started_at": 1644816259, "transcoder": true, "ad_injector": true, "admin_https": 62122, "license_txt": "odcgaO...", "output_kbit": 20900, "capabilities": { "url_publish": true }, "iptv_running": false, "memory_usage": 8, "next_version": "22.08", "opened_files": 0, "total_clients": 47, "total_streams": 984, "vsaas_running": false, "online_streams": 450, "rproxy_running": false, "scheduler_load": 8, "vsaas_branding": false, "retroview_enabled": false, "transcoder_devices": [ { "id": 0, "name": "CPU Encoder", "type": "cpu" } ], "retroview_configured": false }, "is_editable": true }, { "id": 48, "type": "flussonic", "schema": "https", "domain": "host-name-4.vms.local", "internal": "62122", "external": "62121", "m4f": "62124", "rtsp": "554", "publish": "7554", "traffic_in": 326600, "traffic_out": 20900, "status": 1, "is_enabled": 0, "is_main": 1, "has_cache": 1, "proxy": "host-name-4.vms.local", "created_at": "2019-11-29 22:44:10", "updated_at": "2022-08-02 02:59:02", "group_type":"all", "can_delete": false, "streams_limit": 600, "bitrate_limit": 700000, "extra": { "id": "a9fd9c75-3359-4744-8943-ca074743857e", "dvr": true, "net": [], "iptv": true, "rtsp": 554, "build": 0, "disks": [ "loop0", "sda", "sdb", "sdc" ], "event": "server.info", "https": 62125, "vsaas": false, "ffmpeg": true, "rproxy": false, "status": [], "uptime": 14571287, "config2": true, "version": "20.03", "hostname": "host-name-4.vms.local", "cpu_usage": 55, "admin_http": 62124, "auth_token": "token", "input_kbit": 326600, "partitions": [ { "path": "root", "usage": 36, "total_mb": 140676 }, { "path": "_cache", "usage": 11, "total_mb": 7122733 }, { "path": "_storage2", "usage": 55, "total_mb": 102583300 }, { "path": "_storage", "usage": 57, "total_mb": 102583300 } ], "started_at": 1644816259, "transcoder": true, "ad_injector": true, "admin_https": 62122, "license_txt": "odcgaO...", "output_kbit": 20900, "capabilities": { "url_publish": true }, "iptv_running": false, "memory_usage": 8, "next_version": "22.08", "opened_files": 0, "total_clients": 47, "total_streams": 984, "vsaas_running": false, "online_streams": 450, "rproxy_running": false, "scheduler_load": 8, "vsaas_branding": false, "retroview_enabled": false, "transcoder_devices": [ { "id": 0, "name": "CPU Encoder", "type": "cpu" } ], "retroview_configured": false }, "is_editable": true } ], "transfer_servers": [], "transfer_sub_servers": [], "created_at": "2020-01-22 18:46:22", "updated_at": "2022-08-02 02:59:43", "is_preview_from_server": true, "is_archive_from_server": null, "is_enabled": true, "is_can_transfer": true, "source": "manual", "is_sound_enabled": null, "reconnect_attempt": null, "reconnect_total": null, "reconnect_time": "", "disconnections_count": 0, "is_actual": true } ], "can_edit": true, "origin": null, "group_type": "public", "shared_from": null, "ip": "10.9.0.8", "lat": null, "lng": null, "azimuth": null, "is_sensitive": 0, "is_public": 0, "archive_ranges": [ { "from": 1656788400, "duration": 50425 }, { "from": 1656838828, "duration": 2059 }, { "from": 1656840890, "duration": 120667 }, { "from": 1656961575, "duration": 137010 }, { "from": 1657098601, "duration": 1938 }, { "from": 1657100544, "duration": 8542 }, { "from": 1657109089, "duration": 21987 }, { "from": 1657131079, "duration": 67747 }, { "from": 1657198829, "duration": 7932 }, { "from": 1657206764, "duration": 17404 }, { "from": 1657224171, "duration": 42858 }, { "from": 1657267034, "duration": 52084 }, { "from": 1657319135, "duration": 64094 }, { "from": 1657383232, "duration": 6537 }, { "from": 1657389772, "duration": 137027 }, { "from": 1657526802, "duration": 103539 }, { "from": 1657630344, "duration": 89442 }, { "from": 1657719789, "duration": 1682 }, { "from": 1657721492, "duration": 42674 }, { "from": 1657764169, "duration": 7057 }, { "from": 1657771229, "duration": 144034 }, { "from": 1657915266, "duration": 104582 }, { "from": 1658019851, "duration": 43075 }, { "from": 1658062929, "duration": 194339 }, { "from": 1658257289, "duration": 39692 }, { "from": 1658296984, "duration": 29112 }, { "from": 1658326099, "duration": 160343 }, { "from": 1658486447, "duration": 124959 }, { "from": 1658611423, "duration": 157010 }, { "from": 1658768454, "duration": 25212 }, { "from": 1658793669, "duration": 11100 }, { "from": 1658804772, "duration": 172804 }, { "from": 1658977579, "duration": 10582 }, { "from": 1658988164, "duration": 32637 }, { "from": 1659020804, "duration": 176192 }, { "from": 1659196999, "duration": 7114 }, { "from": 1659204138, "duration": 183215 } ], "archive_recording_timetable": null, "motion_detaction_timetable": [], "onvif_configuration": null, "streams_rtsp": null, "is_ip_reserved": false, "count_issues": 0, "source": "manual", "archive_storage_days": 30, "is_archive_recording": true, "archive_recording_type": "fulltime", "is_increased_reconnect": 0, "is_sound_enabled": true, "is_bridge": false, "can_change_archive_timetable": true, "is_auto_create_streams": false, "is_provisioning_enable": false, "is_can_manage_streams": true, "streams_source": "manual", "is_can_manage_archive_storage_days": true, "is_editable": true }, "collecting_keys": false, "door_open_time_general": 10, "sip_credentials": { "server": "televoip-core.is74.ru", "port": 7776, "login": "0813c0000082", "is_sip_password_installed": true }, "sip_options": { "talk_duration": 180, "ring_duration": 61, "dtmf": [ { "id": 1, "value": "/" }, { "id": 2, "value": "/" } ] }, "is_crossbar_switchers_enabled": true, "matrix": [ { "id": 1, "items": [ [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], [ 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ] ], "auto": false, "is_last_item_first": false, "flat_from": 1 }, { "id": 2, "items": [ [ 20, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], [ 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ] ], "auto": true, "is_last_item_first": true, "flat_from": 21 } ], "created_at": "2022-10-11 10:08:32", "updated_at": "2022-10-24 12:21:54", "mac": "08:13:c0:00:00:82", "vendor": "interconnection", "vendor_pretty": "Intersvyaz", "status": "installed", "status_pretty": "Installed", "switch": "metakom", "switch_pretty": "Metakom", "schema": "http", "ip": "192.168.18.207", "port": 8080, "login": "root", "password": "123456", "commutators_count": 2, "is_can_manage_matrix": true, "connection_type": "fixed_and_smart", "connection_type_pretty": "Combined 1", "errors": { "sip_credentials": "Intercom update error. Failed to set SIP server settings." } }
401	Authorization token is not provided or is invalid. Obtaining a token
array	errors	List of errors that occurred when updating the intercom
boolean	is_can_manage_matrix	Is it possible to edit the matrix of apartments, now you can edit the matrix only for Intersvyaz intercoms

Example

JSON

curl -k --location --request PATCH 'https://vms.local/api/admin/v1/intercoms/{intercom}' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "title": "title",
    "department": 2,
    "camera_id": 6180,
    "collecting_keys": true,
    "group_id": 217498,
    "switch": "metakom",
    "door_open_time_general": 500,
    "department_type": "main",
    "department_name": "department_name",
    "address": "City, Street 1",
    "sip_credentials": {
        "server": "televoip-core.is74.ru",
        "login": "0813c0000082",
        "password": "5eh2270j4fb0d",
        "port": 7777
    },
    "is_crossbar_switchers_enabled": true,
    "commutators_count": 2,
    "matrix": [
        {
            "id": 1,
            "auto": false,
            "capacity": 20,
            "flat_from": 1,
            "items": [
                [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10
                ],
                [
                    11,
                    12,
                    13,
                    14,
                    15,
                    16,
                    17,
                    18,
                    19,
                    20
                ]
            ]
        },
        {
            "id": 2,
            "auto": true,
            "capacity": 20,
            "flat_from": 21,
            "is_last_item_first": true
        }
    ],
    "sip_options": {
        "talk_duration": 180,
        "ring_duration": 61,
        "dtmf": [
            {
                "id": 1,
                "value": "/"
            },
            {
                "id": 2,
                "value": "/"
            }
        ]
    },
    "connection_type": "matrix_switching"
}'