How To Set Up A Ringcentral Conference Call
Managing Briefing Calls
Multi-way conference calling enables multiple people on multiple phones to connect to the same call. A user with a RingCentral account can outset a conference and bring in parties to the conference, without the need to set up a Conference Bridge. Each party brought into the conference, whether using a RingCentral number or their own phone, tin can speak to others who are on the same conference. Each account has it'due south own conferencing line where upwards to 10 parties tin can join a call.
The Briefing Call API allows a developer to automatically:
- Start a conference Phone call
- Bring-in a call party to a conference phone call
- Remove a call party from a conference call
Starting a conference telephone call
The Briefing API is used to initiate a conference call on the specified account. No request body is needed to start a conference call session on the account. If the business relationship is the user's electric current account, a ~ can be used instead of the business relationship ID.
Mail /restapi/v1.0/account/~/telephony/conference Content-Blazon: awarding/json Authorization: <YOUR_ACCESS_TOKEN>
{ "session": { "creationTime": "2020-09-10T00:25:21Z", "id": "s-46d25a881853422c9f61497c6f76a327", "origin": { "blazon": "Conference" }, "parties": [], "voiceCallToken": "conf_732d34366432356138383138353334323263396636313439376336663736613332374031302e31332e3132332e3235303a35303730" } } This will return a voiceCallToken which is the phone call token for entering the conference call. You'll bring in your first caller via a Session Initiation Protocol (SIP) INVITE.
Important
A SIP INVITE is required to bring in parties to the briefing telephone call, otherwise you will receive a 403 mistake. The briefing telephone call will await 38 seconds for the SIP INVITE to complete or else the conference will exist terminated.
INVITE sip:conf_732d34366432356138383138353334323263396636313439376336663736613332374031302e31332e3132332e3235303a35303730@sip.ringcentral.com SIP/2.0 Via: SIP/2.0/WSS To: <sip:conf_732d34366432356138383138353334323263396636313439376336663736613332374031302e31332e3132332e3235303a35303730@sip.ringcentral.com> From: <sip:17203861294*11101@sip.ringcentral.com> You'll besides receive a telephony session ID (id) that will be used in the post-obit calls to add together and remove parties from the telephone call.
Important
A SIP INVITE takes time to complete, during which time a bring-in control or presence command will not operate properly. Please make sure to include a timeout to delay bring-in or presence commands before the SIP INVITE is ready. Or listen instead for the presence issue when the conference telephone call is connected.
Bring-in a phone call party to a conference call
At present that a conference has started, and you take established a Session Initiation Protocol, you lot can add parties to the call using the telephony session ID of the conference telephone call (id). The telephonySessionId establish in the path is the conference session ID (id). The telephonySessionId in the body is the initial phone call from the exterior party to the agent (host). A maximum of x parties can exist added to a conference call with only 1 call party allowed to bring together a conference per request.
Post /restapi/v1.0/account/~/telephony/sessions/{telephonySessionId}/parties/bring-in Content-Blazon: application/json Authorization: <YOUR_ACCESS_TOKEN> { "telephonySessionId" : //Session id of the telephone call yous want to bring in to the conference "partyId" : //Identifier of the participant from that phone call } Ii sets of parameters can be used to bring a party into a briefing call.
Parameters
| Parameter | Location | Required? | Description |
|---|---|---|---|
accountId | path | required | This is the unique identifier for the business relationship associated with the request. This can exist the actual id or ~ for the electric current accountId. The default ~ value is acceptable in all uses for this API. |
telephonySessionId | path | required | This is the unique identifier for the conference telephone call. |
sessionId | torso | required | The telephony session ID in which the party you want to bring in is already on a telephone call. |
partyId | body | required | This is the unique identifier for the call party to add to this conference call. |
Finding Telephone call Parties
You discover telephone call parties by looking for active calls. The presence APIs allow yous to encounter near real-fourth dimension details of existing calls. Find the agile call you want to join to the conference from the listing of active calls.
Post /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence?detailedTelephonyState=true HTTP / 1.one Content-Type : application/json Content-Length : ACTUAL_CONTENT_LENGTH_HERE Dominance : <YOUR_ACCESS_TOKEN>
{ "activeCalls" : [ { "direction" : "Outbound" , "from" : "+19295550100" , "id" : "3sv13tj6e4ohgq4kak5j" , "partyId" : "p-854662029bf6411d8e216786ca373674-one" , "sessionId" : "10675785005" , "startTime" : "2020-09-24T19:51:19.020Z" , "telephonySessionId" : "south-854662029bf6411d8e216786ca373674" , "telephonyStatus" : "CallConnected" , "to" : "+15105550101" } { "management" : "Outbound" , "from" : "+19295550100" , "id" : "3sv13spmbukc2ku0dln7" , "partyId" : "p-19a6e4906d8d4c799781760b03fbb014-1" , "sessionId" : "0" , "startTime" : "2020-09-24T19:51:29.235Z" , "telephonySessionId" : "s-19a6e4906d8d4c799781760b03fbb014" , "telephonyStatus" : "CallConnected" , "to" : "conference" , "toName" : "Briefing" } ], "allowSeeMyPresence" : true , "dndStatus" : "TakeAllCalls" , "extension" : { "extensionNumber" : "102" , "id" : 684351005 , "uri" : "https://platform.devtest.ringcentral.com/restapi/v1.0/account/{accountId}/extension/{extensionId}" }, "meetingStatus" : "Disconnected" , "pickUpCallsOnHold" : fake , "presenceStatus" : "Busy" , "ringOnMonitoredCall" : false , "telephonyStatus" : "CallConnected" , "uri" : "https://platform.devtest.ringcentral.com/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence" , "userStatus" : "Available" } Remove a call political party from a briefing call
You can remove a political party from a conference call by specifying the political party ID y'all wish to delete from the telephone call. Yous may delete only one briefing participant from a call at a time.
DELETE /restapi/v1.0/account/~/telephony/sessions/{telephonySessionId}/parties/{partyId} Content-Type: application/json Authorization: <YOUR_ACCESS_TOKEN> Parameters
| Parameter | Location | Required? | Clarification |
|---|---|---|---|
accountId | path | required | This is the unique identifier for the account associated with the request. This tin can be the actual id or ~ for the current accountId. The default ~ value is acceptable in all uses for this API. |
telephonySessionId | path | required | This is the unique identifier for the call, including all parties. Encounter the side by side section on how to get a list of current telephony sessions. |
partyId | path | required | This is the internal identifier for the call party to remove. |
Source: https://developers.ringcentral.com/guide/voice/conference
0 Response to "How To Set Up A Ringcentral Conference Call"
Post a Comment