Intercom service

Description of a card type. See Service capabilities for a complete list of cards supported by the products.

{
  "Name": "MIFARE_Classic",
  "DisplayName": "MIFARE Classic",
  "Category": "HighFrequency",
  "DataSources": [ "CSN", "Data",.. ]
}

The different categories a CardType may have.

The known card types.

See ServiceCapabilities or use GetSupportedTagTypes for a list of card types your device supports.

The possible values that describes how the PIN is formatted when it is sent to the access control device.

See ServiceCapabilities for values supported by your product.

The possible values that describes how card data is formatted when it is sent to the access control device.

See Service capabilities for values supported by your product.

The possible modes of overriding the facility code.

See ServiceCapabilities for values supported by your product.

The possible parity bit types.

See ServiceCapabilities for values supported by your product.

Defines the custom parameters for when the cardFormat is “Custom“. This part defines the format if no other value in the CardOutputFormat can be used.

{
  "facilityCodeSize": 8,
  "cardNumberSize": 16,
  "startParity": "Even",
  "startParityBits": 12,
  "stopParity": "Odd",
  "stopParityBits": 12
}

Defines how the card data is configured and sent to the output.

See ServiceCapabilities for values supported by cardFormat and cardFacilityCodeOverrideMode.

{
  "cardFormat": "Raw",
  "cardFacilityCodeOverrideMode": "Auto",
  "cardFacilityCode": 0,
  "Custom": {
    CustomOutputFormatConfiguration
  }
}

The possible names for the general IO pins.

See ServiceCapabilities for values supported by your product.

The different ways that the device can communicate with an access control system.

See ServiceCapabilities for values supported by your product.

The different color strings that may be supported by your device.

Colors may also be specified in #RRGGBB format for arbitrary color (if supported by the device).

See ServiceCapabilities for values supported by your product.

Defines the configuration used for the Wiegand output to change the LED and beeper. All fields are optional and will keep their existing value if nothing is set.

{
  "nbrOfLEDPins": 3,
  "beeper": true,
  "beeperPin": "I1",
  "LED1Pin": "I2",
  "LED2Pin": "I3",
  "pulseWidth": 40,
  "pulseInterval": 2000,
  "frameInterval": 25000,
  "LEDColorDefault": "off",
  "LEDColor0": "red",
  "LEDColor1": "green",
  "LEDColor00": "off",
  "LEDColor01": "red",
  "LEDColor10": "green",
  "LEDColor11": "amber",
  "keypressFormat": "FourBit",
  "keypressFacilityCode": 0
}

Defines the configuration options for the Open Supervised Device Protocol (OSDP).

{
  "OSDPAddress": 0
}

Defines the configuration options for PIN length and timeout. The PIN configuration should match the one set in the Access Control Unit.

{
  "pinLength": 4,
  "pinTimeout": 10
}

Defines the configuration options for the Axis Request Access protocol. The name is derived from Target and Source unless present in the AccessPoint. See IPAccessConfiguration for additional information.

{
  "Name": "Door - Reader Entrance A8207",
  "Id": "e6608ad31a480904f9646e936cc8e86a",
  "Address": "a1601.example.com",
  "AccessControllerToken": "Axis-00408c184be0+AccessController",
  "SourceToken": "Axis-00408c184be0:1581679815.571711000",
  "TargetToken": "Axis-00408c184be0:1581679815.080670000",
  "AccessPointToken": "Axis-00408c184be0:1581679823.844035000"
}

The supported IP integration protocols. See IPAccessConfiguration for additional information.

The supported IP integration transport protocols.

Configuration options for IP based access control integration. See IP Access configuration for additional information.

{
  "Scheme": "https",
  "Address": "a1601.example.com",
  "Username": "a8207userOnA1601",
  "Password": "a8207passwordOnA1601",
  "VerifyCertificate": true,
  "IPProtocol": "RemoteActivity",
  "RequestAccessConfiguration": {
    RequestAccessConfiguration
  }
}

