This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Added README documentation on external service expectations, and ini …

…modifications required.
  • Loading branch information...
mjheilmann committed Mar 7, 2017
1 parent 23a0d5a commit 86887f0aea8d38b14c8d7726bf1a711745e825a0
Showing with 35 additions and 0 deletions.
  1. +35 −0 MOSES/FreeswitchVoice/README.txt
@@ -0,0 +1,35 @@
MOSES Freeswitch Module
This module is a replacement for the Halcyon Freeswitch voice module, which was in disrepair. This has the following features:
1 - It has been modified to behave identically to the Halcyon Vivox voice module.
2 - It uses an external application to hold account data, and to service both Freeswitch and client SLVoice.exe requests.
While this module is not currently fully featured, it is functional at this point to support voice traffic during office hours on the MOSES-Halcyon Grid.
This module requires the following Halcyon.ini Changes:
[FreeSwitchVoice]
enabled = "true"
account_service = "http://[ip]:[port]/fsapi"
The account_service field is an html endpoint on the external voice service. It supports the following:
GET / - performed by this module on startup
POST /freeswitch-config - performed by a configured Freeswitch installation
GET /getAccountInfo - used by this module to requisition a voice account with credentials
The Get / expects the following XML response from the external service:
<config>
<Realm>[freeswitch and external service public IP]</Realm>
<APIPrefix>[/url/to/client/endpoint]</APIPrefix>
</config>
This information is used to direct SLVoice.exe clients to login to the external service for voice functionality.
On the client facing API of the external service, it services the following requests OpenSimulator Freeswitch style:
POST /viv_get_prelogin.php
POST /viv_signin.php
Functionality beyond this is also beyond this module.

0 comments on commit 86887f0

Please sign in to comment.