I am trying to make a conference Call.
How i can do that can you please give me a psuedo code.
COnsider i have made 3 participants already, Now i just need to connect all them together.
How can i do that?
Please help needed on urgent basis.

Yjank you

Unfortunately, the EDP Java API cannot be used to create a conference call. In 3.0, addParticipant() may only be used to add multiple alerting parties and cannot be used to add somebody to an established call. In our 3.1 release, additional uses of this method will be added, but it still will not enable multi-party conference.

We do have a feature coming out in 3.1 that enables conferences, but that requires the use of Application Enablement Services on the backend, with Communication Manager facilitating the conference.

Multi-party conference natively withing EDP using Avaya Aura Media Server is something that is on our roadmap but not yet part of a planned release.

I should have been a bit more precise. The "Call" API doesn't support the creation of conference calls. If a caller is calling into a conference bridge, it is possible to have a Call representing the call leg between an individual participant and the conference bridge. If the conference is a Scopia conference, a low-level XML API can then be used to add a participant to the Scopia conference. The Call API itself cannot directly be used to do this, however.

First of all, thank you for replying on the post.
:)

Can you please give me sample pseudo code to create conference using scopia low level xml API.
your help will be really appreciated.


Thank you.

Hi Joe,

Can you please give me sample code to schedule conference and add participant to that conference using SCOPIA XML API.
Require

Your help will be really appreciated.
looking forward to your earlier response.


Thank you.

I don't have any sample code to offer you, but I can provide some help. Check out the ScopiaRequest interface in our Javadoc. There you will find information on how to send Scopia XML requests. Below is the information on the particular request that you'll need to send. Hopefully this is enough to get you going.

Here is the relevant information from the Scopia XML reference.

