CGI Execute

The phone can be commanded to execute an internal URI handler or fetch an external URL by sending a POST request to the phone's web-server using the URL http://x.x.x.x/CGI/Execute with a parameter named XML. An archive containing sample command line utilties can be downloaded from the URL below.

file_download commands-2.8.tar.gz (17K) event 01/11/2025 security SHA256:8afd0369aaacc9338180b2efbd607d7b103e9cb331ca8314b540748c30721f77.

If an <authenticationURL> has been defined, requests need to include a Authorization header encoded using the basic method. The username and password will be passed on to the authentication URL for checking. See Phone Services for more information.

See the open_in_browser Cisco Unified IP Phone Services Application Development Notes a list of URIs the each phone model supports.

<CiscoIPPhoneExecute>

ExecuteItem link

Specifies a URL to fetch or a URI to execute. Up to 3 <ExecuteItem> elements can be specified.

URL URL to fetch or execute. Must be ether one of the internal URIs (Dial, Key, SoftKey, Init, Play etc.), an http:// URL or an https:// URL.

Priority Priority of the request (optional)

Execute immediately (default)

Execute when idle

Execute only if idle

  <ExecuteItem URL="URL" Priority="PRIORITY" />
</CiscoIPPhoneExecute>

setBackground link

Sets the background on the phone. An example setbackground script can be found in the archive above. See Background Images for more information.

<setBackground>
  <background>

icon link

URL for the preview image, this will be displayed when viewing the list of background images.

<icon>ICON URL</icon>

image link

URL for the full-size image.

    <image>IMAGE URL</image>
  </background>
</setBackground>

setRingTone link

Sets the ring-tone on the phone. An example setringtone script can be found in the archive above. See Ring Tones for more information.

<setRingTone>

ringTone link

URL for the ring tone.

  <ringTone>RINGTONE URL</ringTone>
</setRingTone>

startMedia link

Start streaming media to or from the phone. The command will return a <mediaStream> element with an id attribute that may be used to stop a specific stream. An example mediastream script can be found in the archive above. See RTP Streaming for more information.

receiveVolume

Optional volume percentage to play received media 1 to 100.

<startMedia receiveVolume="VOLUME">
  <type>audio</type>

codec link

Codec to use for media.

G.711

G.722

G.729

<codec>CODEC</codec>

mode link

Whether the phone will send, receive or send and receive media.

send

receive

sendReceive

<mode>MODE</mode>

address link

IP address the phone will receive media from. A multicast IP address may be specified.

<address>ADDRESS</address>

port link

Optional port to receive media on from 20480 to 32768 and must be an even number. Default is 20480.

  <port>PORT</port>
</startMedia>

stopMedia link

Stop a media stream started using <startMedia>.

<stopMedia>

mediaStream link

Specifies which media stream to stop.

id	Optional `id` may be specified to stop a specifc stream, otherwise all media streams will be stopped.

  <mediaStream id="ID" />
</stopMedia>

<proxy>

USECALLMANAGER.nz

</proxy>