|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AudioCall
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 |
---|
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.
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.
address
- xsd:anyURI
Address to which message is to be playedtext
- xsd:string
Text to process with a Text-To-Speech enginelanguage
- 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
java.rmi.RemoteException
PolicyException
ServiceException
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.
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.
address
- xsd:anyURI
Address to which message is to be playedaudioUrl
- xsd:anyURI
Location of audio content to playcharging
- common:Charging
Information
Charge to apply for the playing of this message. If charging is not supported then a PolicyException (POL0008) will be returned
java.rmi.RemoteException
PolicyException
ServiceException
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.
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.
address
- xsd:anyURI
Address to which message is to be playedvoiceXmlUrl
- xsd:anyURI
Location of VoiceXML content to processcharging
- common:Charging
Information
Charge to apply for the playing of this message. If charging is not supported then a PolicyException (POL0008) will be returned
java.rmi.RemoteException
PolicyException
ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
correlator
- xsd:string
Correlator returned from play operation to check
java.rmi.RemoteException
PolicyException
ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
correlator
- xsd:string
Correlator returned from play operation to cancel
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |