Skip to content

Commit

Permalink
Merge branch 'master' of github.com:RestComm/Restcomm-Connect
Browse files Browse the repository at this point in the history
  • Loading branch information
gvagenas committed Oct 14, 2016
2 parents 42aec95 + 7d2740c commit f78cb23
Show file tree
Hide file tree
Showing 25 changed files with 147 additions and 1 deletion.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -1,21 +1,25 @@
= Restcomm SDKs

Restcomm comes with three powerful WebRTC SDKs that allows you to embed Communications as a feature in your Web, iOS and Android Native Applications.
Restcomm comes with three powerful WebRTC SDKs that allow you to embed Communications as a feature in your Web, iOS and Android Native Applications. Moreover, there's Olympus, a full fledged Client that take advantage of the respective Restcomm SDKs and provides webrtc video/audio calling and messaging capabilities on each of Web, iOS and Android platforms out of the box.

Web SDK
~~~~~~~

* <<restcomm-client-web-sdk-quick-start.adoc#web-sdk-guide,Restcomm Web SDK Quick Start Guide>>
* link:http://documentation.telestax.com/restcomm-web-sdk/doc/[Restcomm Web SDK Reference Documentation]
* <<restcomm-web-olympus-user-guide.adoc#web-olympus-guide,Restcomm Web Olympus App User Guide>>
iOS SDK
~~~~~~~

* <<restcomm-client-ios-sdk-quick-start.adoc#ios-sdk-guide,Restcomm iOS SDK Quick Start Guide>>
* link:http://documentation.telestax.com/restcomm-ios-sdk/doc/html/[Restcomm iOS SDK Reference Documentation]
* <<restcomm-ios-olympus-user-guide.adoc#ios-olympus-guide,Restcomm iOS Olympus App User Guide>>
Android SDK
~~~~~~~~~~~

* <<restcomm-client-android-sdk-quick-start.adoc#android-sdk-guide,Restcomm Android SDK Quick Start Guide>>
* link:http://documentation.telestax.com/restcomm-android-sdk/doc/[Restcomm Android SDK Reference Documentation]
* <<restcomm-android-olympus-user-guide.adoc#android-olympus-guide,Restcomm Android Olympus App User Guide>>
@@ -0,0 +1,53 @@
The Restcomm Android SDK comes with Olympus Client Android App that taps into the SDK and presents to the user a full fledged application capable of video/audio WebRTC calls and text messages. If we add Restcomm Platform to the mix, we get full telecom programmability and access to PSTN/SMS. Let's see how this works.

You can get the latest version of Android Olympus .apk from the link found https://github.com/RestComm/restcomm-android-sdk#latest-olympus-apk[here]. For the TADHack event you will also need to register for a new account https://accounts.restcomm.com/tadhackRegistration.jsp[here] and follow along the registration process until you get your password via email.

Then you need to launch the Olympus Android App and use the user part of your email and the password you received in the first, wizard screen. Also, you will need to change domain to tadhack.restcomm.com and tap Done:

image:./images/android-olympus-signup.png[android-olympus-signup]

Once you login, you can call any of the default contacts, be it a Restcomm Application, like +1235 or another client like Bob who needs to be registered from another Olympus or generic SIP client. Here's the contacts screen:

image:./images/android-olympus-contacts.png[android-olympus-contacts]

[[calling-a-restcomm-application]]
Calling a Restcomm Application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let's first try an audio call towards Restcomm Application +1235 that uses Text-to-Speech to greet you with and audio message.

* Tap on the 'Say App' and on the new screen that opens tap on the Audio Call icon on the upper right corner:
image:./images/android-olympus-calling-restcomm-app-1.png[android-olympus-calling-restcomm-app]

* You should then see the call screen and hear the message:
image:./images/android-olympus-calling-restcomm-app-2.png[android-olympus-calling-restcomm-app]

[[calling-another-restcomm-client]]
Calling another Restcomm Client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now let's try a Client to Client video call.

* Back in the Contacts screen tap on the plus sign on the lower right corner to create a new contact, add the client's details and tap Add:
image:./images/android-olympus-add-contact.png[android-olympus-add-contact]

* Tap on the new contact and when the message screen comes up tap on the Video Call icon on the upper right corner so that a video call is made to that contact:
image:./images/android-olympus-calling-olympus-1.png[android-olympus-calling-olympus]

* Remember that the called client (in my case Despina) needs to be registered from another device. Once you answer from the called client you should see something like this:
image:./images/android-olympus-calling-olympus-2.jpg[android-olympus-calling-olympus]

[[sending-a-text-message-to-another-restcomm-client]]
Sending a text message to another Restcomm Client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let's send a text message from Olympus to another client. Back to Contacts screen tap on the little (i) icon on the right of the peer you want to message (in my case Despina). On the new screen that opens tap on the Message and then write a message and tap Send:

image:./images/android-olympus-texting-olympus.png[android-olympus-texting-olympus]

