Call service API

The Call service API is supported if:

Property

Properties.API.SIP.SIP=yes

Property

Properties.API.SIP.Version=2.0 and later.

Use axcall:GetServiceCapabilities to list the service capabilities. See GetServiceCapabilities command.

AOR

Address of record

DFMF

Dual-Tone Multi-Frequency

ICE

Interactive Connectivity Establishment

MWI

Message Waiting Indication

NAT

Network Address Translation

Non-normative enum

Enum whose values are used as strings.

PBX

Private Branch Exchange

SIP

Session Initiation Protocol

STUN

Session Traversal Utilities for NAT

TURN

Traversal Using Relays around NAT

All types defined by the Call service have an upper limit of maximum 100 entities per type. This policy is not enforced by the service, exceeding the limit is however not recommended as it may cause unexpected behavior.

Dual-Tone Multi-Frequency (DTMF), also known as touch-tone, is a signaling system used by telecommunication devices such as telephone handsets, switch centers, door stations, and other communication devices.

DTMF can be used to send commands to a remote device in order to instruct the remote device to perform certain actions. To send a command, the user presses the keys on a keypad in a certain sequence, for example #1234#. A DTMF packet is then created and sent to the other device. The receiving device decodes the packet and if the key sequence matches one of the allowed DTMF sequences in the receiving device, the device performs a user-defined action.

Axis products that support DTMF can receive, decode and identify DTMF sequences and can be configured to perform actions when a DTMF sequence is received. The Axis product can receive DTMF sequences sent over RTP (RFC 2833) and over SIP INFO (RFC 2976).

To check if the Axis product supports DTMF, use axcall:GetServiceCapabilities. See Service capabilities.

To configure an Axis product to allow an operator to unlock a door using a DTMF sequence, the following steps are required:

1. Connect the door lock to one of the Axis product’s output ports and use VAPIX® I/O port API to configure the port.

2. Enable SIP in the Axis product and configure the SIP settings.

3. Set up a DTMF event. Add the event to a DTMF configuration and add the DTMF configuration to a SIP account. See Set up a DTMF event.

4. Set up an action rule that listens to the DTMF event and activates the door lock output port when the event is received.

When the Axis product receives the correct DTMF sequence, the DTMF event is emitted and the door is unlocked.

If the Axis product is installed behind a NAT device, for example a network router, and needs to be able to make and receive calls from devices on the other side of the NAT device, SIP-specific port forwarding must be configured.

The following NAT traversal methods can be used with SIP:

• Interactive Connectivity Establishment (ICE)

• Session Traversal Utilities for NAT (STUN)

• Traversal Using Relays around NAT (TURN)

The NAT traversal method to use is specified in the SIPConfiguration. See SIPConfiguration.

Before the Axis product can be used to make SIP calls, the SIP protocol must be enabled in the product. For security reasons, SIP is disabled by default. For the Axis product to be able to receive incoming SIP calls, SIP and the AllowIncomingCalls functionality must both be enabled.

VMS calls can be made also if SIP is disabled.

The following pseudocode shows how to enable the SIP protocol. First, axcall:GetSIPConfiguration is used to retrieve the current SIP configuration. Then, axcall:SetSIPConfiguration is used to updated the SIP configuration.

{
  get_response = axcall.GetSIPConfiguration()
  config = get_response['SIPConfiguration']
  config['SIPEnabled'] = true
  axcall.SetSIPConfiguration(SIPConfiguration=config)
}

{
  "axcall:SetSIPConfiguration": {
    "SIPConfiguration": {
    "SIPEnabled": true,
    "TURNServers": [],
    "STUNServers": [],
    "ICEEnabled": false,
    "AllowIncomingCalls": false,
    "TURNEnabled": false,
    "STUNEnabled": false,
    "ApplyUserAuthentication": false,
    "AllowedUsers": [],
    "SIPPort": 5060,
    "SIPTLSPort": 5061,
    "ApplyAllowedURIs": false,
    "AllowedURIs": []
    }
  }
}

The request is described in SetSIPConfiguration command. The SIP configuration data structure is described in SIPConfiguration. See also NAT traversal.

A peer-to-peer account is a SIP account that is not registered at a SIP registrar. The account can be used to make peer-to-peer calls. Because the account is not registered, any UserId can be set. To make a call through a PBX or SIP provider, the account must be registered. See Add a registered SIP account.

The following pseudocode shows how to add a peer-to-peer account and how to check its status. The account is created using axcall:SetSIPAccount. The response returns the SIP account identifier SIPAccountId which should be used in subsequent requests. The account’s status is retrieved using axcall:GetSIPAccountStatus.

{
  account['UserId'] = "peer-to-peer"
  set_response = axcall.SetSIPAccount(SIPAccount=account)
  my_accountid = set_response['SIPAccountId']
  status_response = axcall.GetSIPAccountStatus(SIPAccountId=myaccountid)
  account_status = status_response['SIPAccountStatus']
}

{
  "axcall:SetSIPAccount":{
    "SIPAccount": {"UserId": "peer-to-peer"}
  }
}

