Examples, Errors and Responses | Cisco Systems OL-20949-01 specification

Chapter 4 Component APIs

RTP Streaming API

Examples

Start Media

•Request

HTTP POST /CGI/Execute <startMedia>

<mediaStream

onStopped=”Notify:http:server:80:path/page”

receiveVolume=”50”>

<type>audio</type>

<codec>G.729</codec>

<mode>sendReceive</mode>

<address>239.1.2.3</address>

<port>20480</port>

</mediaStream>

</startMedia>

•Response

HTTP200 OK

<mediaStream id=”abc123”/>

Stop Media

•Request

HTTP POST CGI/Execute

<stopMedia>

<mediaStream id=”abc123”/>

</stopMedia>

•Response

HTTP 200 OK

If the user terminates the media stream by placing the active audio path on-hook, the following notification is sent:

HTTP POST /server/path/page

DATA=<notifyMediaEvent type=”stopped” origin=”user”>

<mediaStream id=”abc123”/>

</notifyMediaEvent>

Errors and Responses

Error conditions and responses for the RTP Streaming API include:

	Applicable
Condition	Methods	HTTP Result Code	Type	Data

Authorization failed	all	401 (Authorization Failed)	N/A	N/A

Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01	4-5

Image 47

Cisco Systems OL-20949-01 manual Examples, Errors and Responses, Start Media, Stop Media

Contents

Text Part Number OL-20949-01 Americas Headquarters Copyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T S Display Init Benefits Audience PrefaceOverview Revision History Viii OrganizationChapter Description Cisco Unified Communications Manager Business Edition Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified IP Phone 7900 Series Convention Indication Cisco Product Security OverviewDocument Conventions Page Xii 1shows a sample text menu Overview Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed Information OL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects 1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object Definitions Definition CiscoIPPhoneText Sample User Input Display CiscoIPPhoneInput InputFlag Description CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Packed Pixel Translation Example Model Resolution1CiscoIPPhoneImageFile Example Cisco Unified IP Phone 7970G Image File Display Monochrome CiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960G 7962G, 7965G Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile Text Area Size Behavior Description CiscoIPPhoneExecute CiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys SoftKeyItem NameDisplayed sofkey label/Name XML Considerations Character Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema XscomplexType Xsall Error Schema Stop Media Errors and ResponsesExamples Start Media Applicable Condition Methods Http Result Code Type Data 7905G 7911G 7921G 7940G 7971G-GE 6941 Internal URI FeaturesSupported URIs by Phone Model 7942G, 7962G 7906G 7945G, 7965G 7970G 6921 URI Format Device Control URIsKey KeyDirectories Description and Alternatives Phone Unsupported Models URI Display SoftKey XML Displayable Object URIs QueryStringParam Select Exit Update Submit Search Cancel Next Dial Internal URI Features XML Displayable Object URIs Interaction with Call Streaming Multimedia URIsRTP Streaming URI Formats RTPRx RTPTx Interaction with Incoming Calls PlayVibrate Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Notify Application Management URIsInit Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET See the Http Refresh Setting section on page 6-3section Http Header Settings Refresh Display Sample Http Refresh Setting Mime Type and Other Http Headers Content Expiration Header Setting Set-Cookie Header Setting Accept-Language Http Encoding Header Setting CiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDK OL-20949-01 \CiscoIpServices\Tools Sample Services Requirements OL-20949-01 Accessing Phone Service Administration IP Phone Service Administration Subscription Field Description Adding a Phone Service Field Description Service Parameter Information Defining IP Phone Service Parameters User Service Subscription 10-1 DeviceListX Report Performance and Scalability BenefitsRestrictions Integration Considerations and Interoperability Prerequisites Related Features and TechnologiesSecurity Supported Platforms 10-4 Troubleshooting DeviceListX ReportsError Codes Field Name Description 10-5 Determining Problems With the InterfaceProcedure 10-6 Object Definition CiscoIPPhone XML Object Quick Reference Appendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Updated XML Parser and Schema Enforcement Cisco Unified IP Phone Services XML Schema File CiscoIPPhone.xsd Xsdelement name=Name minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType XsdsimpleType xsdrestriction base=xsdstring XsdcomplexType name=CiscoIPPhoneSoftKeyType xsdsequence Xsdelement name=Title minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType Xsdattribute XsdcomplexType Xsdelement name=CiscoIPPhoneDirectory xsdcomplexType Xsdelement name=CiscoIPPhoneImageFile xsdcomplexType Xsdelement name=CiscoIPPhoneIconMenu xsdcomplexType Xsdelement name=CiscoIPPhoneGraphicFileMenu xsdcomplexType Xsdsequence Xsdelement name=Text minOccurs=0 xsdsimpleType Xsdsequence XsdcomplexType Xsdelement IN-1 Numerics IN-2 Html URL IN-3 IN-4 XML URL