Skip to main content
Skip table of contents

Apartment renovation

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

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

json

JSON
{
    "is_duplicated_sip_line_available": true,
    "number": "user@vms.local",
    "duplicate_number": "+xxxxxxxxxxxx",
    "users_to_attach": [
        5,
        6
    ],
    "users_to_detach": [
        6
    ],
    "keys_to_attach": [
        4
    ],
    "keys_to_detach": [
        3
    ],
    "map_user_key": {
        "user": 6,
        "method": "select",
        "keys": [
            1,
            2
        ]
    }
}

intercomoptional

int

Unique identifier of the intercom

flatoptional

int

Unique identifier of the apartment

is_duplicated_sip_line_availablerequired

bool

Is the call enabled on the landline phone number

duplicate_numberrequired

string

Landline phone number

numberrequired

string

SIP number of the apartment

methodrequired

string

Method of modification. In the Main configurations, under the key intercom_flat_available_management_methods

users_to_attachrequired

array

Array of users to be added to the apartment

users_to_attach.*required

integer

User ID

users_to_detachrequired

array

Array of users to be removed from the apartment

users_to_detach.*required

integer

User ID

keys_to_attachrequired

array

Array of keys to be added to the apartment

keys_to_attach.*required

integer

Key ID

keys_to_detachrequired

array

Array of keys to be removed from the apartment

keys_to_detach.*required

integer

Key ID

map_user_key.userrequired

array

User ID, see List of users

map_user_key.methodrequired

array

Method of adding keys to the user

map_user_key.keysrequired

array

Array of keys to be removed from the apartment, see Intercom key list

map_user_key.keys.*required

array

Key ID

panel_system_volumesrequired

integer|null

System sounds of the panel

handset_ring_analog_volumesrequired

integer|null

Volume of the analog handset melody

handset_talk_analog_volumesrequired

integer|null

Volume of the analog handset speaker

panel_talk_analog_volumesrequired

integer|null

Volume of the panel speaker during a call to the analog handset

panel_talk_mobile_volumesrequired

integer|null

Volume of the panel speaker when using the mobile application

gail_panel_micro_mobile_volumesrequired

integer|null

Microphone gain of the panel when using the mobile application

answer_resistancerequired

integer|null

Resistance level of the lifted analog handset

quiescent_resistancerequired

integer|null

Resistance level of the placed analog handset

Response

200

Successful response

JSON
{
                "id": 1,
                "flat": 1,
                "key_count": 3,
                "users_count": 2,
                "keys": [
                    {
                        "id": 1,
                        "key": "0000003042CAAC",
                        "user": {
                            "id": 6,
                            "name": "user",
                            "login": "user@mail.com",
                            "created_at": "2022-11-11 14:45:58",
                            "updated_at": "2022-11-11 14:45:58",
                            "expired_at": "2122-11-11 14:45:57",
                            "is_licence_limit_reached": false,
                            "ptz_priority": 1,
                            "access_token_id": null
                        },
                        "created_at": "2022-11-11 14:46:16",
                        "updated_at": "2022-11-14 15:56:40"
                    },
                    {
                        "id": 2,
                        "key": "000000A3B48D3C",
                        "user": {
                            "id": 6,
                            "name": "user",
                            "login": "user@mail.com",
                            "created_at": "2022-11-11 14:45:58",
                            "updated_at": "2022-11-11 14:45:58",
                            "expired_at": "2122-11-11 14:45:57",
                            "is_licence_limit_reached": false,
                            "ptz_priority": 1,
                            "access_token_id": null
                        },
                        "created_at": "2022-11-11 14:46:16",
                        "updated_at": "2022-11-14 15:56:40"
                    },
                    {
                        "id": 4,
                        "key": "000000417EE9AA",
                        "user": null,
                        "created_at": "2022-11-11 14:46:16",
                        "updated_at": "2022-11-14 15:56:40"
                    }
                ],
                "users": [
                    {
                        "id": 5,
                        "name": "user",
                        "login": "user@mail.com",
                        "created_at": "2022-11-11 14:45:57",
                        "updated_at": "2022-11-11 14:45:57",
                        "expired_at": "2122-11-11 14:45:57",
                        "is_licence_limit_reached": false,
                        "ptz_priority": 1,
                        "access_token_id": null
                    },
                    {
                        "id": 6,
                        "name": "user",
                        "login": "user@mail.com",
                        "created_at": "2022-11-11 14:45:58",
                        "updated_at": "2022-11-11 14:45:58",
                        "expired_at": "2122-11-11 14:45:57",
                        "is_licence_limit_reached": false,
                        "ptz_priority": 1,
                        "access_token_id": null
                    }
                ],
                "properties": {
                    "is_analog_line_enable": false,
                    "is_sip_line_enable": true
                }
            }
401

Authorization token is not provided or is invalid. Obtaining a token

Example

JSON
curl -k --location --request PATCH 'https://vms.local/api/v1/admin/intercoms/{intercom}/flats/{flat}' \
--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 '{
    "is_duplicated_sip_line_available": true,
    "number": "user@vms.local",
    "duplicate_number": "+xxxxxxxxxxxx",
    "users_to_attach": [
        5,
        6
    ],
    "users_to_detach": [
        6
    ],
    "keys_to_attach": [
        4
    ],
    "keys_to_detach": [
        3
    ],
    "map_user_key": {
        "user": 6,
        "method": "select",
        "keys": [
            1,
            2
        ]
    }
}'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.