TeleStax.orgCommunity Documentation

RestComm User Guide

The Guide to the RestComm

Jean Deruelle

Thomas Quintana

Charles Roufay

George Vagenas

Copyright © 2011 Telestax, Inc

Abstract

RestComm is a carrier-grade open source platform that provides developers the tools to integrate fax, voice, and SMS functionality in to their own applications with ease. RestComm is designed to have 100% compatibility with Twilio's APIs allowing easy porting between platforms. Furthermore, the RestComm platform is built on top of the industry leading Mobicents Sip Servlet Container and Mobicents Media Server providing the robustness and performance these platforms are already known to deliver.

Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
1. Introduction to RestComm
1.1. How it Works
2. Getting Started and General Configuration
2.1. Quick Start Guide
2.2. Login into Restcomm and Changing the Default Password
2.3. Testing the Demo Applications
2.3.1. Demo 1 - Testing the Play Verb
2.3.2. Detailed Configuration
2.3.3. Runtime Settings
2.3.4. VoIP Innovations Restful API Access
2.3.5. Dao Manager
2.3.6. Media Server Manager
2.3.7. SMS Aggregator
2.3.8. Fax Service
2.3.9. Speech Recognizer
2.3.10. Speech Synthesizer
3. RestComm Markup Language
3.1. RestComm Request
3.2. Your Response
3.3. Say
3.4. Play
3.5. Gather
3.6. Record
3.7. Fax
3.8. Sms
3.9. Dial
3.9.1. Number
3.9.2. Client
3.9.3. Conference
3.9.4. Sip
3.10. Hangup
3.11. Redirect
3.12. Reject
3.13. Pause
3.14. UssdCollect
3.14.1. UssdMessage
3.14.2. Language
4. Restful APIs
4.1. Accounts
4.1.1. Supported Operations
4.1.2. Account List Resource
4.2. AvailablePhoneNumbers
4.2.1. Supported Operations
4.3. Gateways
4.3.1. Supported Operations
4.3.2. Examples
4.4. Clients
4.4.1. Supported Operations
4.4.2. Client List Resource
4.5. IncomingPhoneNumbers
4.5.1. Supported Operations
4.5.2. IncomingPhoneNumber List Resource
4.6. Calls
4.6.1. Supported Operations
4.6.2. Call List Resource
4.6.3. Supported Operations
4.6.4. REST API: Modifying Live Calls
4.6.5. List Filter
4.6.6. Paging Information
4.7. SMS Messages
4.7.1. Supported Operations
4.7.2. SMS Message List Resource
4.8. Recordings
4.8.1. Supported Operations
4.8.2. Recording List Resource
4.9. Transcriptions
4.9.1. Supported Operations
4.9.2. Transcription List Resource
4.10. Notifications
4.10.1. Supported Operations
4.10.2. Notification List Resource
4.11. OutboundProxy
4.11.1. Supported Operations
4.12. OutboundProxy
4.12.1. Supported Operations
4.13. UssdPush
4.13.1. Supported Operations
5. Restcomm Admin User Interface
5.1. Login Interface
5.2. Passwords, Sub Accounts Settings
5.3. Dashboard
5.4. Restcomm Numbers
5.4.1. Register Number
5.4.2. Edit Update Number
5.5. SIP Clients
5.6. Outgoing CallerId
5.7. Logs
5.7.1. Logs - Calls
5.7.2. Logs - Messages
5.7.3. Logs - Recordings
5.7.4. Logs - Transcriptions
5.7.5. Logs - Notifications
6. Restcomm Visual Designer
6.1. Getting Started
6.2. Voice Projects
6.3. USSD Projects
6.4. SMS Projects
6.5. Demo Application
7. Advanced RestComm Examples
7.1. Activating Text-to-Speech (TTS)
7.1.1. Say Verb
7.1.2. Record Verb
7.1.3. Dial Verb and Client
7.1.4. Dial Verb and Uri
7.1.5. Dial Verb and Conference
7.1.6. Gather Verb