{
  "SIPAccountId": "sip_account_0"
}

The request is described in SetSIPAccount command. The SIP account data structure is described in SIPAccount.

In simplified format, the corresponding request and response are:

format=simple&action=axcall:SetSIPAccount&SIPAccount_UserId=peer-to-peer 

SIPAccountId="sip_account_0"

Using the returned SIPAccountId, the account’s status can be retrieved using axcall:GetSIPAccountStatus.

{
  "axcall:GetSIPAccountStatus":
    "SIPAccountId": "sip_account_0"
  }
}

{
  "SIPAccountStatus":  {"SIPAccountId": "sip_account_0",
                      "SIPURI": "sip:192.168.0.90:5060",
                      "IsDefault": true,
                      "RegURI": ""
                      "Status": 0,
                      "StatusText": "Does not register"
  }
}

The SIP URI for a peer-to-peer account is sip:<LOCAL IP> where <LOCAL IP> is the Axis product’s IP address or DNS name. The IsDefault field indicates that the account is the default account, that is, the account that will be used when making a call if no other account is specified. For peer-to-peer accounts, the StatusText field is “Does not register”, Status is 0 and RegURI is empty. The request is described in GetSIPAccountStatus command. The SIP account status data structure is described in SIPAccountStatus.

In simplified format, the corresponding request and response are:

format=simple&action=axcall:GetSIPAccountStatus&SIPAccountId=sip_account_0

SIPAccountStatus_SIPAccountId="sip_account_0"
SIPAccountStatus_SIPURI="sip:192.168.0.90:5060"
SIPAccountStatus_RegURI=null
SIPAccountStatus_Status=0
SIPAccountStatus_StatusText="Does+not+register"

Accounts that have been set up at a SIP registrar can be added to the Axis product using axcall:SetSIPAccount.

In this example, an account with user id 6001 and password secure has been set up at the registrar with IP address 192.168.0.1. The public domain is example.axis.com and the SIP URI becomes sip:6001@example.axis.com

The account’s status can be requested using axcall:GetSIPAccountStatus.

{
  "axcall:SetSIPAccount": {
    "SIPAccount": {"UserId": "6001",
                   "Password": "secure",
                   "Registrar": "192.168.0.1",
                   "PublicDomain": "example.axis.com"}
  }
}

The response returns the SIPAccountId which is used as an identifier for the account. The identifier is used, for example, when making a call using axcall:Call and when verifying the account’s registration status using axcall:GetSIPAccountStatus.

{
  "SIPAccountId": "sip_account_0"
}

To check the SIP account’s registration status, use axcall:GetSIPAccountStatus. In the response, Status and StatusText are standard SIP response codes and response phrases.

{
  "axcall:GetSIPAccountStatus": { 
    "SIPAccountId": "sip_account_0"
  }
}

{
  "SIPAccountStatus": {"SIPAccountId": "sip_account_0",
                      "SIPURI": "sip:6001@example.axis.com",
                      "IsDefault": true,
                      "RegURI": "192.168.0.1"
                      "Status": 200,
                      "StatusText": "OK"}
}

In the SIP account, the StreamParameters field specifies the resolution and frame rate to use. If no stream parameters are specified, the account uses the Axis product’s default settings.

This example shows how to add a registered SIP account with resolution 640x480 and frame rate 25 fps.

{
  "axcall:SetSIPAccount": {
    "SIPAccount": {"UserId": "6001",
                   "Password": "secure",
                   "Registrar": "192.168.0.1",
                   "PublicDomain": "example.axis.com"}
                   "StreamParameters": "resolution=640x480&fps=25"}
  }
}

{
  "SIPAccountId": "sip_account_0"
}

This example shows how to add a registered SIP account with two SIP proxies that route communication to the registrar at 272.25.25.3. The SIP proxies will route traffic from top to down in the specified order, that is, 192.168.0.1 is contacted as the first node, then 10.23.23.2 and finally the registrar at 272.25.25.3 is contacted.

{
  "axcall:SetSIPAccount": {
    "SIPAccount": {"UserId": "6001",
                   "Password": "secure",
                   "Registrar": "272.25.25.3",
                   "SIPAccount": [{"Server": "192.168.0.1",
                         "Username": "username_proxy1",
                         "Password": "password_proxy1"},
                        {"Server": "10.23.23.2",
                         "Username": "username_proxy2",
                         "Password": "password_proxy2"}]
  }
}

The response returns the SIPAccountId which is used as an identifier for the account. The identifier is used, for example, when making a call using axcall:Call and when verifying the account’s registration status using axcall:GetSIPAccountStatus.

{
  "SIPAccountId": "sip_account_0"
}

When SIP has been enabled and an account is set up, it is possible to call a remote SIP URI using axcall:Call. The request returns the call identifier CallId. Using CallId, the status of the call can be requested using axcall:GetCallStatus.

The following pseudocode shows how to make a call from the Axis product to sip:6002@example.axis.com. The call is made using axcall:Call. The response returns the call identifier CallId which is used in subsequent requests. The call’s status is requested using axcall:GetCallStatus. When the call is answered, the call status changes from Calling to Active.

{
  call_response = axcall.Call(To="sip:6002@example.axis.com")
  status_response = axcall.GetCallStatus(CallId=call_response['CallId'])
  while (status_response.CallState == "Calling") {
    sleep(1);
    status_response = axcall.GetCallStatus(CallId=call_response['CallId'])
  }
  if (status_response.CallState == "Active") {
    // Call ok
  } else {
    // No answer
  }
}

{
  "axcall:Call": {
    "To" : "sip:6002@example.axis.com"
    }
  }
}