Invite Participant
<Invite_Participant_Request> issues a command to the MCU to send out invitations to other
endpoints by dialing out to them, so they can join an existing videoconference. A single
<Invite_Participant_Request> can contain up to 20 participants to invite.
Important:
Scopia® Management passes this XML request to the correct physical MCU hosting the
videoconference.
The request has the following format:
<Invite_Participant_Request>
<RequestID> Request ID </RequestID>
<ConfGID> Conference global ID </ConfGID>
<ChairID> Chair ID </ChairID>
<Invite_Part_List>
<Invite_Part>
<DialStr> Participant alias </DialStr>
<PartName> Participant Name </PartName>
<DisplayName> String </DisplayName>
<ViaNode> Neighboring MCU Participant ID </ViaNode>
<PrefCallRate> UINT </PrefCallRate>
<InitVolume> Volume </InitVolume>
<ReferenceID> UINT </ReferenceID>
<Lang> Language </Lang>
<ProtocolType> Type </ProtocolType>
<UserInfo> String </UserInfo>
<Gucid> Global unique call identifier </Gucid>
<Set_In_Layout_List>
<Set_In_Layout_Params>
<LID> Layout ID </LID>
<LayoutType> Layout type </LayoutType>
<SbFrIndx> INT </SbFrIndx>
</Set_In_Layout_Params>
...
</Set_In_Layout_List>
<Set_Out_Layout_Params>
<LID> Layout ID </LID>
<LayoutType> Layout type </LayoutType>
<VideoOutputID> Output ID </VideoOutputID>
</Set_Out_Layout_Params>
<List_Of_Costs>
<Audio>
<AudioProfile> Audio Profile Type </AudioProfile>
<NumOfStreams> UINT32 </NumOfStreams>
</Audio>
<Video>
<VideoProfile> Video Profile Type </VideoProfile>
<PreferredVideoProfile> Video Profile Type </PreferredVideoProfile>
<NumOfStreams> UINT32 </NumOfStreams>
</Video>
<Data>
<DataProfile> Data Profile Type </DataProfile>
<NumOfStreams> UINT32 </NumOfStreams>
</Data>
<Presentation>
<PresentationProfile> Presentation Profile Type </PresentationProfile>
<NumOfStreams> UINT32 </NumOfStreams>
</Presentation>
<Encryption>
<EncryptionProfile> Encryption Profile Type </EncryptionProfile>
</Encryption>
</List_Of_Costs>
<Replaces>
<ReplacesCallID> String </ReplacesCallID>
<ReplacesFromTag> String </ReplacesFromTag>
<ReplacesToTag> String </ReplacesToTag>
</Replaces>
<LegId> Integer </LegId>
<Gucid> String </Gucid>
Reference Guide for Avaya Scopia® Management XML API Version
8.3
Issuing Commands ('Actions') to Scopia® Management | 121
<KeyFrameRate> Video Frame Rate Type </KeyFrameRate>
<Dial_out_timeout> Integer </Dial_out_timeout>
<AudioIsolationMode> Boolean </AudioIsolationMode>
<VideoIsolationMode> Boolean </VideoIsolationMode>
<UseEmptyInvite> Boolean </UseEmptyInvite>
<Recorder> Boolean </Recorder>
<ApplCallType> Appl Call Type </ApplCallType>
</Invite_Part>
...
</Invite_Part_List>
</Invite_Participant_Request>
Parameter Name Description
RequestID A unique 32-bit integer used to identify this request and match it with its response.
Use a random number generator to create this ID.
ConfGID The ID of the videoconference. For recurring videoconferences, it is the ID of the
generic meeting for all instances of this meeting.
ChairID Optional. A 24-character string used to verify the participant ID of the
videoconference moderator.
A moderator has special rights in a videoconference, including blocking the sound
and video of other participants, inviting new participants, disconnecting others,
determining video layouts, and closing meetings. In Scopia® Desktop Client, an
owner of a virtual room is the moderator when the room is protected by a PIN.
Without this protection, any participant can assume moderator rights.
InvitePartList Container for the list of participants to be invited to this videoconference.
Invite_Part Container for the details of a single participant to be invited to this videoconference.
DialStr The dial string of the participant. The system supports several formats:
• H.323 alias. For example, username.
• IP address of an H.323 endpoint. For example, 123.45.678.9.
• URI dialing for H.323 or SIP endpoints. For example, user@company.com
• E.164 dialing for H.323 or SIP endpoints. For example, 881234.
PartName String containing the name of the participant.
DisplayName Optional. String (maximum 128 characters) representing the name displayed on the
video window within the video layout. This is mapped to the standard H.323 display
name field.
ViaNode The participant ID of the cascaded MCU which is housing the participant.
PrefCallRate Optional. Unsigned 32-bit integer specifying the preferred bandwidth rate for
connecting this participant to the videoconference. Possible values are:
• -1 indicates to use the default videoconferencing settings for this participant.
• 0 indicates audio only for this participant.
• Enter a number in Mbps (up to a maximum of 2Mbps) to specify the
bandwidth for this participant.
InitVolume Value between -5 and 5 inclusive that indicates the initial volume of the incoming
audio channel. Default value is zero.
Lang For future use.
Reference Guide for Avaya Scopia® Management XML API Version
8.3
Issuing Commands ('Actions') to Scopia® Management | 122
Parameter Name Description
ProtocolType Indicates the protocol used by this participant's endpoint. Possible values are:
• None, the default value indicating that Scopia® Management automatically
selects the videoconference protocol.
• SIP
• H.323
UserInfo Optional string used for SIP invitation messages in a Microsoft environment
(maximum 128 characters).
Gucid Optional. Global unique call ID, automatically assigned to each H.323 and dial-in
participant's endpoint. A Gucid can also be assigned to each invited endpoint.
Solution components (such as Scopia® Management) use GUCID to trace the call.
It is parsed from signaling or sent by Scopia® Management to the invited
participant. Scopia® Management is responsible for generating one if it is missing
in signaling.
Set_In_Layout_List Optional. Container specifying the position of the participant image in a video
layout. You can configure positions of up to four layouts per videoconference.
Set_In_Layout_Params Container for a single position of the participant image in a video layout.
LID The ID of this video layout (Set Layout Params on page 175).
A video layout is the arrangement of participant images as they appear on the
monitor in a videoconference. If the meeting includes a presentation, a layout can
also refer to the arrangement of the presentation image together with the meeting
participants.
LayoutType The type of layout of this videoconference. Video is currently the only supported
value.
SbFrIndx
Set_Out_Layout_Params Container holding details of the MCU's output video layout displayed to the
participant.
VideoOutputID The ID of the video output sent to the participant.
Optional. If this value is empty, the MCU selects the output based on the
organization, meeting type and user settings.
List_Of_Costs Container of the list of resource profiles used, which determine the cost of the call
to the organization in terms of bandwidth and port usage.
NumOfStreams Not supported at this time.
AudioProfile The audio properties of this connection. Possible values are:
• Disabled indicates no audio, for example in a presentation-only connection.
• Enabled or Auto indicates the codec used by the videoconference.
• HighDensity includes existing codecs including AAC_LD, AAC_LC,
G7221C, Siren14, G7221, G722, G711A, G711U, G723, G729
• HighQuality is for future use.
Reference Guide for Avaya Scopia® Management XML API Version
8.3
Issuing Commands ('Actions') to Scopia® Management | 123
Parameter Name Description
VideoProfile The video capabilities of the connected endpoint. Possible values are:
• Disabled for audio only capabilities.
• SD indicates Standard Definition. For H.264 connections, use a maximum
resolution of 480p. For H.263 connections, use a maximum resolution of 4CIF
at 30 fps.
• HDCP indicates 720p at 30fps for both outbound and inbound traffic with
continuous presence.
• FullHDCP indicates full HD continuous presence, where:
– Both outbound and inbound traffic is at 720p at 60fps or 1080p at 30fps
(Scopia® Elite 6000 Series MCU only)
– The MCU receives 720p at 30fps from the endpoint, but sends 1080p at
30fps (Scopia® Elite 5000 Series MCU only)
• FullHDCPSymmetric (Scopia® Elite 5000 Series MCU only) for full HD
video at 720p at 60fps or 1080p at 30fps for both outbound and inbound
traffic.
• FullHDCPHighMotion (Scopia® Elite 6000 Series MCU only) for full HD
video at 1080p at 60fps for both outbound and inbound traffic.
• 3G indicates the invited endpoint is a 3G-324M-based mobile device.
• Unknown indicates to use the videoconference default, taking the maximum
resolution and maximum bit rate from the meeting settings.
DataProfile Not supported at this time.
PresentationProfile The presentation properties of this connection. Possible values are Disabled or
Enabled. A value of Unknown uses the default meeting type settings.
EncryptionProfile The encryption properties of this connection. Possible values are:
• None indicates no encryption.
• BestEffort indicates that it will support encryption if the remote endpoint
also supports it.
• Secured indicates that it will require encryption to make a successful
connection, otherwise the call will fail.
• Unknown indicates to use the default settings of the meeting type.
Replaces For SIP calls only. Contains data in the Replaces header of a SIP call, enabling a
participant to be replaced, like when transferring a call. The system matches the
incoming Call ID, To and From tags with the existing call to perform the
handover.
ReplacesCallID For SIP calls only. The Call ID in the SIP Replaces header to match the existing
call with a new call when a participant is replaced.
ReplacesFromTag For SIP calls only. The From tag in the SIP Replaces header to match the existing
call with a new call when a participant is replaced.
ReplacesToTag For SIP calls only. The To tag in the SIP Replaces header to match the existing call
with a new call when a participant is replaced.
Reference Guide for Avaya Scopia® Management XML API Version
8.3
Issuing Commands ('Actions') to Scopia® Management | 124
Parameter Name Description
LegId Optional. The ID of the call leg, the segment between the endpoint and the
gateway, MCU, or other device relaying the call. The ID remains valid for the
duration of the call and 10 minutes after the call is terminated. The default value is
zero.
Gucid Optional. Global unique call ID, automatically assigned to each H.323 and dial-in
participant's endpoint. A Gucid can also be assigned to each invited endpoint.
Solution components (such as Scopia® Management) use GUCID to trace the call.
It is parsed from signaling or sent by Scopia® Management to the invited
participant. Scopia® Management is responsible for generating one if it is missing
in signaling.
KeyFrameRate Optional. The minimum transmission rate for video key frames on this call leg,
measured in seconds. A key frame in video transmission forms the basis of derived
frames thereafter. Some recording or streaming devices do not request for regular
key frames. Possible values are: 1, 5, 7, 10, 15, 25, 30, 50 or 60.
Dial_out_timeout Optional. The number of seconds to wait for a response from the remote party
before the call is terminated. Default value: 600.
AudioIsolationMode BOOL indicating whether the microphone of this participant is muted.
VideoIsolationMode BOOL indicating whether the video camera of this participant is muted.
UseEmptyInvite BOOL determining whether this endpoint should send an empty invite message,
enabling others to determine the preferred audio and video channels of the
videoconference.
Recorder BOOL indicating whether this endpoint is a recorder. Default value is FALSE.
ApplCallType Indicates if this endpoint is a special application. Possible values are:
• None
• AudioIVR indicates the IVR is connecting to the meeting.
• VideoIVR indicates a video IVR, like the Auto-Attendant, is connecting to the
meeting.
• AudioCascaded
• VideoCascaded
• AudioRecorder
• VideoRecorder
• SecondaryCascaded
• AAC
The response has the following format:
<Invite_Participant_Response>
<RequestID> Request ID </RequestID>
<ConfGID> Conference global ID </ConfGID>
<ReturnValue> Return Value </ReturnValue>
</Invite_Participant_Response>
Reference Guide for Avaya Scopia® Management XML API Version
8.3
Issuing Commands ('Actions') to Scopia® Management | 125
Parameter Name Description
RequestID The 32-bit integer used to pair this response with its request.
ConfGID The ID of the videoconference. For recurring videoconferences, it is the ID of the
generic meeting for all instances of this meeting.
ReturnValue Possible values are:
• OK indicates the action was successful.
• ConferenceNotFound indicates no videoconference was found with the
given ID.
• NoPermission indicates the username is not authorized to perform this
action.
• BadOrMissingParameter indicates one of the parameters or its value was
mistyped, or it is missing.
• Error indicates an unknown error occurred.
• NoResources indicates there are no available resources to perform this
action.
• PartNotFound indicates the specified participant ID was not found.
• HandleInvalid indicates an ID value is not valid. Does not refer to global
IDs.
• NoAnswer indicates no answer from the remote endpoint.
• NeighborConfNotFound is for internal use only.
• MpcFailure indicates a media processor failure.
• UserTerminated indicates the conference creator cancelled the request.
• AudioNoMp indicates no audio media processors are available.
• VideoNoMp indicates no video media processors are available.
• DataNoMp indicates no presentation data media processors are available.
• AudioNoResc indicates no audio processing resources are available.
• VideoNoResources indicates no video processing resources are available.
• DataNoResources indicates no data collaboration resources are available.
• AudioTooManyPart indicates the number of audio participants cannot be
supported in the conference.
• VideoTooManyPart indicates the number of video participants cannot be
supported in the conference.
• DataTooManyPart indicates the number of data collaboration participants
cannot be supported in the conference.