Contains the card reader compatibility options, which makes it possible to extend the configuration options without changing the configuration structures.

{
  "CompatibilityConfigs": [
    {
      Attribute
    },..
  ]
}

Configurations for the card reader functionality, such as the integration protocol, what card types to enable, etc. All fields are optional, meaning that their current value will be kept unless specified in a SetConfiguration or UpdateConfiguration request.

{
  "Protocol": "Wiegand",
  "CardTypes": [
    "EM4X02",
    ..
  ],
  "WiegandConfiguration": {
    WiegandConfiguration
  },
  "OSDPConfiguration": {
    OSDPConfiguration
  },
  "PinConfiguration": {
    PinConfiguration
  },
  "IPAccessConfiguration": {
    IPAccessConfiguration
  },
  "CompatibilityConfiguration": {
    CompatibilityConfiguration
  },
  "CardDataConfigs": [
    {
      "CardDataConfig
    },
    ..
  ],
  "RegisteredReaderConfiguration": {
    RegisteredReaderConfiguration
  },
  "OutputFormat": {
    OutputFormatConfiguration
  },
  "SensitiveRFIDEventEnabled": false,
  "SensitivePINEventEnabled": false
}

The type used for the UID of a tag.

Base type: String (maxLength=64, minLength=0)

Describes the tag together with the metadata.

{
  "TagUid": "CA4DDA7A",
  "BitCount": 32,
  "TagType": "MIFARE_Classic",
  "ReaderId": "Internal",
  "Age": 1,
  "FacilityCode": "",
  "CardNumber": "",
  "Format": "Raw",
  "Masked": true
}

Defines the structure that holds the data chunk extracted from an RFID card.

Uses:

• Returns the value of the GetCardData function.

• Parameter of the InjectTag function.

{
  "name": "string",
  "bitCount": 0,
  "byteCount": 0,
  "data": "hexBinary"
}

Defines the possible data sources. All card types supports CSN (Card serial number), but other sources may be possible depending on the card type.

Defines a configuration describing how to extract a specific data chunk from an RFID card. It contains both addresses required to find the data and the credentials to access them. Please note that credentials are sensitive data and should be handled with care.

Uses:

• A CardReaderConfiguration field specifying pre-defined ways to extract data.

• A GetCardData parameter allowing data extracting with no pre-configuration and without storing sensitive credentials in CardReaderConfiguration.

{
  "name": "referring",
  "cardType": "EM4X02",
  "datSource": "CSN",
  "enabled": true,
  "required": true,
  "useAsUid": true,
  "offsetByte": 0,
  "lengthInBytes": 0,
  "offsetBits": 0,
  "lengthInBits": 0,
  "attributes": [
    {
      "Attribute
    },
    ..
  ],
  "DESFireEncryption": {
    DESFireEncryption
  },
  "MifareClassicEncryption": {
    MifareClassicEncryption
  },
  "MifareULEncryption": {
    MifareULEncryption
  }
}

Key used for encryption. Typically provided as hexadecimal values.

Base type: String ()

The format of a key. Some keys need to be protected (encrypted) and not exposed in plaintext to the user in order to protect sensitive key material.

The key and authentication types for MIFARE DESFire.

The different communication modes for a file in a MIFARE DESFire card.

MIFARE DESFire specific credentials and addressing configuration. Credentials are used to access the data. Addressing is used to point out the data location within the card.

Uses:

• A field of CardDataConfig. Only used if cardType=MIFARE_DESFire

{
  "AID": "hexBinary",
  "keyFormat": "Plaintext",
  "key": "Key",
  "keyType": "Compatible_3DES",
  "commMode": "Auto",
  "keyNbr": 0,
  "fileNbr": 0
}

MIFARE Classic specific credentials and addressing configuration. The credentials are used to access the data, addressing to point out the data location within the card.

Uses:

• A field of CardDataConfig that is only used if cardType=MIFARE_Classic.

• The total offset depends on the startSector, startBlock and offset.