{
  "CallId": "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF"
}

The request is described in Call command.

{
  "axcall:GetCallStatus": {
    "CallId": "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF"
    }
  }
}

{
  "CallStatus": {"CallId": "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF",
                "CallState": "Calling",
                "CallType": "SIP",
                ... }
}

The request is described in GetCallStatus command. The CallStatus data structure is described in CallStatus.

format=simple&action=axcall:Call&To=sip:6002@example.axis.com

CallId="Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKFgSGIVX5lwi"

format=simple&action=axcall:GetCallStatus&CallId=Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF

CallStatus_CallId="Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF"
CallStatus_CallState="Calling"
CallStatus_CallType="SIP"

A call in progress can be terminated using axcall:TerminateCall.

The following pseudocode shows how to terminate a call.

{
  call_response = axcall.Call(To="sip:6002@example.axis.com")
  axcall.TerminateCall(CallId=call_response['CallId'])
}

{
  "axcall:TerminateCall": { 
    "CallId" : "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKFgSGIVX5lwi"
    }
  }
}

The request is described in TerminateCall command.

format=simple&action=axcall:TerminateCall&CallId=Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF

The Call service can recognize a DTMF sequence, for example #1234# and use the sequence to emit a DTMF event. The Axis product or a third-party application that listens to DTMF events can use the event to trigger actions, for example to activate an output port in order to unlock a door, or to send a notification. For more information, see DTMF signaling.

The DTMF event syntax is described in DTMF event.

The following pseudocode shows the workflow for setting up a DTMF event:

1. Create a DTMF event using axcall:SetDTMFEvent. The event in this example is called OpenDoorEvent.

2. Create a DTMF trigger using axcall:SetDTMFTrigger. The DTMF trigger connects a DTMF event with a specific DTMF sequence, in this case #1234#.

3. Add the DTMF trigger to a DTMF configuration using axcall:SetDTMFConfiguration.

4. Add the DTMF configuration to a SIP account using axcall:SetSIPAccount.

// Create a DTMF event
DTMFEventId dtmf_event_id = 
    axcall.SetDTMFEvent({"Name": "OpenDoorEvent",
                      "Enabled": true});
 
// Create a DTMF trigger.
DTMFTriggerId dtmf_trigger_id = 
    axcall.SetDTMFTrigger({"DTMFSequence": "#1234#",
                          "DTMFEventId" : dtmf_event_id});
 
// Add the DTMF trigger to a DTMF configuration.
DTMFConfigurationId dtmf_conf_id = 
    axcall.SetDTMFConfiguration({"Name": "OpenDoorDTMFConf", 
                              "DTMFTriggerId": [dtmf_trigger_id]})
 
// Add the DTMF configuration to a SIP account.
SIPAccount account = axcall.GetSIPAccount({"AccountId": "sip_account_0"});
account["DTMFConfigurationId"] = dtmf_conf_id;
axcall.SetSIPAccount(account);

The same DTMF configuration can be used in multiple SIP accounts but a SIP account can also have its own DTMF configuration. Using different DTMF configurations in different SIP accounts makes it possible to restrict access to certain DTMF sequences. For example, a more restrictive configuration might be required when calling an exposed cell phone as compared to calling the in-house security office.

The following pseudocode shows a setup with two different DTMF configurations Limited and Full Access. Workflow:

1. Create two DTMF events, Event A and Event B, using axcall:SetDTMFEvents.

2. Create one DTMF trigger for each event using axcall:SetDTMFTriggers. The first trigger connects DTMF sequence 1 to Event A. The second trigger connects DTMF sequence 2 to Event B.

3. Create a DTMF configuration Full Access that contains both triggers. SIP accounts with this DTMF configuration will accept both DTMF sequences.

4. Create a DTMF configuration Limited with only one of the triggers. SIP accounts with this DTMF configuration will only accept DTMF sequence 1.

// Create two DTMF events.
DTMFEventId[] dtmf_events = axcall.SetDTMFEvents([{"Name": "Event A"},
                    {"Name": "Event B"}]);
 
DTMFEventId dtmf_event_a = dtmf_events[0]; // Assumption of order.
DTMFEventId dtmf_event_b = dtmf_events[1]; 
 