Hi Joel,

I used your suggestion to use Scopia XML API.

However, after sending scopia request i am seeing following response.

Scopia Response : <?xml version="1.0" encoding="UTF-8"?>
<Communication_Error>
<Version>8.0</Version>
<RequestID>12345</RequestID>
<ReturnValue>GENERAL_COMMUNICATION_ERROR</ReturnValue>
</Communication_Error>


It would be great to know when typically scopia throws such a response.
I have reviewd the API Javadoc. I see API is expected to fail for "Ünknown request", "Format error" and "missing XML parameters".

As you will notice, we are seeing a different failure. Please let me know what may be going on.

Regards,

Swapnil

PS: Is the Reference guide for XML API 8.3 available on the DevConnect is it complete document? I see it should have 250+ pages but the copy on the devconnect seems to have only 55 or so. Can you please check that as well?

Hi Joel,

I tried to create conference and Add participants to conference using Scopia XML API.

However,
I have got the following error while scheduling and adding participants to the conference..

ConferenceUseCase INFO - ConferenceUseCase-1.0.0.0.0 - Scopia Response Create Conference :

<?xml version="1.0" encoding="UTF-8"?>
<MCU_XML_API><Version>8.0</Version>
<Response><Schedule_Conference_Response>
<RequestID>1700541069</RequestID>
<ReturnValue>OK</ReturnValue>
<Report>
<Success>false</Success>
<Detail>MemberId</Detail>
</Report>
</Schedule_Conference_Response></Response>
</MCU_XML_API>

