| APIs |
| Categories: User Guide Ch2: Audium Components in Detail |
| Article ID: | 158 |
| Last updated: | January 12, 2007 |
| User Opinions |
|
No users have voted.
|
|
Thank you for rating this answer.
|
SUMMARY
This article describes the APIs that are provided to developers of Audium applications.
SYMPTOMS
N/A
RESOLUTION
To facilitate the development of components requiring programming effort, Audium provides two application programming interfaces (APIs) for developers to use. The first is a Java API. The second API involves the use of XML sent via HTTP, thereby allowing components to be built using programming languages other than Java. Some more complex and tightly integrated components can be built only through the Java API, though in all other aspects, the two APIs are functionally identical. The APIs themselves and the process of building components using either API is fully detailed in the Javadocs published with the software and in the Programmer Guide. The two components that do not require the use of high-level programming, XML decisions and VoiceXML insert elements, are fully explained in this document.
The APIs are used to interface with Audium Call Services in order to retrieve data or change information. The API provided to each component has slightly different functionality reflecting each component’s unique abilities. The following lists abilities provided by the API that is common to most components:
-
Getting call information such as the ANI, DNIS, call start time, application name, etc.
- Getting or setting element data or session data (element data can only be set by elements).
- Getting information about the application’s settings such as the default audio path, logging level, voice browser, etc.
- Setting the maintainer and default audio path. Changing the maintainer allows multiple people to maintain different parts of a single application. Changing the default audio path allows an application to change the persona or even language of the audio at any time during the call.
- Adding custom content to the activity log (see Chapter 5: Call Services Logging for more on logging with Audium Call Services).
The following table shows which API can be used to construct the various components listed and the functionality available within that component.
|
Audium Call Services Component |
Build With Java API |
Build Using XML-over-HTTP API |
VoiceXML Knowledge Suggested |
Get / Set Element and Session Data |
|
Configurable Action and Decision Elements |
Yes |
No |
No |
Yes |
|
Configurable Voice Elements |
Yes |
No |
Yes |
Yes |
|
Generic Action and Decision Elements |
Yes |
Yes |
No |
Yes |
|
Dynamic Element Configurations |
Yes |
Yes |
No |
Yes |
|
Start or End of Call Action |
Yes |
Yes |
No |
Session Data Only |
|
On Error Notification |
Yes |
No |
No |
No |
|
Hotevents |
Yes |
No |
Yes |
No |
|
Say It Smart Plugins |
Yes |
No |
No |
No |
|
XML Decisions |
NA |
NA |
NA |
Get Only |
|
VoiceXML Insert Elements |
NA |
NA |
Yes |
Yes |
|
| Visitor Comments |
|
No visitor comments posted. Post a comment
|
| Related Questions |
|
No related questions were found.
|
| Attachments |
|
No attachments were found.
|
Search the Knowledgebase
Jump to ID
Browse by Category
Print this page
Post a comment