View intercom details | AIPIX documentation

The method and parameters

To retrieve intercom data, use one of the following parameters: id, mac, or external_id.
Only one identification parameter can be used at a time.

JSON

{
  "id": 10
}

Get /api/v1/billing/intercoms/show

int id – an intercom ID

string mac – a MAC address of an intercom

string external_id – an intercom external ID

204 No Content

Successful response with intercom data

JSON

{
    "id": 10,
    "external_id": "EXT_123",
    "department": "main",
    "title": "Entrance intercom #1",
    "mac": "AA:BB:CC:DD:EE:FF",
    "model": "DKS20211",
    "serial_number": "SN123456",
    "status": "installed",
    "flat_from": 1,
    "flat_to": 100,
    "source": "external-system",
    "camera": {
        "id": 10,
        "title": "Entrance camera"
    },
    "group": {
        "id": 6,
        "name": "Entrance 1",
        "external_id": "0e4bbda6-b7a5-4db4-8178-315bf0006d11",
        "has_items": false
    }
}

404 Intercom not found

JSON

{
    "message": "Not found"
}

422 Unprocessable Entity

Returns a JSON object with an error. For details, see General information>Validation.

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 GET \
	--url 'https://your-domain/api/v1/billing/intercoms/show' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "id": 0,
    "mac": "string",
    "external_id": "string"
}'

PHP

$data = array (
  'id' => 0,
  'mac' => 'string',
  'external_id' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/billing/intercoms/show', false, $context);