2015-06-03 00:28:20,705 [WebContainer : 4] ConferenceUseCase INFO - ConferenceUseCase-1.0.0.0.0 - Scopia Response Invite Participants :
<?xml version="1.0" encoding="UTF-8"?>
<Communication_Error>
<Version>8.0</Version>
<RequestID>12345</RequestID>
<ReturnValue>GENERAL_COMMUNICATION_ERROR</ReturnValue>
</Communication_Error>


Cna you let me what is the issue.

I have attached the code used to create and add participants to the conference.

Looking forward to your earlier response.

Thank you.

Hi Joel,

SCOPIA XML API works till some sense.

I would like to know what value should be there in <ViaNode> </ViaNode> Attribute.

Because of this i am getting following response.

<?xml version="1.0" encoding="UTF-8"?>
<MCU_XML_API>
<Version>8.0</Version>
<Response>
<Invite_Participant_Response>
<RequestID> 12345 </RequestID>
<ConfGID>2312</ConfGID>
<Invite_Part_List>
<Invite_Part><PID></PID><DialStr>2300</DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part><Invite_Part><PID></PID><DialStr>2305</DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part><Invite_Part><PID></PID><DialStr>2304</DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part></Invite_Part_List>
<ReturnValue>OK</ReturnValue>
</Invite_Participant_Response>
</Response>
</MCU_XML_API>


