com.ibm.soa.parlayx21.audio_call
Interface AudioCall

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
AudioCall_RI
All Known Implementing Classes:
AudioCallBindingStub, AudioCallProxy

public interface AudioCall
extends java.rmi.Remote

The AudioCall interface allows the playing of audio messages using different forms of audio content, and operations to monitor or cancel requests.

In all operations, the address is restricted to the use of 'tel:' and 'sip:' URIs as specified in ES 202 391-1 [2], and wildcards are not permitted in these URIs.


Method Summary
 MessageStatus endMessage(java.lang.String correlator)
          The invocation of endMessage cancels/stops a previous request identified by correlator.
 MessageStatus getMessageStatus(java.lang.String correlator)
          The invocation of getMessageStatus retrieves the current status, result, of a previous request identified by correlator.
 java.lang.String playAudioMessage(java.net.URI address, java.net.URI audioUrl, ChargingInformation charging)
          The invocation of playAudioMessage requests to set up a call to the user identified by address and play an audio file located at audioUrl.
 java.lang.String playTextMessage(java.net.URI address, java.lang.String text, java.lang.String language, ChargingInformation charging)
          The invocation of playTextMessage requests to set up a call to the user identified by address and play a text identified by text.
 java.lang.String playVoiceXmlMessage(java.net.URI address, java.net.URI voiceXmlUrl, ChargingInformation charging)
          The invocation of playVoiceXmlMessage requests to set up a call to the user identified by address and process VoiceXML content located at voiceXmlUrl.
 

Method Detail

playTextMessage

java.lang.String playTextMessage(java.net.URI address,
                                 java.lang.String text,
                                 java.lang.String language,
                                 ChargingInformation charging)
                                 throws java.rmi.RemoteException,
                                        PolicyException,
                                        ServiceException

The invocation of playTextMessage requests to set up a call to the user identified by address and play a text identified by text. The text will be read through a Text-to-Speech engine, according to the specified language. The invocation returns as soon as the request is received by the system, for example, the actual call is performed asynchronously. The correlator, returned by the invocation, can be used to identify the request, for example, to get information on the request status.

This operation is intended to play a message to a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0002: Privacy error.
  * POL0006: Groups not allowed.
  * POL0008: Charging not supported.

Parameters:
address - xsd:anyURI Address to which message is to be played
text - xsd:string Text to process with a Text-To-Speech engine
language - xsd:string Language of text (ISO string)
charging - common:Charging Information Charge to apply for the playing of this message. If charging is not supported then a PolicyException (POL0008) will be returned
Returns:
correlatorresult xsd:string Correlator for this message for subsequent interactions
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

playAudioMessage

java.lang.String playAudioMessage(java.net.URI address,
                                  java.net.URI audioUrl,
                                  ChargingInformation charging)
                                  throws java.rmi.RemoteException,
                                         PolicyException,
                                         ServiceException

The invocation of playAudioMessage requests to set up a call to the user identified by address and play an audio file located at audioUrl. The invocation returns as soon as the request is received by the system, for examlpe, the actual call is performed asynchronously. The correlator, returned by the invocation, can be used to identify the request, for example, to get information on the request status.

This operation is intended to play a message to a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0002: Privacy error.
  * POL0006: Groups not allowed.
  * POL0008: Charging not supported.

Parameters:
address - xsd:anyURI Address to which message is to be played
audioUrl - xsd:anyURI Location of audio content to play
charging - common:Charging Information Charge to apply for the playing of this message. If charging is not supported then a PolicyException (POL0008) will be returned
Returns:
correlatorresult xsd:string Correlator for this message for subsequent interactions
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

playVoiceXmlMessage

java.lang.String playVoiceXmlMessage(java.net.URI address,
                                     java.net.URI voiceXmlUrl,
                                     ChargingInformation charging)
                                     throws java.rmi.RemoteException,
                                            PolicyException,
                                            ServiceException

The invocation of playVoiceXmlMessage requests to set up a call to the user identified by address and process VoiceXML content located at voiceXmlUrl. The invocation returns as soon as the request is received by the system, for example, the actual call is performed asynchronously. The correlator, returned by the invocation, can be used to identify the request, for example, to get information on the request status.

This operation is intended to play a message to a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0002: Privacy error.
  * POL0006: Groups not allowed.
  * POL0008: Charging not supported.

Parameters:
address - xsd:anyURI Address to which message is to be played
voiceXmlUrl - xsd:anyURI Location of VoiceXML content to process
charging - common:Charging Information Charge to apply for the playing of this message. If charging is not supported then a PolicyException (POL0008) will be returned
Returns:
correlatorresult xsd:string Correlator for this message for subsequent interactions
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getMessageStatus

MessageStatus getMessageStatus(java.lang.String correlator)
                               throws java.rmi.RemoteException,
                                      PolicyException,
                                      ServiceException

The invocation of getMessageStatus retrieves the current status, result, of a previous request identified by correlator.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
correlator - xsd:string Correlator returned from play operation to check
Returns:
result MessageStatus Current playing status
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

endMessage

MessageStatus endMessage(java.lang.String correlator)
                         throws java.rmi.RemoteException,
                                PolicyException,
                                ServiceException

The invocation of endMessage cancels/stops a previous request identified by correlator. It returns a result, with the status of the request at the moment of abort.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Parameters:
correlator - xsd:string Correlator returned from play operation to cancel
Returns:
result MessageStatus Status at the time the endMessage was acted on
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.