Check availability

Availability check

This request is performed before creation of an intercom from a specific vendor to ensure that the entered data is correct.

JSON

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

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

Parameters

string vendor, Vendor

string schema, The scheme by which the connection will be made

string ip, IP address

integer port, Port

string login, User login

string password, User password

200 OK

A successful response . The status 200 with an empty body.

401 Unauthorized

Authorization token not sent or not valid

422 Unprocessable Entity

Returns a JSON object with an error.

JSON

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/check-available' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "vendor": "string",
    "schema": "string",
    "ip": "string",
    "port": "integer",
    "login": "string",
    "password": "string"
}'

PHP

$data = array (
  'vendor' => 'string',
  'schema' => 'string',
  'ip' => 'string',
  'port' => 'integer',
  'login' => 'string',
  'password' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/intercoms/check-available', false, $context);