Cisco Systems OL-20949-01 - page 65

5-17
Cisco Unified IP Phone Services Application Development Notes
OL-20949-01
Chapter 5 Internal URI Features
Application Management URIs
The Notify URI is not made in the context of an XSI application session and does not contain any HTTP
cookie or session information. Thus, the back-end application cannot rely on HTTP cookies or session
information to uniquely identify the client or application. Instead, the applicat ion must em bed any
necessary information in the Notify path and data fields, or leave the data field empty and rely on any
default information provided by the specific event handler.
Note The Notify URI is not supported in the Execute object.
URI Format
Notify:protocol:host:port:path:credentials:data
Where
protocol = network protocol to use for the Notify connection; http is th e onl y sup port ed pr otoc ol.
host = network host designated to receive the notification. Value must be entered as a hostname or IP
address.
port = network port to use for the Notify connection. Value must be a number from 1-6553 5.
path = protocol-specific information. Value cannot contain colons or semicolons.
credentials = optional protocol-specific credentials used to authenticate to the server. For HTTP, this is
a base64-encoded version of userid:password. Value cannot contain colors or semicolons. If the
credentials parameter is not specified or if it is null, no Authorization header will be included in the
request. The HTTP notification service will retry the request 3 times before failing and logging an er r or
message.
data = optional application-specific event data. Value cannot contain semicolons.
For example:
• Called from RTP onStreamStopped Event Handler, no credentials, with data:
Notify:http:myserver:8080:path/streamhandler?event=stopped:
:myStreamStoppedData
HTTP POST /path/streamhandler?event=stopped HTTP/1.1
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=”UTF-8”
Host: myserver:8080
Content-Length: 23
DATA=myStreamStoppedData
• Called from RTP onStreamStopped Event Handler, no credentials, no data:
Notify:http:server:8080:path/streamhandler?event=stopped
HTTP POST /path/streamhandler?event=stopped HTTP/1.1
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=”UTF-8”
Host: myserver:8080
Content-Length: 40
DATA=<notifyStreamStopped id=”stream1”/>
• Called from SoftKey, with credentials, with data:
Notify:http:myserver:8080:path/streamhandler?event=stopped:
8fh4hf7s7dhf :myStreamStoppedData