// Create two DTMF triggers
DTMFTriggerId[] dtmf_trigger_ids = axcall.SetDTMFTriggers([{"DTMFSequence": "1", 
                    "DTMFEventId" : dtmf_event_a}, 
                    {"DTMFSequence": "2", 
                    "DTMFEventId" : dtmf_event_b}]);
 
// Create the DTMF configuration "Full Access"
DTMFConfigurationId dtmf_conf_full_access = 
    axcall.SetDTMFConfiguration({"Name": "Full Access", 
                          "DTMFSequence": dtmf_trigger_ids});
 
// Create the DTMF configuration "Limited"
DTMFTriggerId only_trigger_a = dtmf_trigger_ids[0] // Assumption of order.
DTMFConfigurationId dtmf_conf_limited = 
    axcall.SetDTMFConfiguration({"Name": "Limited", 
                          "DTMFSequence": [only_trigger_a]});

Several DTMF sequences can trigger the same DTMF event but a single DTMF sequence cannot trigger several different DTMF events. If a DTMF sequence (sequence 1) is used to trigger a certain DTMF event (event A) and one wants to change the configuration so that the DTMF sequence triggers another DTMF event (event B), then the DTMF trigger that connects sequence 1 to event A must be updated so that the trigger instead connects sequence 1 to event B.

The following pseudocode shows how to change the DTMF event triggered by a DTMF sequence:

1. Create two DTMF events.

2. Create one DTMF trigger for each event. The first trigger connects DTMF sequence 1234 to DTMF event Event A. The second trigger connects DTMF sequence 5678 to DTMF event Event B.

3. Try to create a new DTMF trigger that connects the first DTMF sequence 1234 to Event B. This request will fail because the same DTMF sequence cannot trigger different events.

4. Update the DTMF trigger for DTMF sequence 1234 so that the sequence triggers Event B instead. The two DTMF sequences will now trigger the same event.

// Create two DTMF events
DTMFEventId[] dtmf_events = axcall.SetDTMFEvents([{"Name": "Event A"}, 
        {"Name": "Event B"}]);
DTMFEventId dtmf_event_a = dtmf_events[0];
DTMFEventId dtmf_event_b = dtmf_events[1];
 
// Add a DTMF trigger for each event
DTMFTriggerId[] trigger_ids = 
    axcall.SetDTMFTriggers([{"DTMFSequence": "1234", 
            "DTMFEventId" : dtmf_event_a}, 
            {"DTMFSequence": "5678", 
            "DTMFEventId" : dtmf_event_b}]);
// Assumption of order
trigger_id_1234 = trigger_ids[0];
trigger_id_5678 = trigger_ids[1];
 
// Try to connect the DTMF sequence "1234" to DTMF event B. This will fail.
 axcall.SetDTMFTrigger({"DTMFSequence", "1234" "DTMFEventId" : dtmf_event_b});
 
// Update the DTMF trigger with identifier trigger_id_1234 so that both sequences trigger the same event. 
axcall.SetDTMFTrigger({"DTMFTriggerId": trigger_id_1234, "DTMFEventId": dtmf_event_b});

A VMS call is a call simulated using the Axis product’s event system as described in VMS calls. VMS calls are intended for clients that use the Video streaming API:s instead of SIP.

VMS calls can be made also if SIP is disabled.

The following pseudocode shows how to make a VMS call from the Axis product. The call is made using axcall:Call with To="VMS_CALL". The response returns the call identifier CallId which is used in subsequent requests. The call’s status is requested using axcall:GetCallStatus. When the call is answered, the call status changes from Calling to Active.

{
  call_response = axcall.Call(To="VMS_CALL")
  status_response = axcall.GetCallStatus(CallId=call_response['CallId'])
  while (status_response.CallState == "Calling") {
    sleep(1);
    status_response = axcall.GetCallStatus(CallId=call_response['CallId'])
  }
  if (status_response.CallState == "Active") {
    // Call ok
  } else {
    // No answer
  }
}

{
  "axcall:Call": {
    "To" : "VMS_CALL"
    }
  }
}

{
  "CallId": "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF"
}

The request is described in Call command.

{
  "axcall:GetCallStatus": {
    "CallId": "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF"
    }
  }
}

{
  "CallStatus": {"CallId": "Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF",
                "CallState": "Calling",
                "CallType": "VMS",
                ... }
}

The request is described in GetCallStatus command. The CallStatus data structure is described in CallStatus.

format=simple&action=axcall:Call&To=VMS_CALL

CallId="Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKFgSGIVX5lwi"

format=simple&action=axcall:GetCallStatus&CallId=Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF

CallStatus_CallId="Out-0-1401964712.117694-gIRuBDTzh7BDKXw-5mDFKF"
CallStatus_CallState="Calling"
CallStatus_CallType="VMS"

Use axcall.SetAudioCodecs to configure the audio codec priority list used for SIP calls.

// Get all audio codecs
AudioCodec[] all_codecs = axcall.GetSupportedAudioCodecs()
 
// Get the default audio codec priority list
AudioCodec[] default_priority_list = axcall.GetDefaultAudioCodecs()
 
