Conferences

Using the Conferences endpoint, you can perform tasks like retrieving information about an on-going conference, muting or unmuting participants, or removing participants from a conference.

Callout Request

Makes a call out to a phone number. The types of callouts currently supported are conference callouts, text-to-speech callouts, and custom callouts. The custom callout is the most flexible, but text-to-speech and conference callouts are more convenient.

SecurityBasic or Application
Request
Request Body schema: application/json
method
required
string

Sets the type of callout.

Enum: "conferenceCallout" "ttsCallout" "customCallout"
object (conferenceCalloutRequest)

The conference callout calls a phone number or a user. When the call is answered, it's connected to a conference room.

object (ttsCalloutRequest)

The text-to-speech callout calls a phone number and plays a synthesized text messages or pre-recorded sound files.

object (customCalloutRequest)

The custom callout, the server initiates a call from the servers that can be controlled by specifying how the call should progress at each call event.

Responses
200

A success response, or an Error.

Response Schema: application/json
callId
string

The returned call identifier.

post/calling/v1/callouts
Request samples
application/json

Place a phone call and use text to speech to convey a message.

{
  • "method": "ttsCallout",
  • "ttsCallout": {
    • "cli": "+14045001000",
    • "destination": {
      },
    • "locale": "en-US",
    • "text": "Hello, this is a call from Sinch."
    }
}
Response samples
application/json
{
  • "callId": "adf92089-df2a-4f14-a377-1e975f588fe4"
}

Get Conference Info

Returns information about a conference that matches the provided conference ID.

SecurityBasic or Application
Request
path Parameters
conferenceId
required
string

The unique identifier of the conference. The user sets this value.

Example: MyConfId
Responses
200

A success response, or an Error.

Response Schema: application/json
Array of objects
Array
cli
string

The phone number of the PSTN participant that was connected in the conference, or whatever was passed as CLI for data originated/terminated calls.

id
string

The callId of the call leg that the participant joined the conference.

duration
integer

The number of seconds that the participant has been connected to the conference.

muted
boolean
onhold
boolean
get/calling/v1/conferences/id/{conferenceId}
Request samples 
Response samples 
application/json
{
  • "participants": [
    • {
      },
    • {
      }
    ]
}
Kick Conference All
Removes all participants from a conference.


SecurityBasic or Application 
Request 
path Parameters
conferenceId
required
string
The unique identifier of the conference. The user sets this value.


 
 Example:  MyConfId
Responses 
204
A success response, or an Error.


delete/calling/v1/conferences/id/{conferenceId}
Request samples 
Manage Conference Participant 
Manages conference participant in a specified conference:


    

  • mute / unmute
    • 

  • put on hold / resume.
    • 



SecurityBasic or Application 
Request 
path Parameters
callId
required
string
The unique identifier of the call. This value is generated by the system.


 
 Example:  4398599d1ba84ef3bde0a82dfb61abed
conferenceId
required
string
The unique identifier of the conference. The user sets this value.


 
 Example:  MyConfId
Request Body schema: application/json
command
required
string
Action to apply on conference participant.


 Enum Value Description
mute
Mutes participant.


unmute
Unmutes participant.


onhold
Puts participant on hold.


resume
Returns participant to conference.


 
moh
string
Means "music on hold". If this optional parameter is included, plays music to the first participant in a conference while they're alone and waiting for other participants to join. If moh isn't specified, the user will only hear silence while alone in the conference. This property is only available to use with the onhold command.


 Enum Value Description
ring
Plays a progress tone.


music1
Plays music choice 1.


music2
Plays music choice 2.


music3
Plays music choice 3.


 
Responses 
200
A success response, or an Error.


Response Schema: application/json
 Schema not provided 
patch/calling/v1/conferences/id/{conferenceId}/{callId}
Request samples 
application/json
{
  • "command": "mute"
}
Response samples 
application/json
{
  • "content": "Successful response"
}
Kick Conference Participant
Remove a specified conference participant from a specified conference.


SecurityBasic or Application 
Request 
path Parameters
callId
required
string
The unique identifier of the call. This value is generated by the system.


 
 Example:  4398599d1ba84ef3bde0a82dfb61abed
conferenceId
required
string
The unique identifier of the conference. The user sets this value.


 
 Example:  MyConfId
Responses 
200
A success response, or an Error.


Response Schema: application/json
 Schema not provided 
delete/calling/v1/conferences/id/{conferenceId}/{callId}
Request samples 
Response samples 
application/json
{
  • "content": "200 Successful response"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.