Fetch Conference information

Retrieve current properties for a conference.

Request URL

GEThttps://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}


Conference Properties

Property Description
id The unique id of a conference.
state Conference state. Possible state values are described below.
from The phone number that will host the conference.
createdTime The time that the Conference was created (UTC).
completedTime The time that the Conference was completed (UTC).
activeMembers The number of active conference members.
hold If true, all member can’t hear or speak in the conference. If `false”, all members can hear and speak in the conference (unless set at the member level).
mute If true, all member can’t speak in the conference. If false, all members can speak in the conference (unless set at the member level).
profile The conference profile that determines how DTMF is used. Values are:
- interpret_digits: the conference will handle DTMF with the default behavior
-passthru_digits: allows the application to receive DTMF events and use the gather API.
Default: interpret_digits
callbackUrl The complete URL where the events related to the Conference will be sent to.
callbackHttpMethod Determine if the callback event should be sent via HTTP GET or HTTP POST. Values are GET or POST, default: POST.
callbackTimeout Determine how long should the platform wait for callbackUrl’s response before timing out in milliseconds.
fallbackUrl The URL used to send the callback event if the request to callbackUrl fails.
tag A string that will be included in the callback events of the conference.

Conference States

State Description
created Conference was created and has no members.
active Conference was created and has one or more ACTIVE members. As soon as the first member is added to a conference, the state is changed to active.
completed The conference was completed. Once the conference is completed, It can not be used anymore.

Example 1 of 1: Get conference

curl -v -X GET https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId} \
    -u {token}:{secret} \
    -H "Content-type: application/json"
// Promise
client.Conference.get("conferenceId").then(function(conference){});
// Callback
client.Conference.get("conferenceId", function(err, conference){});
var conference = await client.Conference.GetAsync("{conferenceId1}");
Console.WriteLine($"{conference.From} - {conference.State}");
// +1234567890 - Created
conference = Conference.get(client, "{conferenceId1}")
owner = conference.from

The above command returns JSON structured like this:

{
        "activeMembers": 0,
        "createdTime": "2013-07-12T15:22:47-02",
        "from": "+19703255647",
        "id": "{conferenceId}",
        "profile": "interpret_digits",
        "state": "created"
}

results matching ""

    No results matching ""