Download OpenAPI specification:Download
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.
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.
A success response, or an Error.
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."
}
}
{- "callid": "adf92089-df2a-4f14-a377-1e975f588fe4"
}
Returns information about a conference that matches the provided conference ID.
A success response, or an Error.
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();
{- "ConferenceInfoResponse": {
- "participants": [
- {
- "cli": "+46708168731",
- "id": "myConfId1",
- "duration": 14,
- "muted": false,
- "onhold": false
}, - {
- "cli": "myUserName",
- "id": "myConfId2",
- "duration": 12,
- "muted": false,
- "onhold": false
}
]
}
}
Removes all participants from a conference.
A success response, or an Error.
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();
Manages conference participant in a specified conference:
command required | string Action to apply on conference participant.
| ||||||||||
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
|
A success response, or an Error.
{- "command": "mute"
}
{- "content": "Successful response"
}
Remove a specified conference participant from a specified conference.
A success response, or an Error.
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();
{- "content": "200 Successful response"
}