• For a MIFARE Classic card, sectors 0–31 have 4 blocks, while sectors 32–39 have 16 blocks each available only on 4 K cards.

• Each block is 16 bytes.

• The total offset must be less than 4096 bytes and total offset + length can only be up to 4096 bytes.

{
  "keyAFormat": "Plaintext",
  "keyA": "Key",
  "keyBFormat": "Plaintext,
  "keyB": "Key",
  "startSector": 0,
  "startBlock": 0,
  "skipLastBlockInSector": true
}

MIFARE Ultralight specific credentials configuration only for Ultralight C. Credentials are used to access the data. No addressing is necessary, since the UL uses one single continuous block of data.

{
  "keyFormat": "Plaintext",
  "key": "Key"
}

The possible policy values that control masking of newly registered readers.

Specifies how the clients (usually an application or third party solution) are allowed to use the InjectTag.

{
  "ReaderIds": [ "Internal",.. ],
  "Policy": "Auto"
}

Defines the reserved reader ID:s provided by the device.

Shows if the reader is masked or not.

{
  "readerId": "Internal",
  "isMasked": true
}

Assigns min/max values to an integer, allowing client side validation of the user input.

{
  "Name": "pinLength",
  "Min": 0,
  "Max": 32
}

The available CompatibilityConfig names used in Attribute and AttributeInfo for the CompatibilityConfiguration and ServiceCapabilities.

Reflects the optional, static functionality of a service that won’t change when a device is active.

{
  "Version": "string",
  "Call": true,
  "DTMFEvent": true,
  "CallButton": true,
  "CallKeypad": true,
  "PinKeypad": true,
  "Reader": true,
  "uiLeds": [
    {
      UiLed
    },
    ..
  ],
  "AccesscontrolIntegrationProtocols": [
    "None",
    "IPAccess",
    "OSDP",
    "Wiegand",
    ..
  ],
  "SupportedCards": [
    {
      CardType
    },
    ..
  ],
  "SupportedIOPins": [
    "I1",
    ..
  ],
  "SupportedColorNames": [
    "off",
    ..
  ],
  "IntegerValidators": [
    {
      IntegerValidator
    },
    ..
  ],
  "CompatibilityConfigs": [
    {
      AttributeInfo
    },
    ..
  ],
  "SupportedKeypressOutputFormatWiegand": [
    "FourBit",
    ..
  ],
  "SupportedCardOutputFormat": [
    "Raw",
    ..
  ],
  "SupportedFacilityCodeOverrideMode": [
    "Auto",
    ..
  ],
  "SupportedParityType": [
    "None",
    ..
  ],
  "SupportedCallButtonIdleBehavior": [
    "Automatic",
    ..
  ],
  "SupportedDefaultContactSorting": [
    "SortByFirstName",
    ..
  ],
  "SupportedDefaultNameFormat": [
    "FirstNameFirst",
    ..
  ]
}

This operation returns the capabilities of the service.

Request

{}

Response

{
  "Capabilities": {
    ServiceCapabilities
  }
}

This command is used to configure an entity for the intercom functionality. An optional field not set by SetConfiguration will keep its current value.

{
  "Version": "string",
  "CallTriggersEnabled": true,
  "CallByNumbersEnabled": true,
  "DefaultContactSorting": "SortByFirstName",
  "DefaultNameFormat": "FirstNameFirst",
  "DefaultCallByNumberSIPAccountId": "Id",
  "AudioclipVolume": 100,
  "BeeperVolume": 80,
  "PresenceTimeout": 12,
  "CardReaderConfiguration": {
    CardReaderConfiguration
  },
  "CallButtonIdleBehavior": "Automatic"
}

The default method for sorting contacts.

The default format for the contact names.

This method is used to set the general configuration for the intercom.

Request

{
  "Configuration": {
    Configuration
  }
}

Response

{}

Error codes

This method is used to update the general configuration. Optional fields not present in the request will keep their current values.

