Content
Snom phones support the following requests send to the phone:Â
Events
RequestSystemStatus
<RequestSystemStatus xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<?xml version="1.0" encoding="utf-8"?> <RequestSystemStatusResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <systemStatus>normal</systemStatus> </RequestSystemStatusResponse>
MonitorStart (device-type)
<MonitorStart xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <monitorObject> <deviceObject>sip:455455@ser.intern.snom.de</deviceObject> </monitorObject> </MonitorStart>
<?xml version="1.0" encoding="utf-8"?> <MonitorStartResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <monitorCrossRefID>43</monitorCrossRefID> <monitorExistingCalls>true</monitorExistingCalls> </MonitorStartResponse>
MonitorStop (since 8.7.4)
<MonitorStop xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <monitorCrossRefID>43</monitorCrossRefID> </MonitorStop>
<?xml version="1.0" encoding="utf-8"?> <MonitorStopResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
SystemRegister (since 8.7.4)
<SystemRegister xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <requestTypes> <switchingFunctionDevicesChanged>true</switchingFunctionDevicesChanged> </requestTypes> </SystemRegister>
<?xml version="1.0" encoding="utf-8"?> <SystemRegisterResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <sysStatRegisterID>43</sysStatRegisterID> </SystemRegisterResponse>
SnapshotDevice
<SnapshotDevice xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <snapshotObject>455455@ser.intern.snom.de</snapshotObject> </SnapshotDevice>
<?xml version="1.0" encoding="utf-8"?> <SnapshotDeviceResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <crossRefIDorSnapshotData> <snapshotData> <snapshotDeviceResponseInfo> <connectionIdentifier> <callID>-12</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </connectionIdentifier> <localCallState> <compoundCallState> <localConnectionState>alerting</localConnectionState> </compoundCallState> </localCallState> </snapshotDeviceResponseInfo> </snapshotData> </crossRefIDorSnapshotData> </SnapshotDeviceResponse>
MakeCall
<MakeCall xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <callingDevice>sip:455455@ser.intern.snom.de</callingDevice> <calledDirectoryNumber>455360</calledDirectoryNumber> <autoOriginate>doNotPrompt</autoOriginate> </MakeCall>
<?xml version="1.0" encoding="utf-8"?> <MakeCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <callingDevice> <callID>2</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </callingDevice> </MakeCallResponse>
callingDevice is the user_name@ pbx of a configured identity. When this field has an empty value, then the active identity is used to make the call. Otherwise the value is used to choose the identity by comparing the value with the configured user name of every identity.
ConsultationCall (since 8.7.4)
<ConsultationCall xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <existingCall> <callID>3</callID> <deviceID>sip:455370@ser.intern.snom.de</deviceID> </existingCall> <consultedDevice>455320</consultedDevice> </ConsultationCall>
<?xml version="1.0" encoding="utf-8"?> <ConsultationCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <initiatedCall> <callID>4</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </initiatedCall> </ConsultationCallResponse>
AnswerCall
<AnswerCall xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <callToBeAnswered> <callID>-17</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </callToBeAnswered> </AnswerCall>
<?xml version="1.0" encoding="utf-8"?> <AnswerCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
ClearConnection
<ClearConnection xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <connectionToBeCleared> <callID>2</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </connectionToBeCleared> </ClearConnection>
<?xml version="1.0" encoding="utf-8"?> <ClearConnectionResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
HoldCall
<HoldCall xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed4"> <callToBeHeld> <callID>4</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </callToBeHeld> </HoldCall>
<?xml version="1.0" encoding="utf-8"?> <HoldCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
RetrieveCall
<RetrieveCall xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed4"> <callToBeRetrieved> <callID>4</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </callToBeRetrieved> </RetrieveCall>
<?xml version="1.0" encoding="utf-8"?> <RetrieveCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
ConferenceCall
<ConferenceCall xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed4"> <heldCall> <callID>13</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </heldCall> <activeCall> <callID>14</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </activeCall> </ConferenceCall>
<?xml version="1.0" encoding="utf-8"?> <ConferenceCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <conferenceCall> <callID>14|13</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </conferenceCall> <connections> <connectionListItem> <newConnection> <callID>14|13</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </newConnection> <oldConnection> <callID>14</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </oldConnection> </connectionListItem> <connectionListItem> <newConnection> <callID>14|13</callID> <deviceID>sip:455820@ser.intern.snom.de</deviceID> </newConnection> <oldConnection> <callID>14</callID> <deviceID>sip:455820@ser.intern.snom.de</deviceID> </oldConnection> </connectionListItem> <connectionListItem> <newConnection> <callID>14|13</callID> <deviceID>sip:455370@ser.intern.snom.de</deviceID> </newConnection> <oldConnection> <callID>13</callID> <deviceID>sip:455370@ser.intern.snom.de</deviceID> </oldConnection> </connectionListItem> </connections> </ConferenceCallResponse>
TransferCall
<TransferCall xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed4"> <heldCall> <callID>16</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </heldCall> <activeCall> <callID>15</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </activeCall> </TransferCall>
<?xml version="1.0" encoding="utf-8"?> <TransferCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <transferredCall> <callID>how_should_i_know_4711</callID> <deviceID>sip:455370@ser.intern.snom.de</deviceID> </transferredCall> </TransferCallResponse>
SingleStepTransferCall (since 8.7.4)
<SingleStepTransferCall xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <activeCall> <callID>2</callID> <deviceID>sip:455320@ser.intern.snom.de</deviceID> </activeCall> <transferredTo>455370</transferredTo> </SingleStepTransferCall>
<?xml version="1.0" encoding="utf-8"?> <SingleStepTransferCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <transferredCall> <callID>how_should_i_know_4711</callID> <deviceID>tel:455370</deviceID> </transferredCall> </SingleStepTransferCallResponse>
DeflectCall (since 8.7.4)
<DeflectCall xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <callToBeDiverted> <callID>-4</callID> <deviceID>sip:455820@ser.intern.snom.de</deviceID> </callToBeDiverted> <newDestination> <device>455370</device> </newDestination> </DeflectCall>
<?xml version="1.0" encoding="utf-8"?> <DeflectCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
GenerateDigits (only dtmf)
<GenerateDigits> <connectionToSendDigits> <callID>2</callID> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </connectionToSendDigits> <digitMode>DTMF</digitMode> <charactersToSend>1234</charactersToSend> </GenerateDigits>
<?xml version="1.0" encoding="utf-8"?> <GenerateDigitsResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
GetSwitchingFunctionDevices
<GetSwitchingFunctionDevices/>
<?xml version="1.0" encoding="utf-8"?> <GetSwitchingFunctionDevicesResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <serviceCrossRefID>GSFD4711</serviceCrossRefID> </GetSwitchingFunctionDevicesResponse>
2nd Answer (in uaCsta send via separate SIP-INFO, HTTP-CSTA appends this to initial answer):
<SwitchingFunctionDevices xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <serviceCrossRefID>GSFD4711</serviceCrossRefID> <lastSegment>true</lastSegment> <deviceList> <device> <deviceID>sip:455455@ser.intern.snom.de</deviceID> </device> <device> <deviceID>sip:455456@ser.intern.snom.de</deviceID> </device> <device> <deviceID>sip:455457@ser.intern.snom.de</deviceID> </device> </deviceList> </SwitchingFunctionDevices>
GetDoNotDisturb (since 8.7.4)
<GetDoNotDisturb xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <device>sip:455455@ser.intern.snom.de</device> </GetDoNotDisturb>
<GetDoNotDisturbResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <doNotDisturbOn>false</doNotDisturbOn> </GetDoNotDisturbResponse>
SetDoNotDisturb (since 8.7.4)
<SetDoNotDisturb xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <device>sip:455455@ser.intern.snom.de</device> <doNotDisturbOn>false</doNotDisturbOn> </SetDoNotDisturb>
<SetDoNotDisturbResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
GetForwarding (since 8.7.4)
<GetForwarding xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <device>sip:455455@ser.intern.snom.de</device> </GetForwarding>
<?xml version="1.0" encoding="utf-8"?> <GetForwardingResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <forwardingList> <forwardListItem> <forwardingType>forwardImmediate</forwardingType> <forwardStatus>true</forwardStatus> <forwardDN>tel:42</forwardDN> </forwardListItem> <forwardListItem> <forwardingType>forwardBusy</forwardingType> <forwardStatus>false</forwardStatus> <forwardDN/> </forwardListItem> <forwardListItem> <forwardingType>forwardNoAns</forwardingType> <forwardStatus>true</forwardStatus> <forwardDN>tel:66</forwardDN> <ringDuration>22</ringDuration> </forwardListItem> </forwardingList> </GetForwardingResponse>
SetForwarding (since 8.7.4)
<SetForwarding xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'> <device>sip:455455@ser.intern.snom.de</device> <forwardingType>forwardImmediate</forwardingType> <activateForward>true</activateForward> <forwardDN>42</forwardDN> <ringDuration></ringDuration> </SetForwarding>
<SetForwardingResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>
SnapshotCall (since 10.1.37.0)
To get the Call-ID before running SnapshotCall:
<SnapshotDevice> <snapshotObject>482735035@172.20.1.7</snapshotObject> </SnapshotDevice>
<?xml version="1.0" encoding="utf-8"?> <SnapshotDeviceResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <crossRefIDorSnapshotData> <snapshotData> <snapshotDeviceResponseInfo> <connectionIdentifier> <callID>50</callID> <deviceID>sip:482735035@172.20.1.7</deviceID> </connectionIdentifier> <localCallState> <compoundCallState> <localConnectionState>connected</localConnectionState> </compoundCallState> </localCallState> </snapshotDeviceResponseInfo> </snapshotData> </crossRefIDorSnapshotData> </SnapshotDeviceResponse>
Then run SnapshotCall:
<SnapshotCall> <snapshotObject> <callID>50</callID> </snapshotObject> </SnapshotCall>
<?xml version="1.0" encoding="utf-8"?> <SnapshotCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <crossRefIDorSnapshotData> <snapshotData> <snapshotCallResponseInfo> <deviceOnCall> <deviceIdentifier>sip:482735035@172.20.1.7</deviceIdentifier> </deviceOnCall> <callIdentifier> <callID>50</callID> <deviceID>sip:482735035@172.20.1.7</deviceID> </callIdentifier> <localConnectionInfo>connected</localConnectionInfo> </snapshotCallResponseInfo> <snapshotCallResponseInfo> <deviceOnCall> <deviceIdentifier>sip:482735001@172.20.1.7</deviceIdentifier> </deviceOnCall> <callIdentifier> <callID>50</callID> <deviceID>sip:482735001@172.20.1.7</deviceID> </callIdentifier> <localConnectionInfo>alerting</localConnectionInfo> </snapshotCallResponseInfo> </snapshotData> </crossRefIDorSnapshotData> </SnapshotCallResponse>
Requests
Snom phones may send the following request to a connected client:
SwFunctionDevicesChanged (since 8.7.4, set up via SystemRegister)
Request:<?xml version="1.0" encoding="utf-8"?> <SwFunctionDevicesChanged xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"> <sysStatRegisterID>43</sysStatRegisterID> </SwFunctionDevicesChanged>
Answer: should be an empty 200-OK (uaCSTA)
Events
Snom phones may send the following events to a connected client:
ServiceInitiated
Originated
Delivered
Established
Failed
ConnectionCleared
Held
Retrieved
Conferenced
Transfered
- Was written with two 'r's in firmware versions < 8.7.3.18
- New firmwares may also use double-r by setting csta_legacy_control to <= 2
- Firmware versions 8.7.4.1, 8.7.4.2, 8.7.4.3, 8.7.4.4 and 8.7.4.5 always spell with single r no matter what csta_legacy_control is set to
DigitsGenerated
Diverted (since 8.7.4)
DoNotDisturb (since 8.7.4)
Forwarding (since 8.7.4)
OutOfService (since 8.7.4)
BackInService (since 8.7.4)
Further Information
Related articles