Please find the attached code. Functioni am calling from Servlet is :
public void CreateCall(String MechNumber,String ElectNumber,String StoreNumber)

Need your help on Urgent Basis.

Thanks and Regards,
Swapnil.

Hi all,

I am trying to make a Three Party Conference Call.
I am creating Conference as follows.

SchedConf conference=SchedConfFactory.createConf();
conference.setDescription("Conference For Maintainance");
conference.setSubject("Conference For Maintainance");
conference.schedule();
logger.info("Conference Scheduled");


And after creating conference i am adding participants to it using Scopia XML API.
However, i am getting BadOrMissingParameters as a Reply.

Code as follows :


final String reqMSG="<MCU_XML_API> "+
"<Request> <Invite_Participant_Request>"+
"<RequestID> 12345 </RequestID>"+
"<ConfGID>"+conference.getConfId()+"</ConfGID>"+
"<Invite_Part_List>"+
"<Invite_Part>"+
"<DialStr>"+MechNumber+"</DialStr>"+
"<PartName> Mechanical </PartName>"+
"<PrefCallRate> 0 </PrefCallRate>"+
"<ProtocolType> SIP </ProtocolType>"+
"</Invite_Part>"+

"<Invite_Part>"+
"<DialStr>"+ElectNumber+"</DialStr>"+
"<PartName> Mechanical </PartName>"+
"<PrefCallRate> 0 </PrefCallRate>"+
"<ProtocolType> SIP </ProtocolType>"+
"</Invite_Part>"+

"<Invite_Part>"+
"<DialStr>"+StoreNumber+"</DialStr>"+
"<PartName> Mechanical </PartName>"+
"<PrefCallRate> 0 </PrefCallRate>"+
"<ProtocolType> SIP </ProtocolType>"+
"</Invite_Part>"+

"</Invite_Part_List>"+
"</Invite_Participant_Request>"+
"</Request>"+
"</MCU_XML_API>";



ScopiaRequest scopiaRequest=SchedConfFactory.createScopiaRequest();
String scopiaResponse1=scopiaRequest.send(reqMSG);
logger.info("Scopia Response Invite Participants : "+scopiaResponse1);



Response of this is as follows :

Scopia Response Invite Participants :
<?xml version="1.0" encoding="UTF-8"?>
<MCU_XML_API>
<Version>8.0</Version>
<Response>
<Invite_Participant_Response>
<RequestID> 12345 </RequestID>
<ConfGID>2791</ConfGID>
<Invite_Part_List>
<Invite_Part><PID></PID><DialStr>2304</DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part><Invite_Part><PID></PID><DialStr>2305</DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part><Invite_Part><PID></PID><DialStr>2300</DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part></Invite_Part_List>
<ReturnValue>OK</ReturnValue>
</Invite_Participant_Response>
</Response>
</MCU_XML_API>




