Conferences

This API allow you to define a conference.

 

 List Conferences (GET)

Get a list of conferences for the account:

1

v1/accounts/{account_id}/conferences

 

Sample Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
   "auth_token":"{auth_token}",
   "status":"success",
   "request_id":"8a1ea88ca5e38dad0d5f78465a7e4724",
   "revision":"1815e90e98701b7dc1bb380e9234de0c",
   "data":[
      {
         "id":"ef75ce9ef67e92912753255bae1be98b",
         "name":"Vendor Conference"
      },
      {
         "id":"3623bb02cabad03eb669659855921e9e",
         "name":"Engineers Conference"
      },
      {
         "id":"1c1a03d1d9dd6f7c3c4ca16508d7b96c",
         "name":"Weekly Sales Conference"
      }
   ]
}

 

  • Add a New Conference (PUT)
  • Create a conference
1
v1/accounts/{account_id}/conferences

 

Sample Request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
   "data":{
      "member":{
         "join_muted":true,
         "join_deaf":false,
         "numbers":[
            "5004"
         ],
         "pins":[
         ]
      },
      "name":"Example Conference",
      "moderator":{
         "pins":[
         ],
         "numbers":[
         ],
         "join_muted":false,
         "join_deaf":false
      },
      "conference_numbers":[
      ]
   }
}
Sample Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
   "auth_token":"{auth_token}",
   "status":"success",
   "request_id":"1ebec7307bacf333690c508b6faed958",
   "revision":"1-e9be944dc82ce7648d1504db8dec1a68",
   "data":{
      "member":{
         "join_muted":true,
         "join_deaf":false,
         "numbers":[
            "5004"
         ],
         "pins":[
         ]
      },
      "name":"Example Conference",
      "moderator":{
         "pins":[
         ],
         "numbers":[
         ],
         "join_muted":false,
         "join_deaf":false
      },
      "conference_numbers":[
      ],
      "id":"add297c0e60770cdedf3d16170a2c31e"
   }
}
  • Update Conference (POST)
  • Modify an existing conference 

 

1
v1/accounts/{account_id}/conferences/{conference_id}

 

Sample Request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
   "data":{
      "member":{
         "join_muted":true,
         "join_deaf":false,
         "numbers":[
         ],
         "pins":[
            "1234"
         ]
      },
      "name":"Example Conference",
      "moderator":{
         "pins":[
            "9876"
         ],
         "numbers":[
         ],
         "join_muted":false,
         "join_deaf":false
      },
      "conference_numbers":[
         "5004"
      ]
   }
}
Sample Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
   "auth_token":"{auth_token}",
   "status":"success",
   "request_id":"c1fda600b5a9e9facb347b2dacc4bf0d",
   "revision":"2-5f4723608df4e783b6bdea4d90bfe1fb",
   "data":{
      "member":{
         "join_muted":true,
         "join_deaf":false,
         "numbers":[
         ],
         "pins":[
            "1234"
         ]
      },
      "name":"Example Conference",
      "moderator":{
         "pins":[
            "9876"
         ],
         "numbers":[
         ],
         "join_muted":false,
         "join_deaf":false
      },
      "conference_numbers":[
         "5004"
      ]
   }
}

 

  • Delete a Conference (DELETE)
  • Removes a conference callflows that reference this ID will not be updated but that action will be ignored. 
1
v1/accounts/{account_id}/conferences/{conference_id}

 

Sample Request
1
2
3
4
5
{
   "data":{
   }
}
Sample Response
1
2
3
4
5
6
7
8
{
   "auth_token":"{auth_token}",
   "status":"success",
   "request_id":"6cd8933ab69bdd1e9907977ff45704e5",
   "revision":"undefined",
   "data":{
   }
}

name

A friendly name used when displaying the conference in the UI

 View Sample Code
1
"name": "My Conference"

conference_numbers

An optional list of numbers that can be used via the conference server to join the conference. When the generic conference numbers are used the pin number will determine if the participant is a moderator or member.

Icon

If neither the moderator or member have a pin number the caller will join the conference as a member.

 View Sample Code
1
"conference_numbers": ["5003", "5004"]

moderator

These provide specific specific settings for moderators.  See below for sub-parameters

member

These provide specific specific settings for members.  See below for sub-parameters

  
 View Sample Code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
   "member":{
      "join_muted":true,
      "join_deaf":false,
      "numbers":[
         "5004",
         "5005"
      ],
      "pins":[
         "1234",
         "5678"
      ]
   },
   "name":"Example Conference",
   "moderator":{
      "pins":[
         "9876",
         "5432"
      ],
      "numbers":[
         "4004",
         "4005"
      ],
      "join_muted":false,
      "join_deaf":false
   },
   "conference_numbers":[
      "4158867900"
   ]
}
  •  moderator
  •  member

Conferences provides two callflow modules.  The "conference" module is used to connect directly to a specific conference where as the "conference_server" module will discover the proper conference by way of an IVR.

Data Parameters

PropertyDescription
id

The conference ID

Icon

For the module "conference" this is mandatory.

For the module "conference_server" it is ignored.

moderator Forces the caller to join as a moderator, useful if you want to have one callflow for members and another for moderators.

 

View Sample Code
1
2
3
4
5
6
7
8
9
10
{
   "data":{
      "id":"ef75ce9ef67e92912753255bae1be98b",
      "moderator":false
   },
   "module":"conference",
   "children":{
   }
}
1
2
3
4
5
6
7
8
9
{
   "data":{
   },
   "module":"conference_server",
   "children":{
   }
}