That's about it. By taking further advantage of Restcomm's Apps capabilities you can now add a wealth of features in your flow, be it IVR, Conferencing, etc.
@@ -0,0 +1,43 @@
The Restcomm iOS SDK comes with Olympus Client iOS App that taps into the SDK and presents to the user a full fledged application capable of video/audio WebRTC calls and text messages. If we add Restcomm Platform to the mix, we get full telecom programmability and access to PSTN/SMS. Let's see how this works.

You can get the latest version of iOS Olympus .ipa from the link found https://github.com/RestComm/restcomm-ios-sdk#latest-olympus-ipa[here]. For the TADHack event you will also need to register for a new account https://accounts.restcomm.com/tadhackRegistration.jsp[here] and follow along the registration process until you get your password via email.

Before you launch the App you need to trust Telestax Inc. on your iOS device by following this https://support.apple.com/en-us/HT204460[Apple Guide]. Then you need to launch the Olympus iOS App and use the user part of your email and the password you received in the first, wizard screen. Also, you will need to change domain to tadhack.restcomm.com and tap Done:

image:./images/ios-olympus-signup.png[ios-olympus-signup]

Once you login, you can call any of the default contacts, be it a Restcomm Application, like +1235 or another client like Bob who needs to be registered from another Olympus or generic SIP client. Here's the contacts screen:

image:./images/ios-olympus-contacts.png[ios-olympus-contacts]

[[calling-a-restcomm-application]]
Calling a Restcomm Application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let's first try an audio call towards Restcomm Application +1235 that uses Text-to-Speech to greet you with and audio message. Tap on the little (i) icon on the right of the 'Say App' and on the new screen that opens tap on the Audio Call:

image:./images/ios-olympus-calling-restcomm-app.png[ios-olympus-calling-restcomm-app]

[[calling-another-restcomm-client]]
Calling another Restcomm Client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now let's try a Client to Client video call.

* Back in the Contacts screen tap on the plus sign on the top right corner to create a new contact, add the client's details and tap Done:
image:./images/ios-olympus-add-contact.png[ios-olympus-add-contact]

* Tap on the new contact (not on the (i) icon but anywhere else) so that a video call is made to that contact. Remember that the called client (in my case Despina) needs to be registered from another device. Once you answser from the called client you should see something like this:
image:./images/ios-olympus-calling-olympus.jpg[ios-olympus-calling-olympus]

[[sending-a-text-message-to-another-restcomm-client]]
Sending a text message to another Restcomm Client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let's send a text message from Olympus to another client. Back to Contacts screen tap on the little (i) icon on the right of the peer you want to message (in my case Despina). On the new screen that opens tap on the Message and then write a message and tap Send:

image:./images/ios-olympus-texting-olympus.png[ios-olympus-texting-olympus]

That's about it. By taking further advantage of Restcomm's Apps capabilities you can now add a wealth of features in your flow, be it IVR, Conferencing, etc.
@@ -0,0 +1,46 @@
The Restcomm Web SDK comes with Olympus Client Web App that taps into the SDK and presents to the user a full fledged application capable of video/audio WebRTC calls and text messages. If we add Restcomm Platform to the mix, we get full telecom programmability and access to PSTN/SMS. Let's see how this works.

You can use the latest version of Web Olympus by first registering for a new account https://accounts.restcomm.com/tadhackRegistration.jsp[here] and following along the registration process until you get your password via email. Then you can login to Olympus by using the user part of your email and the password you received.

Once you login, you can use the Contacts menu on the left to call any of the default contacts, be it a Restcomm Application, like +1235 or another client like Bob who needs to be registered from another Olympus or generic SIP client.

[[calling-a-restcomm-application]]
Calling a Restcomm Application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let's first try an audio call towards Restcomm Application +1235 that uses Text-to-Speech to greet you:

image:./images/olympus-calling-restcomm-app.jpg[olympus-calling-restcomm-app]

[[calling-another-restcomm-client]]
Calling another Restcomm Client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now let's try a Client to Client video call. In the screenshots below Bob is calling Alice.

* Click on Contact icon, then Alice and finally do a video call as can be seen below:
image:./images/olympus-calling-olympus-1.jpg[olympus-calling-olympus]

* At that point, Olympus will start to ring in Alice’s window:
image:./images/olympus-calling-olympus-2.jpg[olympus-calling-olympus]

* Pick up from Alice tab and you are ready to talk (I'm calling myself which admittedly isn't very productive, but just to get an idea):
image:./images/olympus-calling-olympus-3.jpg[olympus-calling-olympus]

[[sending-a-text-message-to-another-restcomm-client]]
Sending a text message to another Restcomm Client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Click on the Contacts icon, then Alice and finally send a text message as can be seen below:

image:./images/olympus-texting-olympus-1.jpg[olympus-texting-olympus]

On the new text window that comes up write a text message and hit send. Go to the other client's window to see the incoming message and do the same to reply

image:./images/olympus-texting-olympus-2.jpg[olympus-texting-olympus]

That's about it. By taking further advantage of Restcomm's Apps capabilities you can now add a wealth of features in your flow, be it IVR, Conferencing, etc.

0 comments on commit f78cb23

Please sign in to comment.