PPM-in-SES

Interface Specification Document for Personal Profile Manager

03-601678 Issue 1 August 2006

© 2006 Avaya Inc. All Rights Reserved. Notice

While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases. For full support information, please see the complete document, A v a y a S u p p o r t N o t i c e s f o r S o f t w a r e D o c u m e n t a t io io n , document number 03-600758. To locate this document on our Web site, simply go to http://www.avaya.com/support and search for the document number in the search box. Documentation disclaimer

Avaya Inc. is not responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. Customer and/or End User agree to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation to the extent made by the Customer or End User. Link disclaimer

Avaya Inc. is not responsible for the contents or reliability of any linked Web sites referenced elsewhere within this documentation, and Avaya does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all of the time and we have no control over the availability of the linked pages. Warranty

Avaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the li mited warranty. In addition, Avaya’s standard warranty language, as well as information regarding support for this product, while under warranty, is available through the following Web site: http://www.avaya.com/support.. http://www.avaya.com/support Copyright

Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law. Avaya support

Avaya provides a telephone number for you to use to report problems or to ask ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. States. For additional support telephone numbers, see the Avaya Web site: http://www.avaya.com/support http://www.avaya.com/support..

© 2006 Avaya Inc. All Rights Reserved. Notice

While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases. For full support information, please see the complete document, A v a y a S u p p o r t N o t i c e s f o r S o f t w a r e D o c u m e n t a t io io n , document number 03-600758. To locate this document on our Web site, simply go to http://www.avaya.com/support and search for the document number in the search box. Documentation disclaimer

Avaya Inc. is not responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. Customer and/or End User agree to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation to the extent made by the Customer or End User. Link disclaimer

Avaya Inc. is not responsible for the contents or reliability of any linked Web sites referenced elsewhere within this documentation, and Avaya does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all of the time and we have no control over the availability of the linked pages. Warranty

Avaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the li mited warranty. In addition, Avaya’s standard warranty language, as well as information regarding support for this product, while under warranty, is available through the following Web site: http://www.avaya.com/support.. http://www.avaya.com/support Copyright

Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law. Avaya support

Avaya provides a telephone number for you to use to report problems or to ask ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. States. For additional support telephone numbers, see the Avaya Web site: http://www.avaya.com/support http://www.avaya.com/support..

Contents

Interface Specification for PPM. . . . . . . . . . . . . . . . . . . . . . .

5

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5

PPM Server (SOAP interface) . . . . . . . . . . . . . . . . Operations supported . . . . . . . . . . . . . . . . . . Data local to terminals. . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . System wide parameters . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Information stored by proxy on the SES server . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Data maintained in Communication Manager (CM) Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Endpoint Configuration JUMBO . . . . . . . . . . VMON Information . . . . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Home server . . . . . . . . . . . . . . . . . . . . . . . Error Conditions/F Conditions/Faults aults . . . . . . . . . . . . . . . Retry Fault . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

5 6 6 11 12 14 16 19 22 24 25 26 27 27 29 30 31 33 34 36 44 46 47 49 50 50 53 53

End Point to Personal Profile Manager Data Flows . On-demand information . . . . . . . . . . . . . . Profile Event Package . . . . . . . . . . . . . . . Reboot Required . . . . . . . . . . . . . . . . Report Status. . . . . . . . . . . . . . . . . . Reload Profile . . . . . . . . . . . . . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

54 54 55 56 57 57

References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

Detailed FNU Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Feature Name URI examples . . . . . . . . . . . . . . . . . . . . . . . . . . .

59 59

WSDL Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

. . . . . .

. . . . . .

. . . . . .

Issue 1 August 2006

3

Contents

Appendix A: PPM SOAP Interface for DevConnect . . . . . . . . . . . .

109

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Proposed Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

109 109

PPM SOAP Service Specification. getContactList . . . . . . . . . addContact . . . . . . . . . . . updateContact . . . . . . . . . Example: . . . . . . . . . . deleteContact . . . . . . . . . changePassword . . . . . . . getRegistrations . . . . . . . . Error Conditions/Faults . . getHomeCapabilities . . . . . Error Conditions/Faults . . sendCommand. . . . . . . . .

111 112 116 119 119 120 121 122 123 123 127 127

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

4 Interface Specification Document for Personal Profile Manager

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

Interface Specification for PPM

Introduction This document provides details of the interface between the Avaya Personal Profile Manager (PPM) Server and a client or end point, such as a SIP Phone. This document also describes the functionalities provided by the web interface, using SOAP, to the SIP Personal Information Manager (SIP PIM) appication that can be used by members of the Avaya DevConnect program. PPM is used as a repository for user-specific information that is pulled at the client’s request, for example on an event such as user login. PPM is already a part of the SIP Enablement Services (SES) infrastructure. This document describes only additions in SES R3.x feature development to the existing interface. The additions for DevConnect members to the PPM Server interface as well as to the SIP PIM web interface are defined in detail in later sections of this document.

PPM Server (SOAP interface) PPM Server exposes a SOAP Remote Procedure Call (RPC) interface. (SOAP defines how an XML body of a specific format is carried in an HTTP request or response.) This interface is defined in a WSDL document and described in the following sections. A snapshot of the WSDL document can be found in the section titled WSDL Document on page 74. The PPM server is implemented on the Apache Axis framework, which in turn runs as a service on top of Apache Tomcat software. A tool is used to build the PPM server from the actual WSDL document.

! Important: Important:

Although reasonable attempts are made to align this document (including the attached WSDL document) with the actual WSDL document, the act ual WSDL document should always be used as the definitive interface specification.

Several toolkits exist that may be used to help build the client interface, such as Axis or .NET, but these toolkits are not required. The PPM client obtains the data from PPM Server by executing the desired operations defined in the WSDL document. Note that each request to the PPM server will be authenticated using digest authentication (see RFC 2617). This means that each request may actually consist of two round-trip requests (the original request, the response with a challenge, the subsequent request containing the challenge response, and the final response). A nonce aging parameter

Issue 1 August 2006

5


may be set in the PPM Server so that each request after the first request would not necessarily be challenged. If a subsequent request (e.g., for operation 2 in the following figure) is received at the PPM Server before the nonce age has expired and the credentials are otherwise correct, the request will not be challenged. The following figure shows just one example of the communication, in this case, between a Toshiba SIP Phone and the PPM Server in SES: Toshiba terminal

PPM Server

POST (Operation 1) 401 Unauthorized (WWW-Authenticate) POST (Operation 1 with Authorization) 200 OK (with response) POST (Operation 2 with Authorization) 200 OK (with response)

Operations supported The following sections describe the requests supported in the PPM Server, as well as the responses to those requests. In general, “get” requests are used to pull data from the PPM repository, while “set” requests are used to store data in the PPM repository.

Data local to terminals Terminal information

This terminal information may be used by any end point of the PPM. The terminal calls this method to store this information so that the SES administrator may view this information at a later time. This information must be propagated back to the SES master administration system. The ContactUri parameter is used to identify which of the user ’s contacts is storing its information. SES allows users to have multiple devices, i.e. SIP contacts, so this method must qualify which device is storing the information.


PPM Server (SOAP interface)

setTerminalInformation(Handle, TerminalInformation) Request Parameter

Type

Value

Description

Handle

String

SIP URI

The user’s primary handle

TerminalInformation

TerminalInfo

Container for Terminal information

TerminalInfo

Type

Value

Description

Vendor

String

Maximum of 32 UTF-8 characters

Name of terminal vendor

PhoneType

String


Type of terminal (e.g., model)

ProgramVersion

String


Firmware/Software Version present in the terminal

MacAddress

String

17 characters

Hardware (MAC) address of the terminal

Issue 1 August 2006

7


Example Terminal Request: POST /axis/services/ppm HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.1 Host: 127.0.0.1 Cache-Control: no-cache Pragma: no-cache SOAPAction: "setTerminalInformation" Content-Length: 1740 [email protected] [email protected] SUSHI SIP 3.0 00:D1:B6:C6:E1:7B



Example PPM Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Date: Fri, 16 Jan 2004 12:40:16 GMT Server: Apache Coyote/1.0 Connection: close PPM_Success

Error Conditions/Faults

The following faults are sent to indicate error conditions. Fault

Description

“Invalid Data Type”

A request parameter is not of a proper data type.

“Database Error”

PPM cannot access the Database for reading or writing.

Volume Settings

This operation allows a phone to get and set its Ringer Volume, Speaker Volume, and Receiver Volume settings. getVolumeSettings(Handle) Request Parameter

Type

Value

Description

Handle

String

1-256 characters


Response Parameter

Type

Description

VolumeSettings

VolumeSet

See VolumeSet below

Issue 1 August 2006

9


VolumeSet

Type

Value

Description

RingerVolume

Short

{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}

Relative volume on a scale of 1 – 10

ReceiverVolume

Short

{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}

Relative volume on a scale of 1 - 10

SpeakerVolume

Short

{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}

Relative volume on a scale of 1 - 10

RingerCadence

Short

{1, 2, 3}

One of a few choices for ringer cadences

Example Terminal Request: [email protected]

Example PPM Response: 5 3 5 2



Error Conditions/Faults The following fault is sent to indicate an error condition. Fault

Description

“DatabaseError”


setVolumeSettings(Handle, VolumeSet) Request Parameter

Type

Description

Handle

String

User’s primary handle

VolumeSettings

VolumeSet

See VolumeSet above

Example Terminal Request: [email protected] 6 3 5 3

Issue 1 August 2006

11


Example PPM Response: PPM_Success

Error Conditions/Faults The following faults are sent to indicate error conditions. Fault

Description

“Invalid Value”

If value to be set is not of enum type VolumeSet then this fault will be send to endpoints



Ringer Settings

A phone can get and set Ringer Cadence and Ringer On/Off settings with this operation. getRingerSettings(Handle) Request Parameter