// Get the current audio codec priority list
AudioCodec[] current_priority_list = axcall.GetAudioCodecs()
 
// Rearrange the priority list
AudioCodec[] new_priority_list  = ...
set_response = axcall.SetAudioCodecs(AudioCodec=new_priority_list)

The following sections provide an overview of the events emitted when the Axis product makes or receives a call.

The events are described in Call state event and Call state change event.

Outgoing SIP call

tnsaxis:Call/State
 
Data: CallState=Idle

tnsaxis:Call/StateChange
 
Data: Reason=Initiated

tnsaxis:Call/State
 
Data: CallState=Calling

tnsaxis:Call/StateChange
 
Data: Reason=AcceptedByRemote

tnsaxis:Call/State
 
Data: CallState=Active

tnsaxis:Call/StateChange
 
Data: Reason=Terminated

tnsaxis:Call/State
 
Data: CallState=Idle

Incoming SIP call

tnsaxis:Call/State
 
Data: CallState=Idle

tnsaxis:Call/StateChange
 
Data: Reason=AcceptedByDevice

tnsaxis:Call/State
 
Data: CallState=Active

tnsaxis:Call/StateChange
 
Data: Reason=Terminated

tnsaxis:Call/State
 
Data: CallState=Idle

Outgoing VMS call

tnsaxis:Call/State
 
Data: CallState=Idle

tnsaxis:Call/StateChange
 
Data: Reason=Initiated

tnsaxis:Call/State
 
Data: CallState=Calling

tnsaxis:Call/StateChange
 
Data: Reason=NoAnswer

tnsaxis:Call/State
 
Data: CallState=Idle

tnsaxis:Call/StateChange
 
Data: Reason=AcceptedByRemote

tnsaxis:Call/State
 
Data: CallState=Active

tnsaxis:Call/StateChange
 
Data: Reason=Terminated

tnsaxis:Call/State
 
Data: CallState=Idle

Incoming VMS call

tnsaxis:Call/State
 
Data: CallState=Idle

tnsaxis:Call/StateChange
 
Data: Reason=AcceptedByDevice

tnsaxis:Call/State
 
Data: CallState=Active

tnsaxis:Call/StateChange
 
Data: Reason=Terminated

tnsaxis:Call/State
 
Data: CallState=Idle

ServiceCapabilities

Use the GetServiceCapabilities command to retrieve the capabilities supported by the service.

Command

axcall:GetServiceCapabilities

{}

The request is empty.

{
  "Capabilities": { ServiceCapabilities }
}

with the following data fields:

Use the Call command to make a call. The request returns a call identifier CallId which is used to identify the call.

Command

axcall:Call

{
  "SIPAccountId": "<SIPAccountId>" (optional),
  "To": "<string>"
}

with the following data fields:

{
  "CallId": "<CallId>"
}

with the following data fields:

Use the TerminateCall command to terminate an ongoing call.

Command

axcall:TerminateCall

{
  "CallId": "<CallId>"
}

with the following data fields:

{}

The response is empty.

CallId

CallStatus

Enumeration: CallState

Enumeration: CallStateChangeReason

Enumeration: CallDirection

Enumeration: CallType

Use the GetCallStatus command to request the current CallStatus of a given call. The call is specified by its CallId.

Command

axcall:GetCallStatus

{
  "CallId": "<CallId>"
}

with the following data fields:

{
  "CallStatus": { CallStatus }
}

with the following data fields:

Use the GetCallStatuses command to request the current CallStatus for multiple calls. The calls are specified by a list of CallId:s. If no CalllId:s are specified, the CallStatus for all calls with be returned. If a CallId cannot be resolved, the CallId is ignored.

Command

axcall:GetCallStatuses

{
  "CallId": ["<CallId>", ...]
}

with the following data fields:

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

with the following data fields:

SIPConfiguration

Enumeration: SIPTransport

STUNServer

TURNServer

Attribute

Enumeration: AttributeType

AttributeInfo

Use the GetSupportedSIPConfigurationAttributes command to list supported attributes for the SIP configuration.

Command

axcall:GetSupportedSIPConfigurationAttributes

{}

The request is empty.

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

with the following data fields:

Use the GetSIPConfiguration command to retrieve the current SIP configuration.

Command

axcall:GetSIPConfiguration

{}

The request is empty.

{
  "SIPConfiguration": { SIPConfiguration }
}

with the following data fields:

Use the SetSIPConfiguration command to update the current SIP configuration.

Command

axcall:SetSIPConfiguration

{
  "SIPConfiguration": { SIPConfiguration }
}

with the following data fields:

{}

The response is empty.

SIPAccount

SIPAccountId

SIPProxy

Enumeration: MediaEncryption

Enumeration: EncryptionProtocol

Use the GetSupportedMediaEncryptionModes command to list supported media encryption modes.

Command

axcall:GetSupportedMediaEncryptionModes

{}

The request is empty.

{
  "MediaEncryption": ["<string>",...]
}

with the following data fields:

Use the GetSupportedSIPAccountAttributes command to list supported attributes for the SIP account.

If an attempt is made to set an attribute which is not implemented, that attribute is silently ignored.

Command

axcall:GetSupportedSIPAccountAttributes

{}

The request is empty.

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

with the following data fields:

Use the GetSIPAccount command to retrieve the settings for a SIP account. This request is used for single SIP accounts. To retrieve multiple accounts, use GetSIPAccounts, see GetSIPAccounts command.

Command

axcall:GetSIPAccount

{
  "SIPAccountId": "<SIPAccountId>"
}

with the following data fields:

{
  "SIPAccount": { SIPAccount }
}

with the following data fields:

Use the GetSIPAccounts command to retrieve the settings for multiple SIP accounts. To retrieve the settings for a single account, use GetSIPAccount, see GetSIPAccount command.

A SIP account is specified by its SIPAccountId. If a SIPAccountId in the list cannot be resolved, that SIPAccountId is ignored. If there are no valid SIPAccountId:s, the request returns an empty set.

A request without any specified SIPAccountId:s returns settings for all SIP accounts.

Command

axcall:GetSIPAccounts

{
  "SIPAccountId": ["<SIPAccountId>", ...]
}

with the following data fields:

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

with the following data fields:

Use the SetSIPAccount command to add or update a SIP account. This request is used for single SIP accounts. To add or update multiple accounts, use SetSIPAccounts, see SetSIPAccounts command.

If the supplied SIPAccountId matches an existing SIP account, the SIP account is updated. Otherwise, a new SIP account is created.

Command

axcall:SetSIPAccount

{
  "SIPAccount": { SIPAccount }
}

with the following data fields:

{
  "SIPAccountId": "<SIPAccountId>"
}

with the following data fields:

Use the SetSIPAccounts command to add or update multiple SIP accounts. To update a single SIP account, use SetSIPAccount, see SetSIPAccount command.

If a supplied SIPAccountId matches an existing SIP account, the SIP account is updated. Otherwise, a new SIP account is created.

Command

axcall:SetSIPAccounts

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

with the following data fields:

{
  "SIPAccountId": ["<SIPAccountId>", ...]
}

with the following data fields:

Use the RemoveSIPAccount command to remove a SIP account. This request removes a single account. To remove multiple accounts, use RemoveSIPAccounts, see RemoveSIPAccounts command.

If the SIPAccountId cannot be resolved, the request is ignored.

Command

axcall:RemoveSIPAccount

{
  "SIPAccountId": "<SIPAccountId>"
}

with the following data fields:

{}

The response is empty.

Use the RemoveSIPAccounts command to remove multiple SIP accounts. To remove a single account, use RemoveSIPAccount, see RemoveSIPAccount command.

If a SIPAccountId cannot be resolved, that SIPAccountId is ignored.

Command

axcall:RemoveSIPAccounts

{
  "SIPAccountId": ["<SIPAccountId>", ...]
}

with the following data fields:

{}

The response is empty.

SIPAccountStatus

Use the GetSIPAccountStatus command to retrieve the current status of a SIP account. This request is used for single SIP accounts. To retrieve multiple accounts, use GetSIPAccountStatuses, see GetSIPAccountStatuses command.

Command

axcall:GetSIPAccountStatus

{
  "SIPAccountId": "<SIPAccountId>"
}

with the following data fields:

{
  "SIPAccountStatus": { SIPAccountStatus }
}

with the following data fields:

Use the GetSIPAccountStatuses command to retrieve the current statuses of multiple SIP accounts. To retrieve the status of a single SIP account, use GetSIPAccountStatus, see GetSIPAccountStatus command.

A SIP account is specified by its SIPAccountId. If a SIPAccountId in the list cannot be resolved, that SIPAccountId is ignored. If there are no valid SIPAccountId:s, the request returns an empty set.

A request without any specified SIPAccountId:s returns statuses for all SIP accounts.

Command

axcall:GetSIPAccountStatuses

{
  "SIPAccountId": ["<SIPAccountId>", ...]
}

with the following data fields:

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

with the following data fields:

DTMFConfigurationId

DTMFSequence

DTMFConfiguration

Use the GetDTMFConfiguration command to retrieve the settings for a DTMF configuration. This request is used for single DTMF configurations. To retrieve multiple configurations, use GetDTMFConfigurations, see GetDTMFConfigurations command.

Command

axcall:GetDTMFConfiguration

{
  "DTMFConfigurationId": "<DTMFConfigurationId>"
}

with the following data fields:

{
  "DTMFConfiguration": { DTMFConfiguration }
}

with the following data fields:

Use the GetDTMFConfigurations command to retrieve the settings for multiple DTMF configurations. To retrieve the settings for a single configuration, use GetDTMFConfiguration, see GetDTMFConfiguration command.

A DTMF configuration is specified by its DTMFConfigurationId. If a DTMFConfigurationId in the list cannot be resolved, that DTMFConfigurationId is ignored. If there are no valid DTMFConfigurationId:s, the request returns an empty set.

