Child pages
  • CSTA over HTTP - Requests

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Snom phones support the following requests send to the phone via HTTP: 

Table of Contents
minLevel4


...

RequestSystemStatus

Request:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<RequestSystemStatus xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

...


Answer:

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?

...

><RequestSystemStatusResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"

...

><systemStatus>normal</systemStatus></RequestSystemStatusResponse>

...

SnapshotDevice

Request:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?

...

><SnapshotDevice xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"

...

><snapshotObject>455455@ser.intern.snom.de</

...

snapshotObject></SnapshotDevice>

...


Answer:

Code Block

...

languagexml
collapsetrue
<?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

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><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>

...


Answer:

Code Block
languagexml
collapsetrue
<?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

Request:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?

...

><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>

...


Answer:

Code Block
languagexml
<?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

Request:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<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>

...


Answer:

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<AnswerCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>


...

ClearConnection

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<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>

...


Answer:

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?

...

><ClearConnectionResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>


...

ClearCall

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:csta="http://www.ecma-international.org/standards/ecma-323/csta/ed4">

...


<SOAP-ENV:Body>

...


<csta:ClearCall>

...


<csta:callToBeCleared>4711</csta:callToBeCleared>

...

</csta:ClearCall>

...


</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


...

HoldCall

Request:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?

...

><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>

...


Answer:

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<HoldCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>


...

RetrieveCall

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<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>

...


Answer:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="utf-8"?

...

><RetrieveCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>

...

Conference Call

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><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>

...


Answer:

Code Block
languagexml
collapsetrue
<?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

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><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>


Answer:

Code Block
languagexml
collapsetrue
<?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

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><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>

Answer:

Code Block
languagexml
collapsetrue
<?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

Request:

...

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><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>

Answer:

...

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="utf-8"?

...

><DeflectCallResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>

...

GenerateDigits

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><GenerateDigits><connectionToSendDigits><callID>2</callID><deviceID>sip:455455@ser.intern.snom.de<

...

/deviceID></connectionToSendDigits><digitMode>DTMF</digitMode><charactersToSend>1234</charactersToSend></GenerateDigits>


Answer:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="utf-8"?>
<GenerateDigitsResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>


...

GetSwitchingFunctionDevices

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?

...

><GetSwitchingFunctionDevices/>

Answer:
Code Block
languagexml
collapsetrue
<?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):

...

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<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

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<GetDoNotDisturb xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5

...

"> 

...

<xmlns:xsi='

...

sip:455455@ser.intern.snom.dehttp://www.w3.org/2001/XMLSchema-instance'>

...


<device>sip:455455@ser.intern.snom.de</

...

device></GetDoNotDisturb>

...


Answer:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<GetDoNotDisturbResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5">

...


<doNotDisturbOn>false</doNotDisturbOn>
</GetDoNotDisturbResponse>


...

SetDoNotDisturb

Request:

Code Block

...

languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<SetDoNotDisturb xmlns='http://www.ecma-international.org/standards/ecma-323/csta/ed5' xmlns:xsi='

...

sip:455455@ser.intern.snom.dehttp://www.w3.org/2001/XMLSchema-instance'>

...


<device>sip:455455@ser.intern.snom.de</device>

...


<doNotDisturbOn>false</doNotDisturbOn>
</

...

SetDoNotDisturbfalse>


Answer:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<SetDoNotDisturbResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>


...

GetForwarding

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<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>

...


Answer:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="

...

UTF-8"?

...

><SingleStepTransferCall xmlns=

...

'http://www.ecma-international.org/standards/ecma-323/csta/ed5

...

SetForwarding

Request:

' 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>


...

SetForwarding

Request:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<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>

...


Answer:

Code Block
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<SetForwardingResponse xmlns="http://www.ecma-international.org/standards/ecma-323/csta/ed5"/>


Info

Note: CSTA via HTTP used to require the csta-xml to be enveloped in SOAP, since 8.7.3 this is no longer necessary except for the proprietary requests described in 4 Proprietary CSTA Messages and Action URLs and for ClearCall. For all other services this is now optional.