Type

Value

Description

Handle

String

SIP URI


Response Parameter

Type

ListOfRingerOnOffData

RingerOnOffListInfo

Value


Description

See RingerOnOffData below


RingerOnOffListInfo

Type

Value

Description

NoOfElements

Integer

Number of elements in the array

RingerOnOffList

Array of RingerOnOffData


RingerOnOff Data

Type

Value

Description

OnOffSet

Enum

{On, Off}

“on” indicates the ringer will alert when a new call arrives; “off” indicates the ringer will not alert when a new call arrives

ButtonNumber

Short

Between 1-20

the location of the button for this ringer on/ off setting

Address

String

SIP URI

The Address of the Button

Example Terminal Request: [email protected]

Issue 1 August 2006

13


Example PPM Response: 1 On 1 [email protected]


Description

“DatabaseError”


setRingerSettings (Handle, ListOfRingerOnOffData) Request Parameter

Type

Value

Description

Handle

String

SIP URI



RingerOnOffListInfo

Value

Container for the array

RingerOnOffLis tInfo

Type

Description

NoOfElements

Integer


RingerOnOffList

Array of RingerOnOffData




RingerOnOff Data

Type

Value

Description

OnOffset

Enum

{on, off}

“on” indicates the ringer will alert when a new call arrives; “off” indicates the ringer will not alert when a new call arrives

ButtonNumber

Short

Between 1-20

the location of the button for this ringer on/off setting

Example Terminal Request: [email protected] 1 Off 1


Issue 1 August 2006

15



Description

“Invalid Value”

If value to be set is not of enum type OnOffSet then this fault will be send to endpoints

“Invalid Button Value”

If Button number value is not in the range 1-20, this fault occurs



“Invalid Button Type”

The operation is not allowed on this button type.

Speed Dial List

A Speed Dial List (SDL) is accessible for each SIP phone. A phone can retrieve its Speed Dial List by invoking the getSpeedDialList request on the PPM server. PPM always provides a mechanism for a terminal or end point to retrieve its speed dial list. A speed dial entry has the following attributes: ●

Entry Number

●

Name (Kanji name for SUSHI)

●

●

Alias (Kana name for SUSHI) Prefix

●

Address

●

Handle

Release: 3.0 Source: SUSHI Status: Baselined

The speed dial list is a subset of a user’s contact list. Each contact in the contact list may be enabled as a speed dial entry. The user only has one speed dial list, and if the user has multiple terminals that support the getSpeedDialList method; all terminals receive the same copy of the speed dial list. This is consistent with a user having a single contact list. When a contact is enabled as a speed dial entry, the user has the opportunity of adding a prefix in the prefix field an telephone number in the address field (as opposed to a SIP URI). It is acceptable for the prefix field to remain blank, in which case this method will return an empty tag for Prefix-TelNum.



