Download OpenAPI specification:Download

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.

Request

Security:

Basic

Signed

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": {"type": "number",
"endpoint": "+14045005000"
},
"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.

Request

Security:

Basic

Signed

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

Node.js
C#
Java
Python
curl

import fetch from 'node-fetch';

async function run() {
  const conferenceid = 'YOUR_conferenceid_PARAMETER';
  const resp = await fetch(
    `https://calling.api.sinch.com/calling/v1/conferences/id/${conferenceid}`,
    {
      method: 'GET',
      headers: {
        Authorization: 'Basic ' + Buffer.from('<username>:<password>').toString('base64')
      }
    }
  );

  const data = await resp.text();
  console.log(data);
}

run();

Response samples

application/json

{"ConferenceInfoResponse": {"participants": [{"cli": "+46708168731",
"id": "myConfId1",
"duration": 14,
"muted": false,
"onhold": false
},
{"cli": "myUserName",
"id": "myConfId2",
"duration": 12,
"muted": false,
"onhold": false
}
]
}
}

Kick Conference All

Removes all participants from a conference.

Request

Security:

Basic

Signed

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

Node.js
C#
Java
Python
curl

import fetch from 'node-fetch';

async function run() {
  const conferenceid = 'YOUR_conferenceid_PARAMETER';
  const resp = await fetch(
    `https://calling.api.sinch.com/calling/v1/conferences/id/${conferenceid}`,
    {
      method: 'DELETE',
      headers: {
        Authorization: 'Basic ' + Buffer.from('<username>:<password>').toString('base64')
      }
    }
  );

  const data = await resp.text();
  console.log(data);
}

run();

Manage Conference Participant

Manages conference participant in a specified conference:

mute / unmute
put on hold / resume.

Request

Security:

Basic

Signed

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:	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:	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.

Request

Security:

Basic

Signed

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

Node.js
C#
Java
Python
curl

import fetch from 'node-fetch';

async function run() {
  const callid = 'YOUR_callid_PARAMETER';
  const conferenceid = 'YOUR_conferenceid_PARAMETER';
  const resp = await fetch(
    `https://calling.api.sinch.com/calling/v1/conferences/id/${conferenceid}/${callid}`,
    {
      method: 'DELETE',
      headers: {
        Authorization: 'Basic ' + Buffer.from('<username>:<password>').toString('base64')
      }
    }
  );

  const data = await resp.text();
  console.log(data);
}

run();

Response samples

application/json

{"content": "200 Successful response"
}

Security Privacy Legal & Compliance Cookie Statement