A request without any specified DTMFConfigurationId:s returns all DTMF configurations.

Command

axcall:GetDTMFConfigurations

{
  "DTMFConfigurationId": ["<DTMFConfigurationId>", ...]
}

with the following data fields:

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

with the following data fields:

Use the SetDTMFConfiguration command to add or update a DTMF configuration. This request is used for single DTMF configurations. To add or update multiple configurations, use SetDTMFConfigurations, see SetDTMFConfigurations command.

If the supplied DTMFConfigurationId matches an existing DTMF configuration, the DTMF configuration is updated. Otherwise, a new DTMF configuration is created.

Command

axcall:SetDTMFConfiguration

{
  "DTMFConfiguration": { DTMFConfiguration }
}

with the following data fields:

{
  "DTMFConfigurationId": "<DTMFConfigurationId>"
}

with the following data fields:

Use the SetDTMFConfigurations command to add or update multiple DTMF configurations. To update a single DTMF configuration, use SetDTMFConfiguration, see SetDTMFConfiguration command.

If a supplied DTMFConfigurationId matches an existing DTMF configuration, the DTMF configuration is updated. Otherwise, a new DTMF configuration is created.

Command

axcall:SetDTMFConfigurations

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

with the following data fields:

{
  "DTMFConfigurationId": ["<DTMFConfigurationId>", ...]
}

with the following data fields:

Use the RemoveDTMFConfiguration command to remove a DTMF configuration. This request removes a single configuration. To remove multiple configurations, use RemoveDTMFConfigurations, see RemoveDTMFConfigurations command.

A DTMF configuration is specified by its DTMFConfigurationId. If the supplied DTMFConfigurationId cannot be resolved, the request is ignored.

Command

axcall:RemoveDTMFConfiguration

{
  "DTMFConfigurationId": "<DTMFConfigurationId>"
}

with the following data fields:

{}

The response is empty.

Use the RemoveDTMFConfigurations command to remove multiple DTMF configurations. To remove a single configuration, use RemoveDTMFConfiguration, see RemoveDTMFConfiguration command.

A DTMF configuration is specified by its DTMFConfigurationId. If a supplied DTMFConfigurationId cannot be resolved, that DTMFConfigurationId is ignored.

Command

axcall:RemoveDTMFConfigurations

{
  "DTMFConfigurationId": ["<DTMFConfigurationId>", ...]
}

with the following data fields:

{}

The response is empty.

DTMFEventId

DTMFEvent

Use the GetDTMFEvent command to retrieve the settings for a DTMF event configuration. This request is used for single DTMF event configurations. To retrieve multiple event configurations, use GetDTMFEvents, see GetDTMFEvents command.

Command

axcall:GetDTMFEvent

{
  "DTMFEventId": "<DTMFEventId>"
}

with the following data fields:

{
  "DTMFEvent": { DTMFEvent }
}

with the following data fields:

Use the GetDTMFEvents command to retrieve the settings for multiple DTMF event configurations. To retrieve the settings for a single event configuration, use GetDTMFEvent, see GetDTMFEvent command.

A DTMF event configuration is specified by its DTMFEventId. If a DTMFEventId in the list cannot be resolved, that DTMFEventId is ignored. If there are no valid DTMFEventId:s, the request returns an empty set.

A request without any specified DTMFEventId:s returns all DTMF event configurations.

Command

axcall:GetDTMFEvents

{
  "DTMFEventId": ["<DTMFEventId>", ...]
}

with the following data fields:

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

with the following data fields:

Use the SetDTMFEvent command to add or update a DTMF event configuration. This request is used for single DTMF event configurations. To add or update multiple event configurations, use SetDTMFEvents, see SetDTMFEvents command.

If the supplied DTMFEventId matches an existing DTMF event configuration, the event configuration is updated. Otherwise, a new event configuration is created.

Command

axcall:SetDTMFEvent

{
  "DTMFEvent": { DTMFEvent }
}

with the following data fields:

{
  "DTMFEventId": "<DTMFEventId>"
}

with the following data fields:

Use the SetDTMFEvents command to add or update multiple DTMF event configurations. To update a single DTMF event configuration, use SetDTMFEvent, see SetDTMFEvent command.

If a supplied DTMFEventId matches an existing DTMF event configuration, the event configuration is updated. Otherwise, a new event configuration is created.

Command

axcall:SetDTMFEvents

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

with the following data fields:

{
  "DTMFEventId": ["<DTMFEventId>", ...]
}

with the following data fields:

Use the RemoveDTMFEvent command to remove a DTMF event configuration. This request removes a single DTMF event configuration. To remove multiple event configurations, use RemoveDTMFEvents, see RemoveDTMFEvents command.

If the DTMFEventId cannot be resolved, the request is ignored.

Command

axcall:RemoveDTMFEvent

{
  "DTMFEventId": "<DTMFEventId>"
}

with the following data fields:

{}

The response is empty.

Use the RemoveDTMFEvents command to remove multiple DTMF event configurations. To remove a single DTMF event configuration, use RemoveDTMFEvent, see RemoveDTMFEvent command.