getSpeedDialList(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

Description

ListOfSpeedDialListData

SpeedDialListInfo

See Below

SpeedDialList Info

Type

Value

Description

NoOfElements

Integer

SOAP Standard

The number of speed dial entries

SpeedDialList

Array

ArrayOfSpeedDialEntry

The Array of entries

For each entry in the Speed Dial List, the data shown in the following table is provided in the response: SpeedDialEntry

Type

Value

Description

Number

Short

1-100

This value specifies the entry in the Speed Dial List. The Speed Dial list may contain a maximum of 100 entries, so this number can be in between 1-100.

Name

String


For SUSHI, this is a 10 Kanji Character value which represents the name assigned to the button. For example, Button 1 has assigned Name ‘Steve’, Button 2 has assigned Name ‘Sakai-San’, etc. The “SUSHI” SIP PIM page will limit the number of characters entered.

Alias

String


For “SUSHI,” this is 16 Kana characters to help sorting.

PrefixTelNum

String

Maximum of 4 digits

A prefix, such as an AAR or ARS access code, required in addition to the target’s telephone number

Address

String

Maximum of A telephone number (or a general SIP URI) 256 characters assigned to the button for speed dial

Handle

String

Maximum of 256 characters

The contact’s user handle

Issue 1 August 2006

17


Example Terminal Request: ajbaker



Example PPM Response: 3 1 Glen G$# 9 [email protected] [email protected] 2 Jud J#$ 9011 [email protected] [email protected] 3 Steve S$# 8 [email protected] [email protected]


Description

“DatabaseError” PPM cannot access the Database for reading or writing.

Issue 1 August 2006

19


One Touch Dial List

The One Touch Dial List is a set of buttons and associated addresses that will be called when the button is pressed. A phone can retrieve the One Touch Dial List by invoking the getOnetouchDialList request on the PPM server. The one touch dial list can be managed from the SIP PIM or from the end point using the getOneTouchDialList and setOneTouchDialList methods. Note that the button location is determined from the administration of an autodial button in the station form on Communication Manager. If an address has been provisioned for the button on Communication Manager, PPM will indicate that this button is read only [i.e. ReadOnly = true]. Read only buttons may only have their labels customized by the end user, and attempts to change the address will result in a fault. Otherwise, buttons may have their address and label customized by the end user (via setOneTouchDialList). getOneTouchDialList(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

Description

ListOfOneTouchDialData

OneTouchDialListInfo

See Below


Type

Description

NoOfElements

Integer


OneTouchDialList

Array of OneTouchButton

See OneTouchButton below

OneTouchButton

Type

Value

Description

ButtonLocation

Short

1-66

the location of button

Address

String


number (or general SIP URI) assigned to the button for One Touch Dial



OneTouchButton

Type

Value

Description

Label

String (Optional)


This is a label that can be displayed for the button. If no label has been set (via setOneTouchDialList), PPM will return a label formed from the Address.

ReadOnly

Boolean

True/False

This indicates if the one touch button is read-only or not. Read-only buttons are maintained in Communication Manager and the user may not change the address of the button.

Example Terminal Request: user@domain

Issue 1 August 2006

21


Example PPM Response: 3 1 [email protected] [email protected] 2 [email protected] [email protected] 3 [email protected] [email protected]


Description

“DatabaseError”




setOneTouchDialList(Handle, ListOfOneTouchDialData) Request Parameter

Type

Description

Handle

String




Container for One touch dial list array information


Type

Description

NoOfElements

Integer


OneTouchDialList

Array of OneTouchButton

See OneTouchButton below

OneTouchButton

Type

Value

Description

ButtonLocation

Short

1-66

the location of button

Address

String


number (or general SIP URI) assigned to the button for One Touch Dial

Label

String (Optional)


This is a label that can be displayed for the button. If no label has been set (via setOneTouchDialList), PPM will return a label formed from the Address.

Issue 1 August 2006

23


Example Terminal Request: user@domain 1 11 5551212



Description

“DatabaseError”




System wide parameters Line Reservation Timer

A phone may obtain its Line Reservation Timer setting by invoking getLineReservationTimer. The Line Reservation Timer is used to reserve a line appearance for the designated time. This timer is set by the system administrator. getLineReservationTimer() Response Parameter

Type

Value

Description

ResvTimer

Short

30-240 seconds

Line Reservation timer value

Example Phone Request:

Example PPM Response: 10

Issue 1 August 2006

25



Description

“DatabaseError”


Expired Timer Value

The getExpiredTimerVal operation allows a phone or other SIP end point to obtain the expired timer value that is set by an administrator. getExpiredTimerVal () Response Parameter

Type

Value

Description

ExpIntVal

Integer

10 – 864000 seconds (maximum of 10 days)

This is the value to be placed in the Expires header of the SIP REGISTER message.

Example End Point Request:





Description

“DatabaseError”


Information stored by proxy on the SES server Session History (Future)

DEFERRED FEATURE: Session history (for example, a call log) can be retrieved from the SES server via PPMS. The getCallLog request returns the session history for the last 20 incoming and last 20 outgoing calls. The response message will provide session history entries sorted according to incoming/outgoing, then date and time, with the most recent call first in the list. getCallLog(Handle) Request Parameter

Type

Description

Handle

String


Response Parameter

Type

ListOfCallLogData CallLoglListInfo

Description

See Below

Issue 1 August 2006

27


CallLogListInfo

Type

Description

NoOfElements

Integer


CallLog

Array of LogEntry

See LogEntry below

LogEntry

Type

Value

Description

Direction

Enum

{incoming, outgoing}

Indicates whether the call was originated by the user (outgoing) or received by the user (incoming)

Status

Enum

{answered, unanswered}

Indicates whether the call was answered or not

CallDate

Date

YYYY-MM-DD

Date that the session was initiated (i.e., when the INVITE was sent)

CallTime

Time

HH:MM:SS

UTC timestamp indicating the time that the session was initiated (i.e., when the INVITE was sent)

Address

String

Max of 256 characters

Address of the other party (i.e., the calling party if Direction is incoming, the called party if Direction is outgoing). May be a digit string or a SIP URI.

CallDuration

Time

HH:MM:SS

Duration of the session once Baselined (e.g., talk time).

Note: Note:

This document does not specify how data is stored in the call log, or how the call log reflects feature interactions. Call log behavior will be described in CID 103450.




Example PPM Response: 3 outgoing answered 01-15-2004 09:28 [email protected] 3:18 outgoing unanswered 01-15-2004 09:00/ppm:CallTime> [email protected] 0 incoming answered 01-15-2004 09:50 [email protected] 2:11


Description

“NoEntryFound”

No session history was found for this user.

Issue 1 August 2006

29


Data maintained in Communication Manager (CM) A variety of configuration data is maintained in the Avaya Communication Manager. PPM acts as a front end to access this data. Idle Line Selection

A phone or other SIP end point can obtain its idle line selection settings from PPM by invoking getIdleLineSelection. getIdleLineSelection(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

Value

LinePreferenceInfo

LinePrefInfo

Description

Container of line preference information

LinePrefInfo

Type

Value

Description

CallAppPreference

Enum (LinePref)

{y, n}

the Idle Appearance Preference defined for this station in CM

BridgeAppPreference

Enum (LinePref)

{y, n}

the Bridged Appearance Preference defined for this station in CM (As of this writing, adding a bridged appearance preference is a planned development it em in CM 3.0. The name of this field for CM administration is not yet known. The possibility exists that this feature is postponed from 3.0.)




Example PPM Response: y n


Description

“DataNotAvailable”

PPM is unable to obtain the data from CM. A likely cause is that PPM was not able to obtain a response from CM before link timeout.

“ConfigurationMismatch”

The station has not been administered on CM. This can happen if the user has been added in SES but not in CM, or if the extension administered on SES disagrees with the extension administered on CM, or if the extension has been removed from CM but the user is still provisioned in SES.

Issue 1 August 2006

31


Message Waiting Extension

A SIP phone may obtain the Message Waiting Extension setting from PPM by invoking getMessageWaitingExt. getMessageWaitingExt(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

Value

Description

MWExt

String

Maximum of 7 digits

the message waiting extension assigned to the station on CM (Note that the Message Waiting Extension assigned on CM is generally used to light a message waiting lamp on the telephone.)






Description




The station has not been administered on CM.

Auto Answer Type

A SIP phone may obtain its Auto Answer Type setting from the PPM by invoking getAutoAnswerType. getAutoAnswerType(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

AutoAnswer

AutoAnsType

Value

Description

See Below

AutoAnsType

Type

Value

Description

AutoAnsType

Enum

{none, icom, acd, all}

the Auto Answer setting for this station on CM. “SUSHI” will only support none and icom; any other value will be treated like “none”.

Issue 1 August 2006

33



Example PPM Response: none


Description





Dial Plan

A phone may obtain a simplified Dial Plan with this operation. The phone could use a dial plan to determine the end of dialing (i.e., when to send the INVITE) and application of a second dial tone (e.g., such as when using ARS, like dialing 9 to get an outside line). The Dial Plan will be represented as a list of terms, where each term is a nearly generic regular expression form.



The rules for each term are: x = any digit Z = play dialtone + = 1 or more instances of the preceding character, implied inter-digit timer Some sample terms for a dialplan: 538xxxx = a 7-digit number starting with 538 9Z1xxxxxxxxxx = ARS access to a long distance number in North America (dialtone after the 9) 9Z011xxxx+ = ARS access to an international number of unknown length, but at least 7 digits (including 011) getDialPlan(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

DialPlanData

DialPlanListInfo

Value

Description

Container for all dial plan information

DialPlanListInfo

Type

Value

Description

DialPlanDomain

String

36 characters

The domain of the dial plan. Currently this is same as the enterprise SIP domain.

NoOfElements

Integer

DialPlan

Array of Strings

Number of elements in the array Expression representing rules described above

Each string i n the array represents a single term of the CM dial plan

Issue 1 August 2006

35


Example SUSHI Request: user@domain

Example PPM Response: Avaya.com 3 1xxxx 2xxxx 3xxxx


Description







Button Assignment

A SIP phone or device may obtain its button assignments by invoking getButtonAssignments. getButtonAssignments(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

ListOfButtonAssignments

ButtonListInfo

Value

Description

Container for Button Assignments information

ButtonListInfo

Type

Description

NoOfElements

Integer

Number of elements in array

ButtonAssignment

Array of ButtonData

See ButtonData below

ButtonData

Type

Value

Description

Location

Short

1 – 66

This value specifies the number (location) of button. SUSHI phones will be a CM set type that provides 20 buttons. Other CM set types could support as many as 66 buttons.

ButtonType

Enum

{call-appr, brdg-appr, aut-msg-wt, FNU, autodial}

This specifies which type of Button

Label

String


A string that can be displayed for the button. If no label has been defined, PPM will provide a default label from known data (for example, from the extension for a bridged appearance).

LineID

Short

SOAP Standard

This gives the LineID value, or no value if a line ID is not relevant for the button type. For a bridged appearance button, this is the Button subfield found on CM.

Issue 1 August 2006

37


ButtonData

Type

Value

Description

Address

String

Max 256 characters

If the button type is brdg-appr, the bridge extension goes here. If the button type is autodial, the destination digits/URI goes here. If auto-msg-wt, the destination extension goes here. For FNU, see FNUInfo below. For some FNUs (e.g. call-fwd), the source extension, if different than the user’s, is specified here.

FNUType

String

A pre-defined string unique to each supported feature

See “FNU Description” below

App

Boolean

If “true”, the endpoint must request a line appearance (+line) on the Contact header in an INVITE with this FNU.

Media

Boolean

If “true”, the endpoint must include an SDP offer in an INVITE with this FNU.

FNUInfo

Array of FNUData

Varies by FNU

See “FNU Description” below

FNUData

Type

Description

Parameter

String

A parameter to the FNU (as presented in FNUType). If the parameter requires completion by the client, it is the parameter string ending with “=” (e.g., “avaya-cm-action=”). If the parameter is complete (e.g., “avaya-cm-group=3”), the client would use the parameter as is.

Required

Boolean

If “true”, the client must include this parameter. If “false”, the client may include the parameter if it is able to complete the parameter or provide the feature processing.

MustComplete

Enum

If “none”, the parameter is already complete. If “offon”, the endpoint must complete the parameter with either “off” or “on”. If “address”, the endpoint must complete the parameter with an address (e.g., telephone number or extension). If “number”, the endpoint must complete the parameter with a number. If “dialcode”, the endpoint must complete the parameter with a dial code.



FNU Description

The following table shows the list of features accessible via FNU in Communication Manager. Many of the FNUs require additional parameters. A “yes” value i n the column labeled “MustComplete” indicates that the endpoint must complete the indicated parameter. A “no” value in the column labeled “MustComplete” indicates that the FNU parameter provided by PPM in FNUInfo is fully qualified and requires no further addition from the endpoint. Feature Name

FNUType

App

Media

FNUInfo Parameter

Required

MustComplete

Automatic call back

avaya-cm-fnu=auto-callback

false

false

avaya-cm-action={on|off}

true

offon

Automatic intercom

avaya-cm-fnu=auto-intercom

true

true

avaya-cm-group={group}

true

none

avaya-cm-dial-code={code}

true

none

Busy Indicator

avaya-cm-fnu=busy-indicator

true

true

avaya-cm-destionation={address}

true

address

Call forwarding all avaya-cm-fnu=call-forwarding See note 1 -all See note 4

true

true

avaya-cm-destination={address}

false

address

true

offon

Call forwarding busy/no answer See note 1 See note 4

avaya-cm-fnu=call-forwarding -busy-no-answer

true

false

address

true

offon

Call park See note 3

avaya-cm-fnu=call-park

false

false

Call unpark (answer back) See note 2 See note 3

avaya-cm-fnu=call-unpark

true

true

avaya-cm-extension={address}

false

address

Call pick-up Group

avaya-cm-fnu=call-pickup

true

true

Call pickup Directed

avaya-cm-fnu=call-pickup-dire true cted

true


false

address

Call pickup Extended group See note 2

avaya-cm-fnu=call-pickupextended

true

true

avaya-cm-pickup-number={num}

false

number

Per call calling party number block See note 3

avaya-cm-fnu=calling-partyblock

true

true


false

address

Per call calling party number unblock See note 3

avaya-cm-fnu=calling-partyunblock

true

true


false

address

Dial Intercom

avaya-cm-fnu=dial-intercom

true

true

avaya-cm-group={group}

true

none

avaya-cm-dial-code={code}

false

dialcode

avaya-cm-action={on|off} true

avaya-cm-destination={address} avaya-cm-action={on|off}

1 of 2

Issue 1 August 2006

39


Feature Name

FNUType

App

Media

FNUInfo Parameter

Required

MustComplete

Exclusion See note 3

avaya-cm-fnu=exclusion

false

false


true

offon

Off-PBX call See note 3

avaya-cm-fnu=off-pbx

false

false


true

offon

Off hook See note 2

avaya-cm-fnu=off-hook

true

false

Last number dialed See note 3

avaya-cm-fnu=last-numberdialed

true

true

Malicious Call Trace See note 3

avaya-cm-fnu=mct

false

false

Malicious Call Trace Cancel See note 2 See note 3

avaya-cm-fnu=mct-cancel

false

false

One Touch Recording See note 1 See note 3

avaya-cm-fnu=one-touchrecording

false

false


true

offon


true

address

Priority call See note 3

avaya-cm-fnu=priority-call

true

true


false

address

Send all calls

avaya-cm-fnu=sac

false

false


true

offon

Transfer to voice mail See note 2

avaya-cm-fnu=transfer-tovoicemail

false

false

Whisper page

avaya-cm-fnu=whisper-page

true

true


false

address 2 of 2

Note 1: When deactivating feature (avaya-cm- action=off), other parameters are not included. Note 2: No button is defined on CM for this feature, so DevConnect members will never see this from PPM. The FNU is supported by Avaya, and therefore it is listed here for completeness. Note 3: Unused, but supported by Avaya so included here for completeness. Note 4: Session Description Protocol (SDP) and the +line parameter in the Contact header must be included if the optional FNU parameter is not present in the INVITE. Conversely, if the optional FNU parameter is included in the INVITE, then the INVITE should not include SDP or the +line parameter.



Examples:

Automatic callback – For an automatic callback button in location 9, PPM returns the following structure: Location

9

ButtonType

FNU

LineID

Null

Address

Null

FNUType

avaya-cm-fnu=auto-callback

FNUInfo

{avaya-cm-action=, true, offon}

When the user presses the automatic callback button to activate the automatic callback feature, the endpoint would send an INVITE with the request URI of: sip:handle@domain;avaya-cm-fnu=auto-callback;avaya-cm-action=on

It is the endpoint’s responsibility to complete the parameter “avaya-cm-action=on” because the MustComplete value for the avaya-cm-action parameter is “offon”. Automatic Intercom – For an automatic intercom button in location 8, PPM returns the following structure: Location

8

ButtonType

FNU

LineID

Null

Address

Null

FNUType

avaya-cm-fnu=auto-intercom

FNUInfo

{avaya-cm-group=3, true, none} {avaya-cm-dial-group=2, true, none}

When the user presses the automatic callback button to activate the automatic callback feature, the endpoint would send an INVITE with the request URI of: sip:handle@domain;avaya-cm-fnu=auto-intercom;avaya-cm-group=3;avaya -cm-dial-code=2

In this case, PPM provides all values for the FNU parameters, so the endpoint need not complete the FNU parameters (the MustComplete value for both parameters is “none”). When a CM administrator adds an “auto-icom” button to a station, the administrator must also enter a group and dial code. When PPM gets the button information from CM, it also gets the group and dial code.

Issue 1 August 2006

41





Example PPM Response: 4 16 call-appr 16 1 brdg-appr 4 4000 6 FNU avaya-cm-fnu=sac avaya-cm-action= true offon

Issue 1 August 2006

43



Description





Soft Menu Keys Assignment

A SIP phone or other device may obtain its soft menu key assignments with the getSoftMenuKeysAssignments operation. getSoftMenuKeysAssignments(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Response Parameter

Type

Value

SoftMenuKeyList ButtonListInfo

Description

Container for SoftMenuKeys information

ButtonListInfo

Type

Description

NoOfElements

Integer


ButtonList

Array of ButtonData

See ButtonData above

See Dial Plan and Button Assignment on page 37 for definition of Button Data.



Example SUSHI Request: user@domain

Example PPM Response: 2 16 FNU SAC 16 avaya-cm-fnu=sac avaya-cm-action= true true 16 FNU SAC 16 avaya-cm-fnu=call-park

Issue 1 August 2006

45



Description





Report Status

Due to the stateless nature of web environments, both in the personal profile manager and the SES web interface, it is necessary to temporarily store information received so that the administrator can view it. To meet the maintainability and serviceability guidelines, it is necessary for a technician to get the status of a SIP end point. To achieve this, a “get status” link is clicked from the “Registered Devices” page present at each home node in the network. Clicking this link causes the web interface to trigger a notify to that end point stating that its status is needed. The end point in turn calls the Report Status method in PPM. The PPM takes the input from the Report Status method and stores the information in a temporary location. This operation may take a second to be completed. To simulate a “real time” experience in the web interface, the “View Status” page should examine the database every 2 seconds until a record is added for the device in question. reportStatus(Handle, OptimExtension, IPAddress, HostName, SwitchHookStatus, PresenceStatus) Request Parameter

Type

Value

Description

Handle

String

SIP URI


OptimExtension

String

This terminal’s extension

IPAddress

String

This terminal’s IP address

HostName

String

This terminal’s host name

SwitchHookStatus Enum PresenceStatus

String

{On, Off}

Indicates if the terminal is currently on-hook or off-hook This terminal’s current presence status



Example client request: user@domain 1001 135.8.68.110 ipphone.usae.avaya.com ajbaker on-hook available


Endpoint Configuration JUMBO A method exists that can be used to obtain endpoint configuration in one request. The getEndpointConfiguration operation combines the getIdleLineSelection, getMessageWaitingExt, getAutoAnswerType, getLineReservationTimer, getExpiredTimerVal, getRingerSettings, getVolumeSettings, getButtonAssignments, getOneTouchDialList, and getSoftMenuKeyAssignments operations. getEndpointConfiguration(Handle) Request Parameter

Type

Description

Handle

String

User’s handle

Issue 1 August 2006

47


Response Parameter

Type

ConfigInfo

EndpointConfigInfo

Value

Description

Container for Endpoint configuration information

EndpointConfigInfo

Type

Value

Description

VolumeSettings

VolumeSet

See VolumeSet. This terminal information may be used by any end point of the PPM. The terminal calls this method to store this information so that the SES administrator may view this information at a later time. This information must be propagated back to the SES master administration system.)


RingerOnOffListInfo

See RingerOnOffData in getVolumeSettings(Handle) )

ResvTimer

short

30 - 240 seconds

Line Reservation timer value

ExpIntVal

Integer

10 – 864000 seconds (maximum of 10 days)

This is the value to be placed in the Expires header of the SIP REGISTER message.

LinePreferenceInfo

LinePrefInfo

MWExt

String

Maximum of 7 digits

the message waiting extension assigned to the station on CM (Note that the Message Waiting Extension assigned on CM is generally used to light a message waiting lamp on the telephone.)

AutoAnswer

AutoAnsType

{none, icom, acd, all}

the Auto Answer setting for this station on CM



See OneTouchButton -- A Speed Dial List is accessible for each terminal. A SIP phone or device can retrieve its Speed Dial List by invoking the getSpeedDialList request on the PPM server.

ListOfButtonAssignments

ButtonListInfo

See ButtonData (section getDialPlan(Handle))

SoftMenuKeyList

ButtonListInfo

See ButtonData (getDialPlan(Handle))

DialPlanData

DialPlanListInfo

See Dial Plan (section Dial Plan)

ListOfSpeedDialData

SpeedDialListInfo

See SpeedDialEntry (section getRingerSettings(Handle))

CallLog

CallLogInfo

See LogEntry (section Session History (Future)). Note this was deferred.

VmonInformation

VmonInformation

See VMON Information (2.1.6)

See Idle Line Selection



VMON Information The getVMONInformation() method may be used as a stand alone request, or the end point may receive the same information from the JUMBO (getEndPointConfiguration()). This request provides the end point with the RTCP Monitor IP Address, Port Number, and Report Period (in seconds). The VMON information is administered in the SES administration system in the 3.0 release of SES. In subsequent releases, the VMON information will be retrieved from the network region tables in Communication Manager. Note that the same VmonInformation SOAP Struct data type is used in the getEndPointConfiguration response. getVMONInformation() VmonInformation

Type

Value

Description

RtcpServer

String

IP address

The IP address of the RTCP Monitor

VmonPort

Integer

Port

The port of the RTCP Monitor

ReportPeriod

Integer

Seconds

How frequently the end point should be sending the receiver report

Example client request:

Issue 1 August 2006

49


Example PPM Response: 192.168.1.220 53020 60


Description

“NoServerFound”

If there has been no VMON server administered for this host

Home server The Avaya PPM team recommends that end points call the getHomeServer method only once during the initial installation and persist the location until one of the following circumstances: ●

●

●

●

The end point receives a fault from any other PPM method that states the user is not known. The end point should then call the getHomeServer method to verify the user ’s location. This occurs when the digest is still valid but the user was just moved. The end point receives a notification stating it needs to update its location. The end point fails authentication with the PPM or the SIP proxy. For some reason if the user was moved from one SES to another and the end point isn’t notified, the end point may wish to re-validate its home server as an automated run-time troubleshooting step. The end point looses the location information (e.g. non data preserving firmware upgrade)



This method is used when the phone has no record of its location such as during installation time. If a customer deploys multiple SES servers on the same subnet, the existing DHCP mechanism for managing service location does not provide the gra nularity necessary for two clients on the same subnet to use two different servers in a straight forward and automated manner. The getHomeServer method is used to retrieve the location o f the service that the user is supposed to be using. This method may be executed against any SES home in the network and will return the exact same information regardless of which home is local to the request. Once the service location is retrieved, the end point may proceed with SIP registration and initialization of data with its home PPM. getHomeServer(handle) Request

Type

Value

Description

Handle

String

URI

The handle is the primary handle of the user, maybe in the form of “user” or “user@domain”

Response

Type

ServerInfo

HomeServerInfo

Value

Description

Container of HomeServer Information

HomeServerInfo

Type

Value

Description

ppmServer

String

HTTP URL

The URL for the user’s home PPM server.

sipServer

String

Host

The hostname or IP address of the user’s home proxy

sipPort

Integer

Usually 5060

The port that the sip server is listening on

sipDomain

String

The SIP domain as provisioned in SES admin

The end point should always send the register for user@domain, where domain is the SIP domain and not the hostname of the SIP server.

transportList

ArrayOfTransportdata

Array of transport information

Issue 1 August 2006

51


Transportdata

Type

Value

Description

transportName

String

{tls, tcp, udp}

Name of the transport

transportPort

Integer

{5060, 5061}

The port of the transport. In this release, it will always be either 5060 or 5061

Example client request: user@domain

Example PPM Response: udp 5060




Description

“ServiceError”

If there is an error in retrieving the location from the back end system

If the authentication fails for the getHomeServer method, this implies that either the password is invalid or that the user name is invalid. If the user and password are correct, the user will be authenticated and any errors in retrieving the server information will be returned in the ServiceError SOAP Fault.

Retry Fault Due to the complex relationships the PPM has with both the Converged Communications Server and Communication Manager systems, there may be instances where the PPM must throttle requests to service many simultaneous requests. In these cases, the PPM may return a SOAP stating a number of seconds that the end point should re-try the exact same request. This feature allows PPM to continue servicing end points that it may not have been able to before. Example SOAP Fault soap:Server Retry 30

Notice in this SOAP fault that the PPM returns the standard SOAP fault structure. The faultstring is ‘Retry’ and the detail contains an integer. The client should retry the request after waiting that integer’s time in seconds.

Issue 1 August 2006

53


End Point to Personal Profile Manager Data Flows On-demand information The Personal Profile Manager does not restrict how or when the terminal is to fetch its data. The terminal may choose to retrieve its configuration when it initially powers on and [SIP] registers with SES, and every subsequent [SIP] re-register, or every other re-register, or not at all. The only time a terminal must retrieve information from PPM is on a user event, e.g. the user clicks “View Call Log” on their terminal, or from a profile event package event. This section specifies the data flow for when a user interacts with their terminal and the terminal must retrieve information from PPM. In all instances, the terminal must include credentials when it retrieves information from PPM on demand. When the user presses the button to ‘View Call Log’, the terminal sends a SOAP request to PPM, including the HTTP authentication credentials, and executes the getCallLog SOAP method. The PPM forms the SOAP response and sends it back to the terminal. The terminal must process the SOAP body and format the information for the display on the terminal. Feature Requests Data from PPM

End User

Toshiba Phone

PPM

User clicks “View Call Log” getCallLog

getCallLogResponse

Call Log displayed on terminal


End Point to Personal Profile Manager Data Flows

Profile Event Package The Profile Event Package is an Avaya proprietary event package to notify SIP end points of profile events. There are three profile events: ●

Reboot Required (as demanded by system administrator via SES maintenance interface)

●

Report Status (as demanded by system administrator via SES maintenance interface)

●

Reload Profile (when user’s profile changes on SES, or system administrator demands via SES maintenance interface)

The phone must subscribe to the profile event package as one of its initializing steps. By subscribing to this event package, the phone will gain several desirable features. First, the administration may use the SES administration system to reboot one or more end points. The administration system triggers the NOTIFY to the terminal, and the phone or d evice reboots. The administrator may also wish to have an on-demand status of the end point. In this case, the administrator clicks on “Get Status” for a terminal in the SES administration system. A NOTIFY is generated to that specific end point, and the end point calls the report Status method in the Personal Profile Manager. The administrator may then view what the terminal reported back as its status. The final feature is for user experience. If some information in the user’s profile changes, e.g. the user changes information from the SIP Personal Information Manager or the administrator changes some information, the end user’s terminal must be updated to reflect this information. The terminal will receive a notify whenever some information in the profile has changed. The terminal should then execute all of its initialization methods – i.e. getEndPointConfiguration, getDialPlan, and getSpeedDialList. The Notify includes a timestamp of the most recent profile. The endpoint can check this timestamp, if its profile is up to date then it need not execute the initialization methods. All of these events are handled under one subscription to the Profile Event Package. The terminal should subscribe as part of its initialization process. Note that the notifications are SIP NOTIFY messages with XML bodies.

Issue 1 August 2006

55


Just one example of a SUBSCRIBE message might be: SUBSCRIBE sip:[email protected] SIP/2.0 From: ;tag=random1 To: Call-Id: [email protected] CSeq: 1 SUBSCRIBE Contact: Event: avaya-ccs-profile Accept: application/profile+xml Expires: 3600 Max-Forwards: 70 User-Agent: Toshiba/2.1.8 (VxWorks) Via: SIP/2.0/UDP 10.0.75.2branch=z9hG4bK=random-2 Route: Content-Length: 0

Reboot Required Whenever the following notify is received, the terminal should reboot at its earliest convenience (e.g. when the user is no longer on an active call). NOTIFY sip:[email protected] SIP/2.0 Call-ID: [email protected] CSeq: 2 NOTIFY From: ;tag=random2 To: ;tag=random1 Via: SIP/2.0/UDP 10.0.0.100;branch-id=z9hG4bK-random-ccs1 SIP/2.0/TLS 10.0.0.200;branch-id=z9hG4bK-random-cm1 Content-Length: 22 Content-Type: application/profile+xml Contact: Max-Forwards: 69 User-Agent: Avaya Communication Manager v1.0 Event: avaya-ccs-profile Subscription-State: active;expires=3600 Record-Route: Reboot [timestamp]


End Point to Personal Profile Manager Data Flows

Report Status Whenever the following notify is received, the terminal should call the reportStatus method in the Personal Profile Manager. NOTIFY sip:[email protected] SIP/2.0 Call-ID: [email protected] CSeq: 2 NOTIFY From: ;tag=random2 To: ;tag=random1 Via: SIP/2.0/UDP 10.0.0.100;branch-id=z9hG4bK-random-ccs1 SIP/2.0/TLS 10.0.0.200;branch-id=z9hG4bK-random-cm1 Content-Length: 22 Content-Type: application/profile+xml Contact: Max-Forwards: 69 User-Agent: Avaya Communication Manager v1.0 Event: avaya-ccs-profile Subscription-State: active;expires=3600 Record-Route: Report [timestamp]

Reload Profile The profile code assists the end point in making a decision on which PPM methods to call when it receives the reload profile notify. Profile Code (Enum)

Description

0

The location has changed, the end point should call getHomeServer and re-initialize fully

1

Button data changed, the phone should execute getEndPointConfiguration

2

Contact list changed. The phone should execute getcontactList and getSpeedDialList.

3

Away Messages changed

4

Permissions changed.

Issue 1 August 2006

57


The phone is only suggested to call the methods that correspond to the profile code. If the phone does not support a speed dial list or a contact list, then a NOTIFY with an event code of 2 should be ignored. Similarly, the phone may choose to re-initialize all data regardless of the profile code. The lack of a profile code indicates that the phone should re-initialize fully. Note in the first release, the “SUSHI” end point is expected to only receive 0 or 1 for a profile code. Figure 1: Reload profile Notify NOTIFY sip:[email protected] SIP/2.0 Call-ID: [email protected] CSeq: 2 NOTIFY From: ;tag=random2 To: ;tag=random1 Via: SIP/2.0/UDP 10.0.0.100;branch-id=z9hG4bK-random-ccs1 SIP/2.0/TLS 10.0.0.200;branch-id=z9hG4bK-random-cm1 Content-Length: 22 Content-Type: application/profile+xml Contact: Max-Forwards: 69 User-Agent: Avaya Communication Manager v1.0 Event: avaya-ccs-profile Subscription-State: active;expires=3600 Record-Route: Reload [timestamp] 0

References 1. “Gateway Control Protocol Version 1 (aka H.248.1)”, RFC 3525, http://www.ietf.org/rfc/ rfc3525.txt 2. “HTTP Authentication: Basic and Digest Access Authentication”, RFC 2617, http:// www.ietf.org/rfc/rfc2617.txt 3. Simple Object Access Protocol (SOAP) 1.1, http://www.w3.org/TR/SOAP/ 4. Web Services Definition Language (WSDL) 1.1, http://www.w3.org/TR/wsdl 5. Apache Web Services Project, Axis, http://ws.apache.org/axis/


Detailed FNU Description

Detailed FNU Description Feature Name URI examples In all of these examples: ●

●

1111 is the CM extension associated with the endpoint that is sending the INVITE FNU. 2222 is used where the feature is activated on another CM extension. The actual value of 2222 is provided to the endpoint by PPM, and is placed by the endpoint in the user part of the Request-URI. If there is no example here using 2222 as the user part of the Request-URI for a particular FNU, then that FNU only accepts the endpoint’s own extension in that field (i.e., 1111).

●

3333 is a any other CM extension (e.g., the object of a directed call pickup).

●

4444444 is any number within the CM dial plan, which may be either on or off switch.

Parameters are marked as either optional (O) or mandatory (M). This distinction is relative to the inclusion of these parameters in the INVITE. Some of these parameters might still be mandatory to CM. If an optional parameter is not sent by the endpoint in the INVITE, but is required by CM, CM will provide dial tone to the user and collect the required digits. Parameters may be supplied in any order. The order in this document is recommended. Whenever available, the value of a parameter is extracted from a CM button by PPM, and then provided by PPM to the endpoint (e.g., avaya-cm-group). For values not available from CM, and therefore not provided by PPM to the endpoint, the endpoint will need to do one of the following: ●

determine the value algorithmically (e.g., avaya-cm-action),

●

collect the value from the user (e.g., avaya-cm-destination),

●

or, if an optional parameter, leave it off and let CM collect it.

The endpoint must send SDP in the INVITE for those FNUs where indicated below. Whenever sending SDP, the endpoint must also request a line appearance (+line) on the Contact header. Automatic Call Back

INVITE sip:[email protected];avaya-cm-fnu=auto-callback ;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=auto-callback ;avaya-cm-action=off SIP/2.0

Issue 1 August 2006

59


Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No

Authorization:

This request must be authorized by the class of service of the extension.

Description:

Automatic Call Back activates or deactivates the Automatic Call Back feature for an endpoint’s own extension. When activated, this feature allows a user who placed a call to a busy or unanswered telephone to be called back automatically when the called telephone becomes available to receive a call.

CM button:

auto-cback

Feature package:

Yes

SDP required:

No

Automatic Intercom

INVITE sip:[email protected];avaya-cm-fnu=auto-intercom ;avaya-cm-group=9;avaya-cm-dial-code=12 SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-group

Intercom group number from 1 to 32

M

Yes

avaya-cm-dial-code

One or two digit dial code assigned to the extension to be called

M

Yes



Authorization:

An endpoint can use this FNU only if the endpoint has a “auto-icom” button administered on CM with matching group number and dial code.

Description:

Automatic Intercom places a call to the station associated with the button. The called user receives a unique alerting indication. The endpoint extension and destination extension must be in the same intercom group. This feature is exactly like Dial Intercom except for the way that the dial code is specified. PPM can provide the dial code for Automatic Intercom, but not for Dial Intercom.

CM button:

auto-icom Gr: 9 DC: 12

Feature package:

No

SDP required:

Yes

Call Forwarding All Calls, of the endpoint’s own (1111) extension

INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-all ;avaya-cm-destination=4444444;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-all ;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-all ;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No

avaya-cm-destination

Any number within the CM dial plan, to which this endpoint is being forwarded.

O

No

Authorization:

This example shows the use of this FNU on the endpoint’s own extension. It must be authorized by the extension’s class of service. See the next case for how to apply this feature to another extension.

Description:

Activates or deactivates Call Forwarding All Calls.

Issue 1 August 2006

61


CM button:

call-fwd Ext: (left blank)

Feature package:

Yes

SDP required:

Only if avaya-cm-action=on and avaya-cm-destination not specified.

Call Forwarding All Calls, of another endpoint’s (2222) extension

INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-all ;avaya-cm-destination=4444444;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-all ;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-all ;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No



O

No

Authorization:

An endpoint can use this FNU on another extension only if the endpoint has a “call-fwd Ext: 2222” button administered on CM.

Description:

Activates or deactivates Call Forwarding All Calls, on the extension specified in the user part of the Request-URI.

CM button:

call-fwd Ext: 2222

Feature package:

Yes

SDP required:


Call Forwarding Busy/Don’t Answer, of the endpoint’s own (1111) extension

INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-busy-no-answer ;avaya-cm-destination=4444444;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-busy-no-answer ;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-busy-no-answer ;avaya-cm-action=off SIP/2.0



Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No



O

No

Authorization:

This example shows the use of this FNU on the endpoint’s own extension. It must be authorized by the extension’s class of service.See the next case for how to apply this feature to another extension.

Description:

Call Forward Busy/Don’t Answer activates and deactivates call forwarding for calls when the extension is busy or the user does not answer.

CM button:

cfwd-bsyda Ext: (left blank)

Feature package:

Yes

SDP required:


Call Forwarding Busy/Don’t Answer Calls, of another endpoint’s (2222) extension

INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-busy-no-answer ;avaya-cm-destination=4444444;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-busy-no-answer ;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-forwarding-busy-no-answer ;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No



O

No

Issue 1 August 2006

63


Authorization:

An endpoint can use this FNU on another extension only if the endpoint has a “cfwd-bsyda Ext: 2222” button administered on CM

Description:

Call Forward Busy/Don’t Answer activates and deactivates call forwarding for calls when the extension is busy or the user does not answer, on the extension specified in the user part of the Request-URI.

CM button:

cfwd-bsyda Ext: 2222

Feature package:

Yes

SDP required:


Call Park

INVITE sip:[email protected];avaya-cm-fnu=call-park SIP/2.0

Parameters:

None.

Authorization:

None.

Description:

Allows the user to place the current call in the call park state so it can be retrieved from another phone.

CM button:

call-park

Feature package:

No

SDP required:

No

Call Unpark (Answer-Back)

INVITE sip:[email protected];avaya-cm-fnu=call-unpark ;avaya-cm-extension=3333 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-unpark SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-extension

The CM extension where the call is parked.

O

No



Authorization:

None.

Description:

Allows the user to retrieve a call parked at another extension. The endpoint will be connected to the parked call.

CM button:

None. Accessed on the CM only via a FAC.

Feature package:

No

SDP required:

Yes

Call Pickup (group)

INVITE sip:[email protected];avaya-cm-fnu=call-pickup SIP/2.0

Parameters:

None.

Authorization:

The endpoint must be a member of a pickup group and can only pickup calls to other group members.

Description:

Allows the user to answer a call that is ringing in the user’s pickup group.

CM button:

call-pkup

Feature package:

No

SDP required:

Yes

Directed Call Pickup

INVITE sip:[email protected];avaya-cm-fnu=call-pickup-directed ;avaya-cm-extension=3333 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-pickup-directed SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-extension

The CM extension where the call is alerting.

O

No

Issue 1 August 2006

65


Authorization:

The endpoints need not be members of a group, but directed call pickup must be authorized by the class of restriction for both endpoints.

Description:

Directed call pickup allows the user to answer a call ringing at another extension without having to be a member of a pickup group.

CM button:

dir-pkup

Feature package:

No

SDP required:

Yes

Extended Group Call Pickup

INVITE sip:[email protected];avaya-cm-fnu=call-pickup-extended ;avaya-cm-pickup-number=3 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=call-pickup-extended SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-pickup-number

The pickup number from 1 to 24.

O

No

Authorization:

The endpoint must be a member of a pickup group, and that pickup group must be a member of an extended pickup group, which must also include the group of the endpoint whose phone is being picked up.

Description:

Enables call pickup groups to answer calls directed to another call pickup group.

CM button:


Feature package:

No

SDP required:

Yes

Calling Party Number Block

INVITE sip:[email protected];avaya-cm-fnu=calling-party-block ;avaya-cm-destination=4444444 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=calling-party-block SIP/2.0



Parameters: Name

Values

M|O

PPM


Any number within the CM dial plan, to which this call is being directed.

O

No

Authorization:

None.

Description:

Blocks the sending of the calling party number for one call.

CM button:

cpn-blk

Feature package:

No

SDP required:

Yes

Calling Party Number Unblock

INVITE sip:[email protected];avaya-cm-fnu=calling-party-unblock ;avaya-cm-destination=4444444 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=calling-party-unblock SIP/2.0 Parameters: Name

Values

M|O

PPM



O

No

Authorization:

None.

Description:

Deactivates calling party number (CPN) blocking and allows the CPN to be sent for a single call.

CM button:

cpn-unblk

Feature package:

No

SDP required:

Yes

Dial Intercom

INVITE sip:[email protected];avaya-cm-fnu=dial-intercom ;avaya-cm-group=9;avaya-cm-dial-code=12 SIP/2.0

Issue 1 August 2006

67


INVITE sip:[email protected];avaya-cm-fnu=dial-intercom ;avaya-cm-group=9 SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-group

Intercom group number from 1 to 32

M

Yes

avaya-cm-dial-code

One or two digit number

O

No

Authorization:

An endpoint can use this FNU for a intercom group that matches an administered CM button for this extension (as shown below).

Description:

Dial Intercom places a call to the station associated with the button. The called user receives a unique alerting indication. The endpoint extension and destination extension must be in the same intercom group. This feature is exactly like Automatic Intercom except for the way that the dial code is specified. PPM can provide the dial code for Automatic Intercom, but not for Dial Intercom.

CM button:

dial-icom Grp: 9

Feature package:

No

SDP required:

Yes

Drop

INVITE sip:[email protected];avaya-cm-fnu=drop SIP/2.0 Parameters:

None.

Authorization:

None.

Description:

Allows users to drop calls. Users can drop calls from automatic hold or drop the last party they added to a conference call.

CM button:

drop

Feature package:

No

SDP required:

No

Exclusion

INVITE sip:[email protected];avaya-cm-fnu=exclusion ;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=exclusion ;avaya-cm-action=off SIP/2.0



Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No

Authorization:

This request always applies to the endpoint’s own extension. Automatic exclusion must be authorized by the extension’s class of service.

Description:

Exclusion allows multiappearance telephone users to keep other users with appearances of the same extension from bridging onto an existing call. If the user activates exclusion button while other users are already bridged onto the call, the other users are dropped. There are two means of activating exclusion. ● Manual Exclusion — when the user presses the exclusion button (either before dialing or during the call). ● Automatic Exclusion — as soon during a call, the user presses the exclusion button.

CM button:

exclusion

Feature package:

No

SDP required:

No

Off-PBX Call

INVITE sip:[email protected];avaya-cm-fnu=off-pbx;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=off-pbx;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No

Authorization:

This request always applies to the endpoint’s own extension.

Description:

This FNU provides the capability to enable and disable the extension of an EC500 call. The EC500 station must have one or more administered bridged appearances on the SIP phone for this FNU to have the desired effect.

CM button:

ec500

Feature package:

Yes

SDP required:

No

Issue 1 August 2006

69


Off Hook

INVITE sip:[email protected];avaya-cm-fnu=off-hook SIP/2.0 Parameters:

None.

Authorization:

None.

Description:

Reserves a line appearance.

CM button:

None.

Feature package:

No

SDP required:

No, but +line is required

Last Number Dialed

INVITE sip:[email protected];avaya-cm-fnu=last-number-dialed SIP/2.0 Parameters:

None.

Authorization:

None.

Description:

Last Number Dialed (redial) originates a call to the number last dialed by the station.

CM button:

last-numb

Feature package:

No

SDP required:

Yes

Malicious Call Trace

INVITE sip:[email protected];avaya-cm-fnu=mct SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=mct-cancel SIP/2.0 Parameters:

None.

Authorization:

Must be authorized by the endpoint’s class of restriction.

Description:

Malicious Call Trace Activation: sends a message to the MCT control extensions that the user wants to trace a malicious call. MCT activation also starts recording the call, if your system has a MCT voice recorder.

CM button:

mct-act (to activate). Only a FAC to cancel.

Feature package:

No

SDP required:

No



AUDIX One-Step Recording

INVITE sip:[email protected];avaya-cm-fnu=one-touch-recording ;avaya-cm-extension=3333;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu= one-touch-recording ;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No

avaya-cm-extension

The CM extension of an AUDIX hunt group

M

Yes

Authorization:

An endpoint can use this FNU on another extension only if the endpoint has a CM button audix-rec button with a matching extension.

Description:

This features allows a station user to start and end the recording of an in-progress conversation using the AUDIX system recording facility. Note: avaya-cm-extension is optional when avaya-cm-action is “off” (because a station can only have one of these buttons).

CM button:

audix-rec Ext: 3333

Feature package:

No

SDP required:

No

Priority Call

INVITE sip:[email protected];avaya-cm-fnu=priority-call ;avaya-cm-destination=4444444 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=priority-call SIP/2.0 Parameters: Name

Values

M|O

PPM



O

No

Issue 1 August 2006

71


Authorization:

None.

Description:

Priority Calling allows a user to place priority calls or change an existing call to a priority call.

CM button:

priority

Feature package:

No

SDP required:

Yes

Send All Calls, of the endpoint’s own (1111) extension

INVITE sip:[email protected];avaya-cm-fnu=sac;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=sac;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No

Authorization:

This example shows the use of this FNU on the endpoint’s own extension. No authorization is required. See the next case for how to apply this feature to another extension.

Description:

Send All Calls allows users to temporarily direct all incoming calls to coverage regardless of the assigned call-coverage redirection criteria.

CM button:

send-calls Ext: (left blank)

Feature package:

Yes

SDP required:

No

Send All Calls, of another endpoint’s (2222) extension

INVITE sip:[email protected];avaya-cm-fnu=sac;avaya-cm-action=on SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=sac;avaya-cm-action=off SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-action

on or off

M

No



Authorization:

An endpoint can use this FNU on another extension only if the endpoint has a “send-calls Ext: 2222” button administered on CM.

Description:

Send All Calls allows users to temporarily direct all incoming calls to coverage regardless of the assigned call-coverage redirection criteria. Applied to another extension.

CM button:

send-calls Ext: 2222

Feature package:

Yes

SDP required:

No

Transfer to Voice Mail

INVITE sip:[email protected];avaya-cm-fnu=transfer-to-voicemail SIP/2.0 Parameters:

None.

Authorization:

None.

Description:

Allows coverage to transfer the caller to the original call recipient’s voice mail where the caller can leave a message.

CM button:


Feature package:

No

SDP required:

No

Whisper Page Activation

INVITE sip:[email protected];avaya-cm-fnu=whisper-page ;avaya-cm-extension=3333 SIP/2.0 INVITE sip:[email protected];avaya-cm-fnu=whisper-page SIP/2.0 Parameters: Name

Values

M|O

PPM

avaya-cm-extension

The CM extension to which you want to whisper

O

No

Issue 1 August 2006

73


Authorization:

The user must have a class of restriction (COR) that allows intraswitch calling to use whisper paging, and the extension to whom you are whispering must not have blocked whispers.

Description:

Whisper Page Activation allows a user to make and receive whisper pages. A whisper page is an announcement sent to another extension who is active on a call where only the person on the extension hears the announcement; any other parties on the call cannot hear the announcement.

CM button:

whisp-act

Feature package:

No

SDP required:

Yes

WSDL Document The following WSDL document (formatted for readability) defines the interface with the PP M server for the data described above. This WSDL document is included here for convenience; note that the final, normative WSDL document would be accessible from an Avaya web site or through the software interface. - - - - - - -


WSDL Document

- - - - - - - - - - - - - - - -

Issue 1 August 2006

75


- - - - - - - - - - - -


WSDL Document

- - - - - - - - - - - - - - -

Issue 1 August 2006

77


- - - - - - - - - - - - - - - - -


WSDL Document

- - - - - -

Issue 1 August 2006

79


-

-

WatcherListInfo">


WSDL Document

watchers" nillable="true" type="impl:ArrayOfRegistrations" /> - - - - - - - - - VMONInformation"> - VmonPort" type="xsd:int" /> - -

Issue 1 August 2006

81


- - - - - - - - - - - - - Vendor" nillable="true" type="xsd:string" />


WSDL Document

- - - - -

-

-

-

-

VolumeSet">

Issue 1 August 2006

83


- - - - - - - VolumeSettings" nillable="true" type="impl:VolumeSet" />

-

-

-

VMONInfo" nillable="true" type="impl:VMONInformation" />


WSDL Document

-

-

-

-

-

-

-

-

Vendor" nillable="true" type="xsd:string" />

Issue 1 August 2006

85


-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

> > > > > > > > > > > > VMONInfo VMONInfo" type > > > > > > > >

86 Interface Interface Specifi Specificatio cation n Document Document for Person Personal al Profile Profile Manager Manager

WSDL Document

- > - > - > - moveToGroup moveToGroup" type > - > - > - > - > - > - > - > - > - > - > - > - > -

Issue 1 August 2006

87


-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

> > > > > > > > > > > > > > > >


WSDL Document

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

> > > > > > > > > > VolumeSettings VolumeSettings" type > VolumeSettings VolumeSettings" type > > > watcherList watcherList" type >

Issue 1 August 2006

89


- - - - - - - - - - - - - - -


WSDL Document

- - - - - - - - - - - - -

Issue 1 August 2006

91


- - - - - - - -


WSDL Document

- - - - - - - -

Issue 1 August 2006

93


- - - - - - - - -


WSDL Document

- - - - - - - - -

Issue 1 August 2006

95


- - - - - - - - - - - - - -

WSDL Document

namespace="http://xml.avaya.com/service/ProfileManagement/112004" use="encoded" - - - - - - - - - - - - - - -

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

Issue 1 August 2006

97


- - - - - - - - - - - - - -

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

WSDL Document

- - - - - - - - - - - - - - -
/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

Issue 1 August 2006

99




/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

WSDL Document

- - - - - - - - - - - - - -
/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

Issue 1 August 2006

101


- - - - - - - - - - - - - - -

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

WSDL Document


/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

Issue 1 August 2006

103


- - - - - - - - - - - - - -

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

WSDL Document

> - - > - > - > > - - > - > - > > - - > - > - > > - - > -
/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

Issue 1 August 2006

105


namespace="http://xml.avaya.com/service/ProfileManagement/112004" use namespace=" use=" ="encoded" > - > > - - > - > - > > - - > - > - > > - - > - > - > > - -


/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

WSDL Document

> - > - > > - - > - > - > > - - > - > - > > - - > - > -
/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

/>

Issue 1 August 2006

107


- -


Appendix A: PPM SOAP Interface for DevConnect

Introduction This document provides the details on using the Personal Profile Manager (PPM) SOAP Web Service for contact list management, password change, and phone reloading by a customer-provided web application. While the use of these services was not in the scope of the original PPM Server software, Avaya recognizes the convenience and simplification it would provide customers wishing to provide an integrated user experience for their intranet.

Proposed Solution It has been proposed to use the PPM SOAP Service interface directly for integration into customer web application environments. This proposal is to use a limited number of SOAP operations available in the PPM SOAP service interface to build SIP Personal Information Manager (SIP PIM) functionality directly into customer applications. In this case, end users would never use the default SIP PIM interface on the SIP Enablement Services (SES) home server, but rather one (or more) customer-developed and provided web application(s).

Issue 1 August 2006

109

PPM SOAP Interface for DevConnect

Figure 2: Solution Overview

Figure 2 shows the differences between the generic SIP PIM scenario and a Toshiba end-user scenario, just for example. In the default scenario, an end user would browse to the host name of the SES home server and login to the web application resident on SES. In the proposed solution, the Toshiba end users only would browse to the Toshiba-provided intranet web application. In turn, the web app would use the PPM SOAP service interface for retrieving and managing the data for that end user’s profile. Note that the Avaya PPM SOAP Service provides many operations for managing different areas of the user’s profile. The Toshiba SIP Phone, for example, uses a portion of these operations. A limited number of the other operations are available for providing the features desired in certain web applications. These operations do not overlap, and d o not cover all of the possible operations available in PPM. Figure 3 below provides a visual representation of this:


PPM SOAP Service Specification

Figure 3: PPM SOAP Operation Coverage

PPM SOAP Service Specification Note that the performance constraints defined in this document are intended for PPM usage in a steady-state system that is not under heavy load. During high traffic times, PPM runs at a lower priority than call processing and may respond slower. Additionally, exceeding the constraints defined this document could have adverse affects on system performance. If this occurs, connection between the customer web application and the Avaya SES systems via SOAP should be disabled and further analysis done to determine the root cause of the problem. Note on empty parameters: PPM interprets a null value as preserving the existing value in the database and not overwriting it. An empty string indicates that the client wants to overwrite and erase the data in that field with an empty string. ●

The empty string is

●

null is or

The default namespace is: http://xml.avaya.com/service/ProfileManagement/112004 The default encoding is UTF-8 unless otherwise specified. The example SOAP messages are only examples, they are not exact examples of the SOAP requests, but examples that have had extra attribute information removed for easier reading of the document. Possible error conditions: Fault

Description

“DatabaseError”


“Duplicate Contact”

This contact already exists

“Invalid Group”

This occurs when a user tries to add a contact to a non-existent group (this should rarely occur)

Issue 1 August 2006

111


Fault

Description

“InvalidUser”

Occurs when the incorrect handle is used in the request parameter

“UserNotAuthorized”

Occurs when authentication fails

“ContactAddressNull”

Occurs when a contact is added with a null address

“ContactDoesNotExist”

Occurs when trying to update a contact that does not exist

“InvalidPArentGroup”

Occurs when specifying an invalid parent group

“DatabaseNotAccessible”

Occurs when PPM cannot access the SES database (serious error condition)

“InvalidDataType”

Occurs when an invalid type is used in a request

“NotPrimaryHandle”

Occurs when a request is made with a requester’s handle that is not the primary handle

getContactList getContactList is used for retrieving the user’s contact list. The contact list contains all the information necessary for displaying a full contact list with all the data provided by default in the Avaya contact list in the Converged Communications Server. DevConnect members may use only a few fields in the contact list, or as many of them as needed. The table below shows the fields currently in use: Column

Value

e.g.

Address

Phone Number + SIP Domain name

[email protected]

Name

Same value as label_1

TSIS Mori

Alias

Empty string

Empty string

Group Name

Always use “top”

“top”

E-Mail

E-mail address.

takashi1.mori@customer .com

Notes

Empty String

Empty String

Contact Phones #1:

Å@

Å@

Phone Number

Phone Number

66034

Label 1

Label 1

TSIS Mori



Column

Value

e.g.

Label 2

Label 2

MORI, Takashi

Speed Dial

Always True

True

Prefix

Prefix

Null or 1 or 71

Type

Select (Work, Work_Mobile, Home...)

“Work”

Contact Phones #2-#6:

Do not use #2-#6.

The alias, notes, and contact phones 2-6 are not used. Also note that the example application may not use the hierarchy of groups that Avaya provides, only the flat “top” or default group. Performance Constraint: The DevConnect membr’s custom application must limit the use of

getContactList to 4 requests per second. Avaya recommends caching this data, since the users will not be changing it via the SIP PIM on the SES host, nor can the phone change this data yet. Implementation Constraint: Note that after getContactList is called for the first time in a single

user session, getPermissionType(handle, area) must be called. Handle is the user’s handle that is logged in, and area should be set to: presence getContactList( Handle ) Request Parameter

Type

Value

Description

Handle

String

SIP URI


ContactListInfo

Type

Value

Description

NoOfElements

Integer


ArrayOfContactData

Array

Array of Contacts

Issue 1 August 2006

113


ContactData

Type

Value

Description

Address

String

Maximum of This is the primary handle for the 254 contact. Note that primary handle characters may be an actual primary handle as defined in SES administration, an external handle for a foreign domain, or a telephone number.

Name

String

Maximum of For “SUSHI,” this is a 10 Kanji 32 UTF-8 Character value which represents characters the name assigned to the button. For example, Button 1 has assigned Name ‘Steve’, Button 2 has assigned Name ‘Sakai-San’, etc. The SIP PIM page will limit the number of characters entered.

Alias

String


Group

String

Maximum of Group name 32 UTF-8 characters

ParentGroup

String

Maximum of the Parent Group Name in the 32 UTF-8 user’s contact list. characters

E-Mail

String

Maximum of May be any string, this is used for 256 informational purposes only. characters

isBuddy

OptionalBoolean

Enum of {true, false, ignore}

Should be set to ignore, in most cases

Notes

String

Maximum 1024 UTF-8 Characters

May be any string, this is used for informational purposes only.

ContactPhones

ArrayOfContactPhoneData

For “SUSHI,” this is 16 Kana characters to help with sorting.

Array of ContactData for the contact’s alternate phone numbers, optional



ContactPhoneData

Type

Value

Description

SpeedDialEnable

OptionalBoolean

Enumeration of {true, false, ignore}

Enabled or Disabled

PrefixTelNum

String

Maximum of 4 A prefix, such as a routing (AAR or digits ARS) access code, required in addition to the target’s telephone number. May be blank.

PhoneNumber

String

Maximum of A telephone number (or a general SIP 256 URI) assigned to the button for speed characters dial

Label1

String

SOAP Standard

Label for the phone’s button

Label2

String

SOAP Standard

Alternate label for the phone’s button

Example Request: ajbaker

Issue 1 August 2006

115


PPM Response: 1
[email protected]
Test Test top Testing true

Note that schema tags used in the above examples are just samples of what SOAP messages may look like, and development will specify the XML schema during development. Developers should follow the WSDL document when developing.

addContact Performance Constraint: Should be implemented with a usage of addContact limited to three (3) requests/second.

The following field validation is done on the addContact data: Parameter

Description

Length

A/U*

Character Types

Handle

Handle of a buddy. May be URI

254

A

Alpha, num, dash, -_.@

Name

Name of a buddy

64

U

Alpha, num, space, . -_’

Alias

Alias of a buddy

32

U

Alpha, num, space, .-_’



Parameter

Description

Length

A/U*

Character Types

Email

Email of a buddy

256

A

Alpha, num, -_.@

Notes

Notes for a buddy

1024

U

Any

PhoneNumber Phone number or URI for a buddy phone

256

A

Alpha, num, -_@.

Prefix

4

A

Num

Prefix for a speed dial

Additionally, HTML will be stripped out and XML special characters will be converted as per the XML 1.0 specification. ContactPhones are optional, however if the user does enter a ContactPhone data, then the PhoneNumber is a required field for that ContactPhone data and all other fields are optional. For example, if the user enters a label, but not a phone number, an error will be returned. addContact(Handle, ContactData); Request Param.

Type

Value

Description

Handle

String

SIP URI


ContactProfileData ContactData

Container for profile data

ContactData

Type

Description

Address

String

Contact’s URI

Name

String

Name of the contact

Alias

String

Alias of the contact

Group

String

Name of the group the contact is in.

ParentGroup

String

Name of the parent group (always ‘top’ in “SUSHI R1”)

Email

String

Email contact

Notes

String

Notes about the contact

ContactPhoneData ArrayOfContactPhoneData

Phone and Speed dial information

Issue 1 August 2006

117


ContactPhoneData

Type

Description

PhoneNumber

String

Phone number or SIP URI

Label_1

String

Label for the button

Label_2

String

Label for the button (used by TSP)

SpeedDialEnable

Boolean

Enable this as a speed dial entry or not. Speed dial entries will be returned in getSpeedDialList

PrefixTelNum

Integer

Prefix for the speed dial

Example Terminal Request: [email protected] Joe Smith Joe SIP [email protected]

This method takes in at least one parameter being the ContactName that the user wishes to add to their contact list. The ContactAlias and ContactGroup fields are not required and are defaulted to null and top respectively. PPM Response: PPM_Success



updateContact Performance Constraint: Should be implemented with usage of updateContact limited to three (3) requests/second.

updateContact(Handle, OldAddress, OldGroupName, ContactData) See 3.2 for the specification of the contact data.

Example: Example Terminal Request: user@domain oldcontact SIP Contacts [email protected] Joe Smith Joe SIP .

PPM Response: PPM_Success

Issue 1 August 2006

119


deleteContact Delete contact takes the user’s primary handle that is logged in, and the contact they wish to remove from their contact list. Performance Constraint: Should be implemented with a usage of deleteContact limited to

four (4) requests per second deleteContact(Handle, Address) Request Parameter

Type

Value

Description

Handle

String

SIP URI


Address

String

SIP URI

The contact’s handle

Example Terminal Request: [email protected] [email protected]




changePassword Note that Avaya allows alphanumeric characters in the password but no whitespace. The allowable characters are also ASCII only for changePassword. DevConnect members are free to add a further restriction for numeric passwords only. changePassword(Handle, Password) Parameter

Type

Value

Description

Handle

String

SIP URI


Password

String


The user’s new password

Example Terminal Request: user@domain 123123


Issue 1 August 2006

121


getRegistrations getRegistrations is used to retrieve the list of SIP registrations for a user. getRegistrations(Handle) Request Parameters

Type

Value

Description

Handle

String

URI


Response Parameter

Type

Description

RegistrationsListInfo

ListOfRegistrations

Container for the list of registrations

ListOfRegistrations

Type

Description

NumOfElements

Integer


RegistrationList

ArrayOfString

Array of registered SIP contacts

Example client request: [email protected]



Example PPM Response: 2 sip:user@ip1 sip:user@ip2


Description

“DatabaseError”

If there was an error with the database

getHomeCapabilities The getHomeCapabilities method is a separate method from getHomeServer that allows an end point to discover various capabilities about that server. getHomeServer is used for discovering which home you are supposed to be using, and getHomeCapabilities provides information to the end point on how they can use it. A valid scenario is: ●

End point finds local PPM via DHCP

●

End point finds true home via getHomeServer

●

End point queries true home for capabilities

●

End point is ready for normal operation

Issue 1 August 2006

123


The getHomeCapabilities method takes one parameter, the primary handle of the user. While this parameter is redundant with the user authentication from the HTTP header, it does provide a forward-looking compatibility when getHomeCapabilities could presumably specify what features are available for a given user. For example, the 3.1 Conferencing feature, the ServiceData would look like: ServiceName: conference-server ServiceURL: [email protected] ServiceTransport: ServiceVersion: 1 ServiceFeatures: name=size value=6 version=1 In the future when there are multiple conference server services available, they will all still have the ServiceName equal to conference-server. The feature data will be the differentiating factor, and end points should be able to narrow down the different types of services by first finding the ServiceNames and then examining the feature data. The example SOAP request below shows what the response looks like in SES 3.1. getHomeCapabilities(Handle) Request Parameters

Type

Value

Description

Handle

String

URI


Response Parameter

Type

Description

ServerCapabilities

CapabilitiesList Container element for the server capabilities

CapabilitiesList

Type

Description

ServicesList

ArrayOfServiceData


FNUList

ArrayOfFNUFeatures

Array of FNUFeature types



ServiceData

Type

Description

ServiceName

String

The name of the service, e.g. “proxy”

ServiceURI

String

URL of the service if available

ServiceTransport

ArrayOfTransportData

Optional Transport information, see the data type definition under getHomeServer for additional information

ServiceVersion

Integer

Versioning tag for the service

ServiceFeatures

ArrayofFeatureData

Array of 0 or more feature data elements

FeatureData

Type

Description

FeatureName

String

The name of the feature supported

FeatureVersion

Integer

Optional versioning tag for the feature

FeatureValue

String

Optional value for a feature

FNUFeature

Type

Description

FNUType

String

See getButtonAssignments

App

Boolean


Media

Boolean


FNUInfo

Array of FNUData

See FNU Description in getButtonAssignments

Issue 1 August 2006

125


Example client request: [email protected]

Example PPM Response: conference-server sip:confsrv @avaya.com 1 size 1 6 …




Description

“DatabaseError”

If there was a problem with the database

sendCommand sendCommand is used for triggering an event to the end point. DevConnect members should not use the sendCommand operation until the end of a series of other SOAP requests. For example, if multiple updateContact requests are executed, the sendCommand request should be sent after all other requests. This is an expensive operation, a nd the over-use of this operation will affect performance of the system. Performance Constraint: Customers must implement a limit of 1 request per high level

transaction. sendCommand(uList, cmd) Parameter

Type

Value

Description

uList

Array

Array of Strings

An array containing one entry, the user’s handle

cmd

EndptCmd

Complex type

EndptCmd

Type

Value

Description

cmd

String

Command name

Customer should usually use ReloadProfile

eventcode

Integer

Param. value

Always set to 1

Issue 1 August 2006

127

PPM-in-SES

Recommend Documents