Can you please tell me what parameters are missing in request. And How would i get Conference GID?

Currently, i am using getConfID() method to get Conference GID.
Is it right?




Help needed on urgent Basis.


Thanks and Regards,

Swapnil Bhosale.

Hi Swapnil, sorry for the delay. Can you please try adding an XML version string to the start of your request string as follows? <?xml version="1.0" encoding="UTF-8"?>

If you are already providing such a string and didn't show it, please check to make sure that the XML version 1.0 is in quotes.

Hi Joel,


I tried by adding "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" this statement in the Scopia request.
However, the response i am getting from the Scopia is same.

Request :

final String reqMSG="<?xml version=\"1.0\" encoding=\"UTF-8\"?> <MCU_XML_API>"+

"<Request> <Invite_Participant_Request>"+
"<RequestID> 12345 </RequestID>"+
"<ConfGID>"+conference.getConfId()+"</ConfGID>"+
"<Invite_Part_List>"+
"<Invite_Part>"+
"<DialStr>"+ MechNumber+"@collaboratory.avaya.com</DialStr>"+
"<DisplayName> Mechanical </DisplayName>"+
"<PartName> Mechanical </PartName>"+
"<PrefCallRate> 0 </PrefCallRate>"+
"<ProtocolType> SIP </ProtocolType>"+
"</Invite_Part>"+

"<Invite_Part>"+
"<DialStr>"+ ElectNumber+"@collaboratory.avaya.com </DialStr>"+
"<DisplayName> Electrical </DisplayName>"+
"<PartName> Electrical </PartName>"+
"<PrefCallRate> 0 </PrefCallRate>"+
"<ProtocolType> SIP </ProtocolType>"+
"</Invite_Part>"+

"<Invite_Part>"+
"<DialStr>"+ StoreNumber+"2304@collaboratory.avaya.com </DialStr>"+
"<DisplayName> Store </DisplayName>"+
"<PartName> Store </PartName>"+
"<PrefCallRate> 0 </PrefCallRate>"+
"<ProtocolType> SIP </ProtocolType>"+
"</Invite_Part>"+

"</Invite_Part_List>"+
"</Invite_Participant_Request>"+
"</Request>"+
"</MCU_XML_API>";


Response :



Scopia Response Invite Participants :
<?xml version="1.0" encoding="UTF-8"?>
<MCU_XML_API>
<Version>8.0</Version>
<Response>
<Invite_Participant_Response>
<RequestID> 12345 </RequestID>
<ConfGID>3109</ConfGID>
<Invite_Part_List>
<Invite_Part><PID></PID<DialStr>2304@collaboratory.avaya.com</DialStr<ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part>
<Invite_Part><PID></PID><DialStr>2305@collaboratory.avaya.com </DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part>
<Invite_Part><PID></PID><DialStr>23002304@collaboratory.avaya.com </DialStr><ReturnValue>BadOrMissingParameter</ReturnValue></Invite_Part>
</Invite_Part_List>
<ReturnValue>OK</ReturnValue>
</Invite_Participant_Response>
</Response>
</MCU_XML_API>




Please let me know what is the error in the request.
Why i am not able to do conference call.
I am struggling from last 2 weeks.

Your help will be really appreciated.

Waiting for your earlier response.

One more thing,
When i print conference.getStatus() , i get NOT_START as a output. When the status will change to "STARTED"?


Thanks and regards,

Swapnil Bhosale.

Can you try without the backslash? The quotes do not need to be escaped.

Hi Swapnil, any updates?

Hi Joel,

Invite participant through scopia XML API looks like working fine.
Currently I am struggling with scheduling conference.
I am bit of confuse with scheduling time.

If I schedule conference for tomorrow I am not able to add participants to it, till it get started..
It says conference not found, when I try to add participant to that conference.

Can you please let me know, how should I give conference start time dynamically as there is a time pattern provided by scopia is different..

I want to give start time dynamically and my timezone is +5:30.

Can you let me know how should I do that.


Thanks and regards,
Swapnil.