Conference

Disclaimer

This document is a prelimary version and work-in-progress,
Details discussed in this document will be subject to future modifications.

Obtaining Conference Line

In order to record conversation of all participants of a conference call, this requires that all participants call a dedicated conference phone number on the PBX S2T (SpeechToText).
This specification explains the main steps: obtaining a dedicated conference call, the workfow to record and transcribe a conference call.

To setup a dedicated conference number, it involves following workflow from PhoneApp through Delos instance up to the PBX:

1. PhoneApp will request a new dedicated Conference Line by querying Delos instance /Phone_ObtainConfLine with optional telco region (1, 2, 3, 4, 5, 9)
2. Hosting server will query /ASP_ObtainConfLine to request on Regional server fr1.buzzee.tel managing the pool of conference numbers for this region.
The Regional server will assign and provide a dedicated phone number (33912345678) and assign this line to the user identified by the Phone number (now the user identified as 33612345678 will also be identified by querying ASP_GetUserFromPhone with the Conference line number 33912345678).
Hosting server will record this Conference Line (33912345678) associated on the user account hosted at fr01a.buzzee.tel.
Line
Finally, Delos will return the Line to the original request /Phone_ObtainConfLine.

HTTP Authorization and Protocol

Authorization between Phone application (PhoneApp) and Delos instance of the user requires XMLC_Credential, a token value encoding XMLC_UserID + XMLC_Session.
All HTTP requests targeting Delos instance from the Phone application will be considered in this specification formatted as: 
https://a201.buzzee.tel/JSON/1xxx1abcdef/Phone_ObtainConfLine
where 1xxx1abcdef is the XMLC_Credential encoding XMLC_UserID+XMLC_Session
This credential is obtained after initial registration

Authorization between ConfBridge S2T PBX and Delos instance (and vice-versa) is managed using ByPass IP address on a range of addresses.

Audio File Format

PBX ConfBridge server is providing a merged/mixed MP3 file of all the audio channels of each participant.

/Phone_ObtainConfLine (PhoneApp -> Delos)

The PhoneApp will request a new dedicated Conference Line by querying Delos instance /Phone_ObtainConfLine with optional region (1, 2, 3, 4, 5, 9)
PhoneApp sends a HTTP GET request to Delos instance:

https://a201.buzzee.tel/JSON/1xxx1abcdef/Phone_ObtainConfLine?Prefix=9

Delos instance will respond with a JSON document:

{ "Line" : "33912345678" }

The major fields are:

The following table summarizes the different error codes:

/ASP_ObtainConfLine (Host server -> Regional server)

Delos instance will forward request to Connect server to obtain dedicated Conference Line by querying Delos instance /ASP_ObtainConfLine with optional region (1, 2, 3, 4, 5, 9)
Delos sends a HTTP GET request to Connect instance:

https://connect1.buzzee.tel/Delos/ASP_ObtainConfLine?Phone=33612345678&Prefix=9&XMLC_OutputFormat=XML

Delos instance will respond with a XML document:

33912345678

The major field is:

The following table summarizes the different error codes:

Workflow of conference call transcription

When a participant calls the conference line number, ConfBridge S2T will need to lookup options for this specific Conference Line number.

The workflow of conference call being recorded and transcribed is:

1. At the end of each conference ConfBridge PBX invokes the regional server to the registered WebHook URL http://fr1.buzzee.tel/JSON/PBX_ConfBridgeEnd?Line=33912345678&FileID=123456 passing through the main parameters of Conference Line ID and the Unique File ID for this conference audio recording.
The regional server will respond with a URL of a WebHook to be invoked by the ConfBridge server
2. ConfBridge PBX invokes the WebHook URL /Phone_ConfBridgeEnd returned by the Regional server to inform the hosting server of the user that a Conference has been terminated with all the participants infos, and duration.
3. Delos instance invokes the ConfBridge server endpoint API /ConfBridge_Transcribe to initiate a transcription of the conference audio file with the Callback URL to be invoked once the job will be completed. The ConfBridge PBX enqueue as Async the request, and return a Status OK.
4. Once the transcription job has been completed, the ConfBridge PBX invokes the WebHook URL /Phone_ConfBridgeTranscript passed as CallbackURL with the transcription with the details of participants.
5. Delos invokes /DownloadAudioFile from the ConfBridge PBX server the MP3 merged and mixed with all infividual channel audio files.
6. Delos invokes ConfBridge server /DeleteAudioFile to delete the resources associated for this conference session

/PBX_ConfBridgeEnd (ConfBridge PBX -> Regional server)

