Error and Response | Cisco Systems OL-20949-01 specs

Chapter 5 Internal URI Features

Telephony URIs

Audible feedback to the user can be enabled or disabled and an optional application ID can be specified to ensure that the DTMF digits will only be sent to the call which is associated with a specific application.

URI Format

SendDigits:dtmfSequence:audibleFeedback::applicationId

Where

dtmfSequence = the sequence of DTMF digits to be sent. Value must contain only 0123456789#*ABCD

audibleFeedback = indicates whether to provide audible feedback to the user as the DTMF digits are entered. Values can be 0 (false) or 1 (true).

applicationId = optional identifier of the application associated with the call which must receive the DTMF digits. Value must be 0-64 and cannot contain colons. The default value is null indicating that the active call should receive the DTMF digits, regardless of any application association.

For example:

•Make a call using a calling card service that implements these steps:

1.Connects to a 800 calling card service (using the Dial URI)

2.Application waits to give call time to connect

3.Dials the destination number, ensuring that the digits can only be dialed from this application.

4.Pauses 2 seconds

5.Dials the calling card number

6.Pauses 1 second

7.Dials the pin number

<CiscoIPPhoneExecute>

<ExecuteItem URL="Dial:918005551212:1:Cisco/Dialer"/>

</CiscoIPPhoneExecute>

<CiscoIPPhoneExecute>

<ExecuteItem URL="SendDigits:6185551212,,987654321,1234:1:Cisco/Dialer"/>

</CiscoIPPhoneExecute>

Error and Response

When the SendDigits URI is invoked via an Execute object, it will use the standard URI Status and Data values in ResponseItems:

	Condition	Status		Data

	Executed successfully	0	(Success)	Success

	URI syntax is invalid	1	(Parse error)	Invalid URI

	URI is not supported	6	(Internal error)	URI not found

	Unable to execute URI because there currently is no	6	(Internal error)	No Active Call
	active (streaming) call

	Unable to execute URI because the current active	6	(Internal error)	No Active Call for
	(streaming) call is not associated with the specified			Application
	application

			Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01						5-15
	OL-20949-01						5-15

Image 63

Cisco Systems OL-20949-01 manual Error and Response, Condition Status Data

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 Organization Chapter DescriptionViii Cisco Unified Communications Manager Business Edition Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified IP Phone 7900 Series Cisco Product Security Overview Document ConventionsConvention Indication 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 CiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML Considerations Mandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming 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 Device Control URIs KeyURI Format 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 Multimedia URIs RTP StreamingInteraction with Call Streaming URI Formats RTPRx RTPTx Play VibrateInteraction with Incoming Calls Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Application Management URIs InitNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post 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 Identifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors 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 Determining Problems With the Interface Procedure10-5 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