Request

{
  "Configuration": {
    Configuration
  }
}

Response

{}

Error codes

This method is used to request the full configuration for the intercom.

Request

{
  "includeImageFile": (optional)
}

Response

{
  "Configuration": {
    Configuration
  }
}

This method implements the REST API for the device configuration and handles both GET, SET and REMOVE.

• Use GET /vapix/intercom/Configuration to fetch the configuration.

• Use POST /vapix/intercom/Configuration to initiate the UpdateConfiguration.

• Use PUT /vapix/intercom/Configuration to initiate the SetConfiguration.

Request

{
  "includeImageFile": (optional),
  "Configuration": {
    Configuration
  } (optional),
  "imageFile": {
    ImageFile
  } (optional)
}

Response

{
  "Configuration": {
    Configuration
  } (optional)
}

Error codes

Summarizes the call button configuration.

{
  "VMSCallEnabled": true,
  "NumberOfRecipients": 0
}

Summarizes the contact configuration.

{
  "NumberOfContacts": 0,
  "NumberOfOrganizations": 0
}

This method is used when you want to send out a request for the full configuration.

Request

{}

Response

{
  "CardReaderConfiguration": {
    CardReaderConfiguration
  }
}

This method is used when you want to retrieve a list of tag types supported by the reader.

Request

{}

Response

{
  "CardTypes": [
    {
      CardType
    },
    ...
  ]
}

This method is used when you want to retrieve a list of card types enabled by default.

Request

{}

Response

{
  "CardTypes": [
    "",
    ...
  ]
}

This method is used when you want to retrieve the UID of the last tag that was presented.

Request

{
  "ReaderId": "" (optional)
}

Response

{
  "Tag": {
    TagPresentedInfo
  }
}

Error codes

This method is used when you want to retrieve the UID of either the last presented tag or one recently presented that optionally matches the specified timestamp taken from the Device/Intercom/RFID event notification. If neither ReaderId nor timestamp is specified, the last tag will be returned

Request

{
  "ReaderId": "" (optional),
  "timestamp": "" (optional)
}

Response

{
  "Tag": {
    TagPresentedInfo
  }
}

Error codes

This method is used when you want to simulate presenting an RFID tag to the intercom reader. If the internal reader has been masked, it is recommended to make sure that the ReaderId is no longer Internal in the supplied tag.

Request

{
  "Tag": {
    TagPresentedInfo
  },
  "CardData": [
    {
      CardData
    },
    ...
  ]
}

Response

{}

Error codes

This method is used when you want to register an external application reader that can be used to process tags. This makes it possible to mask the internal reader so a tag from a normal card swipe don’t use a configured integration protocol.

Request

{
  "ReaderId": "",
  "DisableInternalReader": (optional),
  "MaskedReaderIds": [
    "<Id>",
    ...
  ],
  "UnmaskIfLost": (optional)
}

Response

{
  "Timeout": <int>
}

Error codes

This method is used when you want to un-register either an external reader or an application reader from being used to process tags.

Request

{
  "ReaderId": "<Id>"
}

Response

{}

Error codes

This method is used when you want to extend the timeout given in the RegisterReader call. An error will be returned if no call was made for the ReaderId or if it had already timed out.

Request

{
  "ReaderId": "<Id>"
}

Response

{
  "Timeout": <int>
}

Error codes

This method is used when you want to expose currently available readers.

Request

{}

Response

{
  "Readers": [
    {
      ReaderIdWithMask
    },
    ...
  ]
}

This structure is returned as a response to ProbeIPAccessConfiguration.

{
  "Name": "Door - Reader Entrance A8207",
  "Id": "e6608ad31a480904f9646e936cc8e86a",
  "IPProtocol": "RemoteActivity"
}

Probe an IP based access controller and return a list of selectable configurations. Please note that any current configuration will be overridden by the specified input parameters. Also, the ID of the desired IPAccessOption should be supplied to UpdateIPAccessConfiguration.

{
  "IPAccessConfiguration": {
    IPAccessConfiguration (optional)
  }
}

{
  "Status": "<string>",
  "StatusText": "<string>" (optional),
  "IPAccessOptions": [{
    IPAccessOption
  }, ...],
  "SuggestedId": "<string>" (optional),
  "CurrentName": "<string>" (optional)
}

Update the IPAccessConfiguration based on the selected IPAccessOption in the response from a previous ProbeIPAccessConfiguration.

{
  "Id": "<string>"
}

{
  "IPAccessConfiguration": {
    IPAccessConfiguration
  } (optional)
}

Get data stored on tags that support storage. You are able to specify the names of one or more configs already pre-loaded under CardReaderConfiguration/CardDataConfigs, or supply an ad-hoc CardDataConfig to be used without storing.

Request

{
  "DataConfigNames": [
    "<Id>",
    ...
  ],
  "CardDataConfigs": [
    {
      CardDataConfig
    },
    ...
  ]
}

Response

{
  "CardData": [
    {
      CardData
    },
    ...
  ]
}

This method is used when you want to retrieve a string containing the latest key sequence. The sequence is automatically reset when new keys are entered after a complete sequence. A sequence is completed by # or the call button ('C') or when the number of digits match the configured pin length when in PIN mode. The optional timestamp should be taken from the Device/Intercom/KeyPin event notification and must be an exact match. Providing the timestamp assures that you get the data corresponding to the event received, or a not found error if another sequence has already been presented. If no timestamp is specified, the last key sequence of the specified source will be returned. If neither source or timestamp is specified, the last key sequence will be returned.

Request

{
  "Source": "<string>" (optional),
  "timestamp": "<string>" (optional)
}

Response

{
  "KeySequence": "<string>",
  "Source": "<string>" (optional),
  "timestamp": "<string>" (optional)
}

This method is used when you want to simulate key presses.

Depending on the KeyPadState (see tns1:Device/tnsaxis:Intercom/KeypadState event), the sequence must be ended with a C to make a call or # to process the key sequence as a PIN.

No ending # is required when the state is KSM_PIN_MODE. The same state is automatically entered after a card swipe if Wiegand or OSDP has been configured, or if the SetUiFeedback call is used together with RequirePIN or PINPadRequest as highlevelFeedbacks.

Request

{
  "KeySequence": "<string>",
  "Source": "" (optional)
}

Response

{}

This table describes the feedback that can be received. Please note that this may be extended in the future.

Defines the supported types of run style.

The name of the LED types that the UiLedFeedback should be applied to.

The control type for the different LEDs.

Describes the possible idle behavior value for the call button.

See SupportedCallButtonIdleBehavior in ServiceCapabilities for values supported by your device.

Lists information about the LEDs available on the device.

{
  "ledId": "stripe",
  "ledType": "rgbpwm"
}

The identifiers used in the source field of the SetUIFeedback call.

Blinks a LED for a duration of time or during a loop.

See Enumeration: ColorName if the returned value is textual.