At the end of each conference, ConfBridge PBX invokes the WebHook registered for the regional host passing through the main parameters of Conference Line ID and the Unique File ID for this conference audio recording:

http://fr1.buzzee.tel/JSON/PBX_ConfBridgeEnd?Line=33912345678&FileID=123456

The table below describes the main parameters of the request:

The response contains a WebHook URL to be invoked by the ConfBridge server to inform the hosting server of the user with all the participants infos, and duration:

{ "URL": "http://fr01a.buzzee.tel/JSON​/Phone_ConfBridgeEnd?XMLC_User_ID=1000001&
          Line=33912345678&FileID=123456" }

The table below describes the main field of the response :

If the ConfBridge Line is not registered on this regional server, Delos will respond with status 404 Not Found

{"Code": "ERR_USER_NOT_FOUND", "Message": "TXMLInstruction.Process - Operation=Assert Name=CheckCPSN_ID"}

/Phone_ConfBridgeEnd (ConfBridge PBX -> Delos host server)

ConfBridge PBX invokes the WebHook URL returned by the Regional server on initial request to inform the hosting server of the user that a Conference has been terminated with all the participants infos, and duration. 

http://fr01a.buzzee.tel/JSON​/Phone_ConfBridgeEnd?XMLC_User_ID=1000001&Line=33912345678&FileID=123456

The request body contains all the details of the conference recording and the participants infos:

{ "Line": "33912345678", "FileID": "123456"
  "StartDate": "2025-08-11 11:22:33", "EndDate": "2025-08-11 12:22:33",
  "Duration": "3600",
  "Participants": { "Participant" : [ 
                        { "ID": "1", "Phone": "33123456789", 
                          "Join": "11:22:33", "Leave": "12:22:33", "Duration": "3600" },
                        { "ID": "2", "Phone": "33234567890" },
                          "Join": "11:33:44", "Leave": "11:43:44", "Duration": "600" }, 
                        ...
                     ] 
                   }
}

The table below describes the different fields of the request URL:

The table below describes the different fields of the request payload:

Delos Instance will respond with Status OK and the WMSG_ID corresponding to this new conference call:

{ "Status": "OK", "WMSG_ID": "1001002" }

The table below describes the different fields of the response:

/ConfBridge_Transcribe (Delos -> ConfBridge PBX)

To request the transcription of a conference call, Delos will send a HTTP POST request to ConfBridge PBX 

http://frconf.buzzee.tel/ConfBridge_Transcribe
Line=33912345678
FileID=123456
CallbackURL=http://fr01a.buzzee.tel/JSON/Phone_ConfBridgeTranscript?XMLC_UserID=100001&WMSG_ID=1000002

ConfBridge PBX server will respond with Status=Queued:

{ "Status": "Queued" } 

/Phone_ConfBridgeTranscript (ConfBridge PBX -> Delos)

Once the transcription has been completed, ConfBridge PBX server will POST to the WebHook registered as the Callback URL:

http://fr01a.buzzee.tel/JSON/Phone_ConfBridgeTranscript?XMLC_UserID=1000001&WMSG_ID=1001002

the JSON request content POSTed contains the sentences per participants of the transcription assembled:

{ "Line": "33912345678", "FileID": "123456"
  ... 
  "Sequences": { "Sequence" : [ 
                        { "ID": "00:00:00.000", "Participant": "1", "Phone": "33123456789",
                          "Text": "Welcome all to this confcall", "Duration": "5" },
                        { "ID": "00:00:05.000", "Participant": "2", "Phone": "33234567890",
                          "Text": "Thank you for the invitation", "Duration": "2" },
                        ...
                     ] 
                   }
}

The table below describes the different fields of the request URL:

The table below describes the different fields of the request payload:

Delos instance will respond to the invocation of this CallBack WebHook URL with Status=OK:

{ "Status": "OK" } 

/DownloadAudioFile (Delos -> ConfBridge PBX)

Delos instance will download the audio file recorded for this conference call by sending a HTTP GET request to ConfBridge PBX 

http://frconf.buzzee.tel/DownloadAudioFile?Line=33912345678&FileID=123456

ConfBridge PBX server will stream the MP3 file of this conference call mixed/merged of all audio stream channel of each participant.

/DeleteAudioFile (Delos -> ConfBridge PBX)

Once all previous informations have been collected, Delos instance will inform the ConfBridge PBX server to delete the resources associated with this confcall by sending a HTTP GET

http://frconf.buzzee.tel/DeleteAudioFile?Line=33912345678FileID=123456

ConfBridge PBX server will respond with Status=OK:

{ "Status": "OK" }