Create Conference

Creates a conference with no members.

Request URL

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


Supported Parameters

Parameter Description Mandatory
from The phone number that will host the conference. Yes
callbackUrl The complete URL where the events related to the Conference will be sent to. No
callbackHttpMethod Determine if the callback event should be sent via HTTP GET or HTTP POST. Values are GET or POST, default: POST. No
callbackTimeout Determine how long should the platform wait for callbackUrl’s response before timing out in milliseconds.
Default Time: 10000 (10s)
Maximum Time: 10000 (10s)
No
fallbackUrl The URL used to send the callback event if the request to callbackUrl fails. No
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
No
tag A string that will be included in the callback events of the conference. No

Example 1 of 3: Create conference call

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/conferences -u {token}:{secret} -H "Content-type: application/json" -d
    '
    {
        "from": "{number}"
    }
    '
// Promise
client.Conference.create({from: "+1234567890"}).then(function(conference){});
// Callback
client.Conference.create({from: "+1234567890"}, function(err, conference){});
var conferenceId = await client.Conference.CreateAsync(new CreateConferenceData {From = "+1234567890"});
Console.WriteLine($"Created conference with id {conferenceId}");
// Created conference with id c-1234
conference = Conference.create(client,  {:from => "+1234567890"})

The above command returns HTTP Header structured like this:

HTTP/1.1 201 CREATED
Location: /v1/users/{userId}/conferences/{conferenceId}

Example 2 of 3: Create conference with callback, 2 seconds callback's timeout, and fallback

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/     -u {token}:{secret}     -H "Content-type: application/json"     -d     '
    {
        "from": "{number}",
        "callbackUrl":"http://my.callback.url",
        "callbackTimeout":"2000",
        "fallbackUrl":"http://my.fallback.url"
    }'
var params = {
    "from": "{number}",
    "callbackUrl":"http://my.callback.url",
    "callbackTimeout":"2000",
    "fallbackUrl":"http://my.fallback.url"
};

// Promise
client.Conference.create(params).then(function(conference){});
// Callback
client.Conference.create(params, function(err, conference){});
var conference = await client.Conference.CreateAsync(new CreateConferenceData {
    From = "{number}",
    CallbackUrl ="http://my.callback.url",
    CallbackTimeout = 2000,
    FallbackUrl ="http://my.fallback.url"
});
conference = Conference.create(client,  {
    :from => "+1234567890",
    :callback_url => "http://my.callback.url",
    :callback_timeout => 2000,
    :fallback_url => "http://my.fallback.url"
})

The above command returns HTTP Header structured like this:

HTTP/1.1 201 CREATED
Location: /v1/users/{userId}/conferences/{conferenceId}

Example 3 of 3: Create conference with callback, 2 seconds callback's timeout, fallback, and profile

curl -v -X POST https://api.catapult.inetwork.com/v1/users/{userId}/ -u {token}:{secret} -H "Content-type: application/json" -d
    '
    {
        "from": "{number}",
        "callbackUrl":"http://my.callback.url",
        "callbackTimeout":"2000",
        "fallbackUrl":"http://my.fallback.url",
        "profile": "passthru_digits"
    }
    '
var params = {
    "from": "{number}",
    "callbackUrl":"http://my.callback.url",
    "callbackTimeout":"2000",
    "fallbackUrl":"http://my.fallback.url",
    "profile": "passthru_digits"
};

// Promise
client.Conference.create(params).then(function(conference){});
// Callback
client.Conference.create(params, function(err, conference){});
var conference = await client.Conference.CreateAsync(new CreateConferenceData {
    From = "{number}",
    CallbackUrl ="http://my.callback.url",
    CallbackTimeout = 2000,
    FallbackUrl ="http://my.fallback.url",
    Profile ="passthru_digits"
});
conference = Conference.create(client,  {
    :from => "+1234567890",
    :callback_url => "http://my.callback.url",
    :callback_timeout => 2000,
    :fallback_url => "http://my.fallback.url",
    :profile => "passthru_digits"
})

The above command returns HTTP Header structured like this:

HTTP/1.1 201 CREATED
Location: /v1/users/{userId}/conferences/{conferenceId}

results matching ""

    No results matching ""