If a DTMFEventId cannot be resolved, that DTMFEventId is ignored.

Command

axcall:RemoveDTMFEvents

{
  "DTMFEventId": ["<DTMFEventId>", ...]
}

with the following data fields:

{}

The response is empty.

DTMFTriggerId

DTMFTrigger

Use the GetDTMFTrigger command to retrieve the settings for a DTMF trigger. This request is used for single DTMF triggers. To retrieve multiple triggers, use GetDTMFTriggers, see GetDTMFTriggers command.

Command

axcall:GetDTMFTrigger

{
  "DTMFTriggerId": "<DTMFTriggerId>"
}

with the following data fields:

{
  "DTMFTrigger": { DTMFTrigger }
}

with the following data fields:

Use the GetDTMFTriggers command to retrieve the settings for multiple DTMF triggers. To retrieve the settings for a single trigger, use GetDTMFTrigger, see GetDTMFTrigger command.

A DTMF trigger is specified by its DTMFTriggerId. If a DTMFTriggerId in the list cannot be resolved, that DTMFTriggerId is ignored. If there are no valid DTMFTriggerId:s, the request returns an empty set.

A request without any specified DTMFTriggerId:s returns all DTMF triggers.

Command

axcall:GetDTMFTriggers

{
  "DTMFTriggerId": ["<DTMFTriggerId>", ...]
}

with the following data fields:

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

with the following data fields:

Use the SetDTMFTrigger command to add or update a DTMF trigger. This request is used for single DTMF triggers. To add or update multiple triggers, use SetDTMFTriggers, see SetDTMFTriggers command.

If the supplied DTMFTriggerId matches an existing DTMF trigger, the DTMF trigger is updated. Otherwise, a new DTMF trigger is created.

If the supplied DTMFSequence matches the DTMFSequence in another DTMF trigger, the request is considered invalid.

Command

axcall:SetDTMFTrigger

{
  "DTMFTrigger": { DTMFTrigger }
}

with the following data fields:

{
  "DTMFTriggerId": "<DTMFTriggerId>"
}

with the following data fields:

Use the SetDTMFTriggers command to add or update multiple DTMF triggers. To update a single DTMF trigger, use SetDTMFTrigger, see SetDTMFTrigger command.

If a supplied DTMFTriggerId matches an existing DTMF trigger, the DTMF trigger is updated. Otherwise, a new DTMF trigger is created.

If a supplied DTMFSequence matches the DTMFSequence in another DTMF trigger, the request is considered invalid.

Command

axcall:SetDTMFTriggers

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

with the following data fields:

{
  "DTMFTriggerId": ["<DTMFTriggerId>", ...]
}

with the following data fields:

Use the RemoveDTMFTrigger command to remove a DTMF trigger. This request removes a single trigger. To remove multiple triggers, use RemoveDTMFTriggers, see RemoveDTMFTriggers command.

If the DTMFTriggerId cannot be resolved, the request is ignored.

Command

axcall:RemoveDTMFTrigger

{
  "DTMFTriggerId": "<DTMFTriggerId>"
}

with the following data fields:

{}

The response is empty.

Use the RemoveDTMFTriggers command to remove multiple DTMF triggers. To remove a single trigger, use RemoveDTMFTrigger, see RemoveDTMFTrigger command.

If a DTMFTriggerId cannot be resolved, that DTMFTriggerId is ignored.

Command

axcall:RemoveDTMFTriggers

{
  "DTMFTriggerId": ["<DTMFTriggerId>", ...]
}

with the following data fields:

{}

The response is empty.

VMSCallConfiguration

Use the GetVMSCallConfiguration command to retrieve the current VMS call configuration.

Command

axcall:GetVMSCallConfiguration

{}

The request is empty.

{
  "VMSCallConfiguration": { VMSCallConfiguration }
}

with the following data fields:

Use the SetVMSCallConfiguration command to update the VMS call configuration.

Command

axcall:SetVMSCallConfiguration

{
  "VMSCallConfiguration": { VMSCallConfiguration }
}

with the following data fields:

{}

The response is empty.

AudioCodec

Use the GetDefaultAudioCodecs command to list the Axis product’s default audio codec priority list. The first codec in the list has highest priority.

Command

axcall:GetDefaultAudioCodecs

{}

The request is empty.

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

with the following data fields:

Use the GetSupportedAudioCodecs command to list all audio codecs available in the Axis product.

Command

axcall:GetSupportedAudioCodecs

{}

The request is empty.

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

with the following data fields:

Use the GetAudioCodecs command to retrieve the audio codec priority list. This is the priority list sent to call recipients. The first codec in the list has highest priority.

Command

axcall:GetAudioCodecs

{}

The request is empty.

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

with the following data fields:

Use the SetAudioCodecs command to update the audio codec priority list sent to call recipients. The first codec in the list has highest priority.

Command

axcall:SetAudioCodecs

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

with the following data fields:

{}

The response is empty.