If the value is in hexadecimal (#RRGGBB) it will be interpreted as Monochrome vs RGB:

• If monochrome, only the LSB is effective.

• If RGB, 1st LSB corresponds to blue, 2nd LSB corresponds to green and 3rd LSB corresponds to red.

• MSB is not used.

Another possible value can be retrieved from PWM vs regular:

• If PWM, all values between 0-255 are valid.

• For non-PWM, 0 = off, 1-255 = on.

{
  "led": "backlight",
  "runStyle": "oneshot",
  "durationOnMillisec": 0,
  "durationOffMillisec": 0,
  "valueOn": "off",
  "valueOff": "off",
  "loops": 0,
  "handled": true
}

Signals either a beeper sound or an audio file to play.

{
  "durationOnMillisec": 0,
  "durationOffMillisec": 0,
  "loops": 0,
  "handled": true,
  "file": "string"
}

Describes the graphic sent to the device to be presented to the user.

{
  "image": "string",
  "durationMillisec": 0
}

This event is used to provide information about a detected RFID card.

The UID and card numbers are sent in plaintext if CardReaderConfiguration.SensitiveRFIDEventEnabled is true, otherwise they are sent as empty strings. If CardReaderConfiguration.SensitiveRFIDEventEnabled is false, you should use the GetLastTag method to retrieve the card information.

The Masked field will be true whenever the event comes from a masked reader, and should therefore not be used for final access decisions by an access control system. The data from a masked reader is not sent over the configured access control integration protocol (VAPIX reader, OSDP or Wiegand) and only available as an event for 3rd party integrations.

Whenever a RFID tag is detected, the device will provide the following events:

Topic: tns1:Device/tnsaxis:Intercom/RFID

<tt:MessageDescription IsProperty="false">
  <tt:Source>
    <tt:SimpleItemDescription Name="Source" Type="xs:string"/>
  </tt:Source>
  <tt:Data>
    <tt:SimpleItemDescription Name="UIDFormat" Type="xs:string"/>
    <tt:SimpleItemDescription Name="TagType" Type="xs:string"/>
    <tt:SimpleItemDescription Name="TagSubType" Type="xs:string"/>
    <tt:SimpleItemDescription Name="UID" Type="xs:string"/>
    <tt:SimpleItemDescription Name="BitCount" Type="xs:int"/>
    <tt:SimpleItemDescription Name="CardNumber" Type="xs:int"/>
    <tt:SimpleItemDescription Name="CardNumberBitCount" Type="xs:int"/>
    <tt:SimpleItemDescription Name="FacilityCode" Type="xs:int"/>
    <tt:SimpleItemDescription Name="FacilityCodeBitCount" Type="xs:int"/>
    <tt:SimpleItemDescription Name="Masked" Type="xs:boolean"/>
  </tt:Data>
</tt:MessageDescription>

This event provides information about Main States machine transitions.

Enumeration: MainState

The values for the MainState:

This event provides information about Main States machine transitions.

Whenever there is a transition from one to another main state, the device provides the following events:

Topic: tns1:Device/tnsaxis:Intercom/MainState

<tt:MessageDescription IsProperty="true">
  <tt:Source>
    <tt:SimpleItemDescription Name="Source" Type="xs:string"/>
  </tt:Source>
  <tt:Data>
    <tt:SimpleItemDescription Name="State" Type="xs:string"/>
    <tt:SimpleItemDescription Name="Presence" Type="xs:int"/>
  </tt:Data>
</tt:MessageDescription>

This event informs the subscribing client about the input key PIN value.

Whenever the key PIN is entered it is published as an event. The key PIN is terminated with # in cases when it is not completed as per the configuration in the reader and will be sent in plaintext if CardReaderConfiguration.SensitiveKeyPinEventEnabled is true or otherwise as the value of an empty string "". If CardReaderConfiguration.SensitiveKeyPinEventEnabled is false you should use the GetLastKeySequence method to fetch the PIN.

Topic: tns1:Device/tnsaxis:Intercom/KeyPin

<tt:MessageDescription IsProperty="false">
  <tt:Source>
    <tt:SimpleItemDescription Name="Source" Type="xs:string"/>
  </tt:Source>
  <tt:Data>
    <tt:SimpleItemDescription Name="KeyPin" Type="xs:string"/>
  </tt:Data>
</tt:MessageDescription>

This event will provide you with the information about the different keypad state transitions.

Enumeration: KeypadState

The keypad state can have the following values:

When there is a transition from one state to another, the device will provide the following event:

Topic: tns1:Device/tnsaxis:Intercom/KeypadState

<tt:MessageDescription IsProperty="true">
  <tt:Source>
    <tt:SimpleItemDescription Name="Source" Type="xs:string"/>
  </tt:Source>
  <tt:Data>
    <tt:SimpleItemDescription Name="State" Type="xs:string"/>
  </tt:Data>
</tt:MessageDescription>