Parlay X Services
Table of Contents:
- API Definitions
- Download WSDL Definitions
- How To Supply a Phone Number ( Dial Plan Formats )
- Tutorials
Parlay X API Definitions
Third Party Call Control V2 – TPCv2 allows for simple calls to be created between two communications end- points (e.g. softclients hosted in the Coral CEA Cloud). The service providing infrastructure in the Coral CEA Cloud creates the call by first calling the identified “originator”, and then upon answer, placing the call to the “terminating party”. TPCv2 provides the following operations:
- Make Call
- Get Call Information
- Cancel Call
- End Call
Third Party Call Control V3 – TPCv3 allows the creation of communications between multiple endpoints (e.g. softclients hosted in the Coral CEA Cloud). TPCv3 provides the following opera- tions:
- Make Call Session
- Add Call Participant
- Transfer Call Participant
- Delete Call Participant
- Get Call Participant Information
- Get Call Session Information
- End Call Session
Audio Call – Audio Call allows an application to play a pre-recorded message to participants in an ongoing call, and to monitor delivery of the audio message. Audio Call pro- vides the following operations:
- Play Audio Message
- Get Message Status
- End Message
Location Service – The Terminal Location Services allows an application to obtain information about the physical location of a user device. Additionally, since the root service does not actively poll for location, it also provides a mechanism for a client to set its loca- tion with the service. The Location Service provides the following operations:
- Get Location
- Get Terminal Distance
- Get Location for Group
- Publish Location
Download Parlay X WSDLs
The download link provided below contains all the WSDL definitions for the services listed above. Make sure to update the Service Endpoint definition to patch the Parlay X service IP Address and Port found on the System Access Page.
Download Parlay X SOAP Web Service Definitions ( WSDL )
How To Supply a Phone Number ( Dial Plan Formats )
While the Coral CEA APIs support a broad range of addressing capabilities, there is presently a restricted dial plan in place. Specifically, all addressing (for example, in the Third Party Call APIs) must use one of the following formats:
sip:9613[2-9]xxxxxx@[Parlay X Server IP Address]
Where 9 is a prefix digit for an outbound call, and • 613 represents the local Ottawa NPA (area code), and • [2-9]xxxxxx represents the Office Code and Station Code (e.g. 5207610)
sip:91[2-9]xx[2-9]xxxxxx@[Parlay X Server IP Address]
Where 9 is a prefix digit for an outbound call, and • 1 indicates a long distance call, outside the Ottawa area, and • [2-9]xx[2-9]xxxxxx represents the NPA, Office Code and Station Code (e.g. 5207610)
sip:xxxx@[Parlay X Server IP Address]
Where xxxx represents the four digit extension of a SIP client on the Coral CEA system.
Note: Make sure to replace [Parlay X Server IP Address] with the provided address found on the Systems Access Page.
Parlay X Tutorials
Provided below are a set of tutorials to get you on your way to developing with Parlay X Services.
SoapUI
The SoapUI tutorial example provided as a download below provides step by step instructions for invoking the TPCv3 service from the SoapUI Tool. Make sure you have downloaded all required WSDL definitions first.
Download SoapUI Parlay X Services Tutorial
Perl TPCv3 and Audio Call Tutorial
This quick little scripting tutorial will teach you how to invoke a Third Party Call V3 and play an audio file to the person on the other end.
Visit Perl TPCv3 and Audio Call Tutorial
.Net TPCv2 Client Tester
The following .Net source code example has been provided by Nortel. Although the code is the property of Nortel it may be used as reference when building applications.
Provided below is a downloadable .NET project which can be used to make calls against the ThirdParty Call V2 service.
The Source Code Package contains the following:
- A compiled application called ACETester.exe which allows a user to connect two parties, get call status, and end a call.
- The source code for the executable.
Download .Net TPCv3 Client Example
Third Party Call V3.0 Web Service – Java Tutorial
This Java tutorial will walk you though creating your first Parlay X Application. Leveraging TPCv3 you will be able to make a call between two phones from a basic UI.
Visit the TPCv3 Java Tutorial Now
Audio Call V3.0 Web Service – Java Tutorial
Building on the TPCv3 Java Tutorial we expand on the application to play a pre-recorded audio message to the called party.
Visit the Audio Call V3.0 Web Service – Java Tutorial