Skip to main content
Skip table of contents

Intersvyaz availability check

This request is executed before creation to ensure the correctness of the entered data before creating the intercom

POST/api/admin/v1/intercoms/check-available

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

json

JSON
{
    "vendor": "iscom_x1",
    "schema": "http",
    "ip": "192.168.18.207",
    "port": "8080",
    "login": "root",
    "password": "123456"
}

vendorrequired

string

Vendor

schemarequired

string

Connection scheme to be used

iprequired

string

IP address

portrequired

integer

Port

loginrequired

string

User login

passwordrequired

string

User password

Response

200

Successful response: status 200 with an empty body

401

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

422

Returns a JSON object with an error. Validation

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The reason for the error will be described here"
        ]
    }
}

Example

JSON
curl -k --location --request POST 'https://vms.local/api/admin/v1/intercoms/check-available' \
--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 '{
    "vendor": "iscom_x1",
    "schema": "http",
    "ip": "192.168.18.207",
    "port": "8080",
    "login": "root",
    "password": "123456"
}'
JavaScript errors detected

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

If this problem persists, please contact our support.