Skip to main content
Skip table of contents

Adding an intercom. VMS Client API

This request is used to start the process of adding an intercom.

The user must enter a code, and then attach the key to the intercom (it should be compatible with this intercom).

After doing so, they will receive a push notification via WebSocket, and they will need to select the apartment, see Apartment selection

If such an intercom has already been added, a push notification will be sent with an error description.

POST/api/v1/intercom
Headers
Authorization
Bearer token
Accept
application/json
X-Client
ios-cctv|android-cctv|thick-legal|web
X-UUID
unique device id
Response
200
Successful response
JSON
{
                "code": "063",
                "expire_in_seconds": 60
            }
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 POST 'https://vms.local/api/v1/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'
JavaScript errors detected

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

If this problem persists, please contact our support.