Introduction

The CarrierX service offers a hosted Conference Application Endpoint that enables two or more parties to speak to one another. Parties call into a meeting room, which stores the meeting configurations, call flow attributes, and meeting key information. Call flows determine how the call is handled.

Refer to the Conference products page for quick start guides and video tutorials. These hold walk-through instructions on configuring Conference endpoints, creating meeting rooms, assigning containers for meeting recordings, and accessing recordings.

Using the REST API

This section describes how to obtain credentials to use the API, what types of requests the system recognizes, and the format of the responses. It also holds reference information about pagination and filtering.

Using Postman

This documentation contains cURL commands that you will run in your terminal. Rather than use these commands, you can explore the API using Postman, a stand-alone client with a user-friendly interface. Postman is widely used for API development and allows you to test requests.

You will need to download the Postman client to your computer. To do so, visit the Postman website and click Download the App. Click Run in Postman to import this collection to the Postman app.

Run in Postman

For more information, see our Getting Started with Postman Quick Start Guide.

Credentials

The following curl command will return a list of all of the endpoints of the CarrierX account associated with the login credentials. Use your Core API token in the query below. The endpoint login and password values are listed in the returned JSON object.

curl -X GET \
'https://api.carrierx.com/core/v2/endpoints' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

The credentials of a specific endpoint are found in the properties attribute of the nested object. Locate the login and password values.

{
  "count": 2,
  "has_more": false,
  "items": [
      {
          "addresses": [
              {
                  "direction": "any",
                  "ip": "10.1.10.69",
                  "port": 5060,
                  "transport": "udp"
              }
          ],
          "attributes": {},
          "capacity": 0,
          "endpoint_sid": "7fc3e7ea-a0df-4de1-836f-50318ed66466",
          "name": "System Gateway",
          "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
          "properties": {},
          "transformations": [],
          "type": "system_gateway",
          "voip_token": null
      },
      {
          "addresses": [],
          "attributes": {},
          "capacity": 0,
          "endpoint_sid": "844346ef-93e9-4fa8-a4ab-e3015af94573",
          "name": "flex",
          "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
          "properties": {
              "account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
              "api_url": "https://api.carrierx.com/flexml/v1",
              "container_sid": "null",
              "login": "sample_login",
              "password": "sample_password"
          },
          "transformations": [],
          "type": "flexml",
          "voip_token": null
      }
  ],
  "limit": 1000,
  "offset": 0,
  "pagination": {},
  "total": 2
}

API requests require authentication. To obtain a CarrierX account and gain credentials, please submit a request through our Contact Us page. The Core API uses a bearer token, and the endpoint APIs (Conference, FlexML, and Mediator) use a login and password.

Prior to making requests, a Conference Application Endpoint needs to be created. See the Configure an Application Endpoint quick start guide for step-by-step instructions on creating an endpoint.

Each of the application endpoints has different login and password values. Entering the Core API token credentials instead of the endpoint-specific credentials when working with the Conference, FlexML, or Mediator APIs will return the error unauthorized.

Requests

API requests require authentication. Refer to the section above for more information about obtaining login credentials. Endpoint credentials are passed using HTTP basic authentication. Pagination and filtering parameters are passed as part of the query URL. Object fields and values are added to the request body.

The Conference API has the following base URL:

https://api.carrierx.com/conference/v1

The system only accepts HTTPS requests, and not HTTP requests.

Responses

All responses are returned in the JSON format with a status code. For common errors returned, refer to the HTTP Errors section.

For a comprehensive list of returned attributes refer to the Call Object, DID Object, DID Group Object, Meeting Object, and Meeting Room Object.

Pagination

This request returns Call objects starting with the second record available, and returns a maximum of 4 records.

curl -X GET \
'https://api.carrierx.com/conference/v1/calls?offset=2&limit=4' \
-u '[your_user_name]:[your_password]'

To view records not included in the response, make a request to the URL value of the previous key.

{
  "count": 0,
  "has_more": false,
  "items": [],
  "limit": 4,
  "offset": 2,
  "pagination": {
      "previous": "https://api.carrierx.com/conference/v1/calls?limit=4&offset=0"
  },
  "total": 0
}

The three optional parameters for pagination are: offset, limit, and order. GET requests use these three parameters to dictate how many items should be skipped in the response, the amount of records to return, and in what order the results should appear.

offset determines the amount of items that are skipped in the response. If there are five records and the offset value is 2, the response will not include the first two records. Instead, it will return records for items three through five. The default value for offset is 0, meaning that the first existing item will appear first.

The parameter limit determines how many items are returned in the response. The default limit is 10, meaning that a maximum of ten items will be returned. If the number of items that exist exceeds the limit value, the has_more value in the response will be set to true. Responses also have a total field, which is the total amount of results that match the search criteria. Note that the field total will be null on objects that are uncountable, such as SMS messages.

The last parameter of pagination is order. There are two values accepted for this parameter, asc and desc. asc is short for ascending and is the default order. Enter the field name to be ordered followed by either asc or desc. For example, name desc will return names sorted in reverse-alphabetical order. Since the default is asc, entering just name will sort the results by name in alphabetical order.

The JSON response for a successful query using the pagination parameters offset, limit, and order will include a pagination parameter. The value of pagination will be empty if there are no more records existing outside of the queried parameters. If there are existing records outside of the query, the pagination value will include next or previous URLs. These URLs can be used to obtain the remainder of the records available without modifying the original query. Simply construct another GET request with the URL provided in this field.

Pagination Quick Reference

Parameter Data Type Description
offset integer The amount of items skipped in the response. 0 is the default value. This parameter and value are added to the query URL.
limit integer The number of items to be shown in the response. The value entered should not exceed 1000. 10 is the default value. This parameter and value are added to the query URL.
order string The name of the field to be ordered followed by the order of the response data, either asc or desc. The field to be ordered is listed first, followed by the order value. For example: binding_sid desc. asc is the default order. This parameter and values are added to the query URL.

Result Filtering

This GET request returns Endpoint objects that meet the filter criteria. In this case, we are narrowing results to the endpoint type "conference".

curl -X GET \
"https://api.carrierx.com/core/v2/endpoints?filter=type+eq+'conference'" \
-u '[your_user_name]:[your_password]'

The following response includes all of the endpoints that fit the filter criteria.

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "addresses": [],
            "attributes": {},
            "capacity": 0,
            "endpoint_sid": "613325f8-bbb8-4599-b477-1b4fef3d017c",
            "name": "my_example_conference",
            "partner_sid": "6nelo9p3-3eef-4f75-8f48-fb98e99908be",
            "properties": {
                "account_sid": "bdrU77AFb-Y1sDwqqxkeb.M3LP7hSKYg",
                "api_url": "https://api.carrierx.com/conference/v1",
                "container_sid": "null",
                "login": "username",
                "password": "password"
            },
            "transformations": [],
            "type": "conference",
            "voip_token": null
        }
    ],
    "limit": 1000,
    "offset": 0,
    "pagination": {},
    "total": 1
}

The parameter filter is used to restrict or customize the JSON response. Operators can be combined for more specific searches, and are added to the query URL.

Result Filtering Quick Reference

Operator Definition Example
eq equal to. This search looks for exactly the value entered. In the example, results will have the exact value "my_mediator" for the name field. name eq "my_mediator"
gt greater than. This search returns records where the value is exceeded for the field listed. For example, records are returned where the value of maximum_ttl is greater than 40000. maximum_ttl gt 40000
ge greater than or equal to. This search returns records where the value is greater than or equal to the field listed. For example, records are returned where the value of wait_origination_did_ttl is greater than or equal to 70000. wait_origination_did_ttl ge 70000
ilike same functionality as like but case insensitive. name like "AccOUnt%"
in the current value of the specified field must be contained within the specified list. The following example will return records that have a status value of either "active" or "suspended". status in ("active", "suspended")
lt less than. This search returns records where the value is less than the field listed. For example, records are returned where maximum_ttl is less than 10000. maximum_ttl lt 10000
le less than or equal to. This search returns records where the value is less than or equal to the field listed. For example, records are returned where wait_origination_did_ttl is less than or equal to 90000. wait_origination_did_ttl le 90000
like contains the value indicated in the string passed. % can be added anywhere as part of the string to indicate that there can exist text before or after the string parts. In the example, the command looks for a name starting with "Account". This form of search is case sensitive. Note that this method of search will also work: name like "A%t", and this search will yield records with name values beginning with A and ending in t. name like "Account%"
ne not equal to. This search returns records that do not include the value "my_mediator" for the name field. name ne "my_mediator"
notin not in. The current value of the specified field must not be in the specified list. The following example will return records that do not have a status value of "active". status notin ("active")

Field Filtering

In the following, we request Endpoint objects without the field "properties".

curl -X GET \
'https://api.carrierx.com/mediator/v1/bindings?exclude_fields=properties' \
-u '[your_user_name]:[your_password]'

The following response excludes the "properties" field from returned Endpoint objects.

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "addresses": [],
            "attributes": {},
            "capacity": 0,
            "endpoint_sid": "613325f8-bbb8-4599-b477-1b4fef3d017c",
            "name": "my_example_conference",
            "partner_sid": "6nelo9p3-3eef-4f75-8f48-fb98e99908be",
            "transformations": [],
            "type": "conference",
            "voip_token": null
        }
    ],
    "limit": 1000,
    "offset": 0,
    "pagination": {},
    "total": 1
}

There are two parameters associated with field filtering: include_fields, and exclude_fields. By default, the fields included in JSON responses are specific to the request made. These returned fields are explained in the Object section for that object.

Refer to the specific object to determine which fields can be included and excluded from the JSON responses. include_fields and exclude_fields accept comma-separated strings as values.

Field Filtering Quick Reference

Parameter Data Type Description
include_fields string The comma separated list of fields to be included in the response. The fields depend on the object. See the Object section for that object to see which fields return.
exclude_fields string The comma separated list of fields to be excluded from the response. The fields depend on the object. See the Object section for that object to see which fields return.

HTTP Errors

The Conference API uses the following HTTP error codes:

Error Code Message Description
400 Bad Request The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications.
400 No JSON object could be decoded Generally an indicator that there is a syntax error.
401 Unauthorized The request requires user authentication.
401 Bad credentials The request requires correct user authentication.
403 Forbidden The server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
404 Not Found The requested resource was not found on the server.
404 Cannot find item by SID The SID number does not exist. Verify that the SID has been entered correctly. Note that calls can expire.
415 Unsupported media type Ensure that the header includes support for the content type JSON.
500 Internal server error The server encountered an unexpected condition which prevented it from fulfilling the request.

Conference Overview

The Conference API is used to host audio conferencing for up to 1,000 attendees. Meeting rooms are configurable objects that hold the settings for meetings. End-users dial a phone number and enter an access code, which the system uses to determine which meeting room they will be connected to.

Access codes correspond with the three access levels: host, participant, and listener. Each access level has settings which determine how the party is treated during a meeting. For example, settings on the Meeting Room object can determine that all listeners will be muted upon entering the meeting.

A Meeting Room object holds other configurations called Meeting Attributes, which dictate how the call is handled. A Meeting object is created in real time once a meeting starts. The start of a meeting is determined by meeting room settings. For example, a meeting can begin once a host calls in, or a meeting can start once any party calls in.

A Call object is also created in real time when a call begins. Meeting and Call objects are real-time elements that only exist as long as a meeting is happening and as long as there are callers in the meeting.

Once a meeting is finished, the Meeting object is deleted, along with all of the Call objects associated with the meeting.

Conference vs Conference Playback Endpoint

A Conference endpoint enables two or more parties to have a conversation in a meeting. A Conference Playback endpoint is used to listen to saved recordings made during meetings. In order for recordings to be saved, a Conference endpoint must be created and connected to a Conference Playback endpoint. Create a Conference Playback endpoint in the same way as a Conference endpoint, by using the Core API. Learn how to connect the endpoints by referring to the Conference Playback Quick Start.

API Reference

The Conference API has 5 objects: Calls, DIDs, DID Groups, Meetings, and Meeting Rooms. Use the Calls object to retrieve, update, and delete future calls. Target the DIDs object to get list of DIDS, and the DID Groups object to return DID Groups. Through the Conference API, Meeting objects can be returned, updated, and delete. Finally, Meeting Room objects can be created, returned, updated, and deleted.

Call Flows

Call flows define the way that calls are handled. There are two call flows that can be chosen from when creating a meeting room. The call flows are CONF and SPECTEL. The CONF call flow enables callers to enter a conference room with an access code associated with the meeting room. Alternatively, the CONF call flow also enables creating a meeting on the fly by entering a random access code.

The SPECTEL call flow only accepts access codes associated with the meeting room.

Call flows are set at the creation of a new Meeting Room object. The attributeTemplates values of the Call Flow object serve as default settings. These settings can be overridden in various places once the Meeting Room object has been created.

Call Flow Object

This section outlines the Call Flow object. The attributes listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute Data Type Description
attributeTemplates array The attributes belonging to the call flow. Refer to the table below for a comprehensive list of the format of attributes. For a list of the attributes themselves, refer to the Meeting Attributes section.
id integer The call flow ID. Note that this ID may differ for each user.
name string The call flow name.
path string This field is for internal use only.

attributeTemplates

Attribute Data Type Description
description string The description of the attribute.
enumValues string If the type is Enum, this attribute will be automatically populated with possible values.
group integer Defines the levels at which the call flow attribute value can be overridden. Integer values denote that the call flow attribute can be overridden at the following object levels:
  • 1 for Call Flow and DID Group
  • 2 for DID
  • 3 for Call Flow, DID Group, and DID
  • 4 for Meeting Room
  • 5 for Call Flow, DID Group, and Meeting Room
name string The attribute name.
type integer The attribute type. Possible values for this field are:
  • 0 for TYPE_STRING
  • 2 for TYPE_INT
  • 3 for TYPE_DTMF
  • 4 for TYPE_ROLE
  • 5 for TYPE_CHOICE
  • * for any
value string The attribute value.

Get Call Flows

The following GET request will return a list of call flows associated with the Conference endpoint.

curl -X GET \
'https://api.carrierx.com/conference/v1/callFlows?excludeFields=attributeTemplates' \
-u '[your_use_name]:[your_password]'

A successful response will return a 200 status code and a response that looks like the following.

{
    "callFlows": [
        {
            "id": 1,
            "name": "SPECTEL",
            "path": "/usr/local/DNCA/callflows/SPECTEL"
        },
        {
            "id": 3,
            "name": "CONF",
            "path": "/usr/local/DNCA/callflows/CONF"
        }
    ],
    "last": 0,
    "offset": 0,
    "total": 2
}

This request returns a list of call flows that match the optional filters provided. This request is enabled for Pagination, Result Filtering, and Field Filtering. Note that a request with no filtering will return attributeTemplates for the call flow, and this field was excluded in the same curl command and response.

Method URL
GET /callFlows

Get Call Flow by ID

The following GET request will return a list of call flows by ID associated with the Conference endpoint.

curl -X GET \
'https://api.carrierx.com/conference/v1/callFlows/1?excludeFields=attributeTemplates' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with the call flow that matches the ID.

{
    "id": 1,
    "name": "SPECTEL",
    "path": "/usr/local/DNCA/callflows/SPECTEL"
}

This request returns call flow details and is enabled for Field Filtering.

Method URL
GET /callFlows/{ID}

Path Arguments

Parameter Data Type Description
id required integer The ID of the call flow.

Calls

Calls are created by the server automatically when a user dials a phone number associated with a meeting room. This object is used to access information about a current call. When the call is over, the Call object is deleted.

Note that a meeting room can have multiple calls. Each participant calling into a meeting room will be represented with a Call object.

Call Object

This section outlines the Call object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Field Data Type Description
accessCode string The access code entered by the caller. This field is required when creating a new call.
addressFrom string The phone number and SIP data of the calling party.
bridgeName string The hosted bridge name.
callee string The DID being dialed. This field is required when creating a new call.
caller string The phone number of the calling party. This field is required when creating a new call.
codec string The audio codec of the call.
connectionStatus integer This field indicates the call direction. Accepted values for this field are as follows:
  • 0 for inbound call
  • 1 for outbound call
created string The date and time when the call was created.
customName string A friendly name for the call.
duration integer The duration in seconds of the call.
gainLevel integer The gain of the transmission circuit.
holdMode integer Whether meeting participants and listeners are on hold. Values that will appear in this field are either 0 or 40. 0 means that no parties are on hold. 40 means that participants and listeners have been placed on hold by the meeting host. When callers are on hold, they will hear music while the hosts have a private discussion. Note that this value does not change. It is reflective of the initial hold state when the meeting starts.
id integer The call ID.
joined integer The date and time when the call was joined.
meetingNumber integer The meeting number of the meeting associated with the call.
muteMode integer There are three mute states. The following values reflect which access level parties have been muted:
  • 32 for listeners have been muted
  • 36 for listeners have muted themselves and participants have muted themselves
  • 40 for participants and listeners have been muted
Note that this value does not change in the Meeting object. It is reflective of the initial mute state when the meeting is started.
nodeName string The name of the hosted node, or communication endpoint.
presenterMedia integer The media for the call. Accepted values that appear in this field are:
  • 1 for audio
  • 2 for screensharing
  • 4 for video
  • 8 for controlling
Note that you can add the integer values together. For example, for audio and video, 1 + 4 = 5.
qaMode integer The state of a Q&A meeting. Accepted values in this field are:
  • 0 for meeting has not started yet
  • 1 for active meeting
  • 2 for talking to the next participant in the queue
  • 4 for clearing the queue
role integer The role associated with the access code. Accepted values in this field are:
  • 1 for host
  • 2 for participant
  • 3 for listener
state integer The current call state. Accepted values in this field are:
  • 1 for call is owned by the frontend
  • 2 for call is owned by the backend
  • 3 for call is closed
  • 4 for call is dialing

Get Calls

The following GET request returns calls scheduled to happen in the future.

curl -X GET \
'https://api.carrierx.com/conference/v1/calls' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with a response containing calls scheduled for a future time.

{
    "calls": [
        {
            "accessCode": "111",
            "addressFrom": "\"+15162065319\" ",
            "bridgeName": "MIA-QA-FCC4D",
            "callee": "15162065318",
            "caller": "+15162065319",
            "codec": "PCMU",
            "connectionStatus": 0,
            "created": 1544643810000,
            "customName": "",
            "duration": 171,
            "gainLevel": 0,
            "holdMode": 0,
            "id": 6889184,
            "joined": 1544643810000,
            "meetingNumber": 106131,
            "muteMode": 0,
            "nodeName": "10.2.114.15",
            "presenterMedia": 0,
            "qaMode": 0,
            "role": 1,
            "state": 2
        }
    ],
    "last": 0,
    "offset": 0,
    "total": 1
}

This request returns a list of calls. This request is enabled for Pagination, Result Filtering, and Field Filtering.

Method URL
GET /calls

Get Call by ID

The following GET request returns a call, targeted by secure ID.

curl -X GET \
'https://api.carrierx.com/conference/v1/calls/6889184' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with a call matching the secure ID.

{
    "accessCode": "111",
    "addressFrom": "\"+15162065319\" ",
    "bridgeName": "MIA-QA-FCC4D",
    "callee": "15162065318",
    "caller": "+15162065319",
    "codec": "PCMU",
    "connectionStatus": 0,
    "created": 1544643810000,
    "customName": "",
    "duration": 238,
    "gainLevel": 0,
    "holdMode": 0,
    "id": 6889184,
    "joined": 1544643810000,
    "meetingNumber": 106131,
    "muteMode": 0,
    "nodeName": "10.2.114.15",
    "presenterMedia": 0,
    "qaMode": 0,
    "role": 1,
    "state": 2
}

This request returns details for a specific call.

Method URL
GET /calls/{id}

Path Arguments

Parameter Data Type Description
id required integer The ID of the call.

Update Call

The following PATCH request updates a call.

curl -X PATCH \
'https://api.carrierx.com/conference/v1/calls/6889184' \
-H 'Content-Type: application/json' \
--data-binary '{"customName": "name"}' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code.

{
    "calls": [
        {
            "accessCode": "111",
            "addressFrom": "\"+15162065319\" ",
            "bridgeName": "MIA-QA-FCC4D",
            "callee": "15162065318",
            "caller": "+15162065319",
            "codec": "PCMU",
            "connectionStatus": 0,
            "created": 1544643810000,
            "customName": "",
            "duration": 171,
            "gainLevel": 0,
            "holdMode": 0,
            "id": 6889184,
            "joined": 1544643810000,
            "meetingNumber": 106131,
            "muteMode": 0,
            "nodeName": "10.2.114.15",
            "presenterMedia": 0,
            "qaMode": 0,
            "role": 1,
            "state": 2
        }
    ],
    "last": 0,
    "offset": 0,
    "total": 1
}

This request changes the call state. The call being modified must be scheduled for a future time. Use a PATCH request to update part of the object, and a PUT request to pass and update the entire object.

Method URL
PATCH /calls/{id}
PUT /calls/{id}

Path Arguments

Parameter Data Type Description
id required integer The ID of the call.

Body Arguments

JSON representation of the fields and values to be updated.

Fields that can be changed are:

  • accessCode
  • addressFrom
  • addressTo
  • callee
  • caller
  • codec
  • connectionStatus
  • customName
  • gainLevel
  • holdMode
  • muteMode
  • nodeName
  • operatorMode
  • presenterMedia
  • role
  • state

To view all fields that appear in the Call object, see the Call Object.

Delete Call

The following DELETE request hangs up a call, targeted by secure ID.

curl -X DELETE \
'https://api.carrierx.com/conference/v1/calls/174' \
-u '[your_user_name]:[your_password]'

A successful request returns a 204 response code.

This request hangs up the call.

Method URL
DELETE /calls/{id}

Path Arguments

Parameter Data Type Description
id required integer The ID of the call to be deleted.

DIDs

DIDs are phone numbers rented through CarrierX.

DID Object

This section outlines the DID object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Field Data Type Description
attributes array Additional attributes that can be set to modify a DID. Refer to the table below for a list of preset attributes.
countryCode string The region of the DID. The format for this field is ISO 3166-1 alpha 2.
description string The code of the country in ISO 3166-1 alpha-2 format.
didGroupId string The ID of the DID group to which the DID belongs.
id string The unique ID of a specific DID.
phoneNumber string The phone number in E.164 format.

attributes

Field Data Type Description
name string The attribute name.
description string The attribute description.
type integer The attribute type. Accepted values for this field are as follows:
  • 0 for string (this is the default)
  • 2 for integer
  • 3 for DTMF
  • 4 for role
  • 5 for choice
  • 6 for db reference
  • 7 for upload
enumValues string The possible attribute values if the attribute type is 5.
value string The value of the DID attribute. Accepted values for this field are as follows:
  • 0 for string (this is the default)
  • 2 for integer
  • 3 for DTMF
  • 4 for role
  • 5 for choice
  • 6 for db reference
  • 7 for upload

Get DIDs

The following GET request returns DIDs associated with the endpoint.

curl -X GET \
'https://api.carrierx.com/conference/v1/dids' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns a list of DIDs associated with the Conference endpoint.

{
  "dids": [
      {
          "attributes": [],
          "countryCode": "US",
          "didGroupId": 219,
          "id": 220,
          "phoneNumber": "15162065319",
          "state": -1
      },
      {
          "attributes": [],
          "countryCode": "US",
          "didGroupId": 219,
          "id": 221,
          "phoneNumber": "15162065318",
          "state": -1
      }
  ],
  "last": 1,
  "offset": 0,
  "total": 2
}

This request will return a list of DIDs associated with the specific endpoint. This request is enabled for Pagination, Result Filtering, and Field Filtering.

Method URL
GET /dids

Get DID by ID

The following GET request returns a DID, targeted by secure ID.

curl -X GET \
'https://api.carrierx.com/conference/v1/dids/220' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns a specific DID record matching the DID secure ID.

{
    "attributes": [],
    "countryCode": "US",
    "didGroupId": 219,
    "id": 220,
    "phoneNumber": "15162065319",
    "state": -1
}

This request returns the data associated with the specified DID. This request is enabled for Field Filtering.

Method URL
GET /dids/{id}

Path Arguments

Field Data Type Description
id required integer The ID of the specific DID.

DID Groups

A DID Group is a set of phone numbers rented through CarrierX and associated with a specific conference. The system will automatically assign phone numbers into a DID group when they are routed to a Conference endpoint.

DID Group Object

This section outlines the DID Group object. The attributes listed in the table below will be returned in a JSON object when a successful request has been made.

Parameter Data Type Description
attributes array Refer to the Meeting Attributes section for a comprehensive list of attributes.
callFlowId string The ID of the call flow.
description string The description of the DID group.
dids array An array of the DIDs belonging to the DID group. Each object in the array contains attributes, countryCode, didGroupId, id, phoneNumber, and state. Refer to the table below for a description of these attributes.
id string The ID of the DID group.
name string The name of the DID group.
state integer The state of the DID group.
subscriberSid string The secure ID of the subscriber associated with the DID group.

dids

Parameter Data Type Description
attributes array The DID attributes.
countryCode integer The country code of the DID.
didGroupId integer The DID Group ID.
id integer The DID ID.
phoneNumber string The phone number.
state string The state of the DID.

Get DID Groups

The following GET request returns DID groups associated with the endpoint.

curl -X GET \
'https://api.carrierx.com/conference/v1/didGroups' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns a list of DID Groups associated with the Conference endpoint.

{
    "didGroups": [
        {
            "attributes": [],
            "callFlowId": 3,
            "description": "",
            "dids": [
                {
                    "attributes": [],
                    "countryCode": "US",
                    "didGroupId": 219,
                    "id": 221,
                    "phoneNumber": "15162065319",
                    "state": -1
                },
                {
                    "attributes": [],
                    "countryCode": "US",
                    "didGroupId": 219,
                    "id": 220,
                    "phoneNumber": "15162065318",
                    "state": -1
                }
            ],
            "id": 219,
            "name": "sample_conference_008_didGroup",
            "state": -1,
            "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
        }
    ],
    "last": 0,
    "offset": 0,
    "total": 1
}

This request returns a list of DIDs associated with the specific conference. This request is enabled for Pagination, Result Filtering, and Field Filtering.

Method URL
GET /didGroups

Get DID Group by ID

The following GET request returns DID groups, targeted by secure ID.

curl -X GET \
'https://api.carrierx.com/conference/v1/didGroups/219' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns a DID Group matching the secure ID.

{
    "attributes": [],
    "callFlowId": 3,
    "description": "",
    "dids": [
        {
            "attributes": [],
            "countryCode": "US",
            "didGroupId": 219,
            "id": 221,
            "phoneNumber": "15162065319",
            "state": -1
        },
        {
            "attributes": [],
            "countryCode": "US",
            "didGroupId": 219,
            "id": 220,
            "phoneNumber": "15162065318",
            "state": -1
        }
    ],
    "id": 219,
    "name": "sample_conference_008_didGroup",
    "state": -1,
    "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}

This request returns a DID group targeted by the DID group secure ID.

Method URL
GET /didGroups/{id}

Path Arguments

Parameter Data Type Description
id required integer The ID of the DID group.

Meetings

A Meeting object is generated once a meeting begins. The object only exists as long as the meeting is occuring.

Meeting Object

This section outlines the Meeting object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute Data Type Description
attributes array The meeting attributes. These attributes define the call flow of the meeting. They can be overridden in the DID and Meeting Room objects. Refer to the attributes table below for a description of the object structure. Additionally, refer to the Meeting Attributes section for a comprehensive list of the attributes.
created string The date and time when the meeting was created.
duration integer The number of seconds that have elapsed since the meeting was created.
holdMode integer Whether meeting participants and listeners are on hold. Values that will appear in this field are either 0 or 40. 0 means that no parties are on hold. 40 means that participants and listeners have been placed on hold by the meeting host. When callers are on hold, they will hear music while the hosts have a private discussion. Note that this value does not change. It is reflective of the initial hold state when the meeting starts.
id integer The meeting ID. Note that when using GET, PUT, and DELETE requests, the meetingNumber should be used instead of this value.
isRecording boolean Determines whether or not recording is currently on.
isSecured boolean Determines whether or not the meeting is secured.
meetingNumber integer The meeting number. Note that this is the value used to target a specific meeting in GET, PUT, and DELETE requests.
muteMode integer There are three mute states. The following values reflect which access level parties have been muted:
  • 32 for listeners have been muted
  • 36 for listeners have muted themselves and participants have muted themselves
  • 40 for participants and listeners have been muted
Note that this value does not change in the Meeting object. It is reflective of the initial mute state when the meeting is started.
participantCount integer The number of participants in the meeting.
qaMode integer The state of a Q&A meeting. Possible values in this field are:
  • 0 for meeting has not started yet
  • 1 for active meeting
  • 2 for talking to the next participant in the queue
  • 4 for clearing the queue
state integer The state of the meeting. Possible values in this field are:
  • 0 for completed meeting, or meeting that has not started yet
  • 1 for on hold meeting
  • 2 for active meeting
subscriberName string The name of the first subscriber in the meeting.
type integer Defines whether or not the meeting is participating in distributed meetings. If yes, the field value will be 1 and if no, the field value will be 0.

attributes

Refer to the Meeting Attributes section for a comprehensive list of the attributes. This section describes the structure of the attribute objects.

Parameter Data Type Description
description string The attribute description.
type integer The attribute type. Valid values for this field are:
  • 0 for string (default)
  • 2 for integer
  • 3 for DTMF
  • 4 for role
  • 5 for choice
  • 6 for db reference
  • 7 for upload
enumValues string The possible attribute values if the type is 5.
value string The value of the attribute.
group integer Defines the owner of the attribute. Valid values for this field are:
  • 0 for call flow
  • 1 for DID
  • 2 for meeting room

Get Meetings

The following GET request returns meetings.

curl -X GET \
'https://api.carrierx.com/conference/v1/meetings' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns a list of meetings associated with the Conference endpoint.

{
    "last": 0,
    "meetings": [
        {
            "attributes": [],
            "created": 1544729701000,
            "duration": 48,
            "holdMode": 0,
            "id": 196938,
            "isRecording": false,
            "isSecured": false,
            "meetingNumber": 106131,
            "muteMode": 32,
            "participantCount": 1,
            "qaMode": 0,
            "state": 2,
            "subscriberName": "John Smith",
            "type": 1
        }
    ],
    "offset": 0,
    "total": 1
}

This request returns a list of active meetings. This request is enabled for Pagination, Result Filtering, and Field Filtering.

Method URL
GET /meetings

Get Meeting by meetingNumber

The following GET request returns a meeting, targeted by meetingNumber.

curl -X GET \
'https://api.carrierx.com/conference/v1/meetings/106131' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns a meeting matching the meetingNumber.

{
    "attributes": [],
    "created": 1544742875000,
    "duration": 504,
    "holdMode": 0,
    "id": 196939,
    "isRecording": false,
    "isSecured": false,
    "meetingNumber": 106131,
    "muteMode": 32,
    "participantCount": 1,
    "qaMode": 0,
    "state": 2,
    "subscriberName": "John Smith",
    "type": 1
}

This request returns a Meeting object, targeted by the meetingNumber. The meetingNumber is passed in the query URL. Note that the id should not be used to target the meeting. This request is enabled for Field Filtering.

Method URL
GET /meetings/{meetingNumber}

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting number.

Get Meeting Attributes

The following GET request returns meeting attributes for a specific meeting targeted by meetingNumber.

curl -X GET \
'https://api.carrierx.com/conference/v1/meetings/111/attributes?limit=5' \
-u '[your_user_name]:[your_password]'

A successful 200 response code returns meeting attributes for the meeting matching the targeted meetingNumber.

[
    {
        "name": "conference_exittones",
        "value": "on"
    },
    {
        "name": "conference_qa_policy",
        "value": "p"
    },
    {
        "name": "conf_participants_count",
        "value": "0"
    },
    {
        "name": "conf_hosts_count",
        "value": "1"
    },
    {
        "name": "conf_listeners_count",
        "value": "0"
    },
    {
        "name": "participant_list",
        "value": "5626245432:15162065310:'2756'"
    }
]

This request returns a list of call flow attributes associated with the specified meeting. Pass the meetingNumber in the query URL. This request is enabled for Pagination, Result Filtering, and Field Filtering.

Method URL
GET /meetings/{meetingNumber}/attributes

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting number.

Update Meeting

The following PUT request will update the values included in the request body. This request is targeted by meetingNumber.

curl -X PUT \
'https://api.carrierx.com/conference/v1/meetings/106131' \
-H 'Content-Type: application/json' \
--data-binary '{"pollingMode": {"status": 2}}' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with a serialized copy of the Meeting object.

{
    "attributes": [],
    "created": 1544742875000,
    "duration": 23,
    "holdMode": 0,
    "id": 196939,
    "isRecording": false,
    "isSecured": false,
    "meetingNumber": 106131,
    "muteMode": 32,
    "participantCount": 1,
    "qaMode": 0,
    "state": 2,
    "subscriberName": "John Smith",
    "type": 1
}

This request is used to change the state of a meeting. Note that the meetingNumber and not the id is passed in the path arguments.

Method URL
PUT /meetings/{meetingNumber}

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting number.

Body Arguments

JSON representation of the fields and values of the meeting to be updated.

Fields that can be changed are:

  • attributes
  • holdMode
  • isRecording
  • isSecured
  • muteMode

To view of all fields that appear in the Meeting object, see the Meeting Object.

Delete Meeting

The following DELETE request deletes a meeting, targeted by meetingNumber.

curl -X DELETE \
'https://api.carrierx.com/conference/v1/meetings/106131' \
-u '[your_user_name]:[your_password]'

A successful response will return a 204 status code.

This request drops all calls from a meeting and deletes the meeting instance. The meetingNumber is passed in the query URL. Note that the id is not used to target the meeting.

Method URL
DELETE /meetings/{meetingNumber}

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting number.

Meeting Rooms

Meeting rooms hold meeting configurations, overridden call flow values, and contain role information. Access codes are also set at the Meeting Room object level. These are DTMF sequences entered by callers, and determine the role of the caller. The three roles are: host, participant, and listener. For example, a caller may enter an access code for a host role and gain the ability to mute participants and listeners.

Meeting Room Object

This section outlines the Meeting Room object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Field Data Type Description
attributes array Preset attributes that can be modified. Please refer to the Meeting Attributes section for a comprehensive list of attributes.
didGroupReferences array Data about the DID Group associated with the meeting room. This information includes the didGroupId and state. Refer to the table below for more information.
callFlowId string The ID of the call flow. This field is required to create a new meeting room.
keychain array Contains the access codes and matching roles. Please refer to the table below for more information. The keychain array can be modified through a PUT request. When creating a PUT request, include accessCode and role.
meetingNumber integer The meeting number. This number is used in GET, PUT, and DELETE requests.
primaryDidGroupId integer The DID Group associated with the meeting.
subscriberSid string The secure ID of the subscriber.

didGroupReferences

The didGroupReference array contains the didGroupId and state. The didGroupId references the DID group containing the phone numbers that can be dialed to access a Meeting Room.

Field Data Type Description
didGroupId integer The DID Group ID.
state integer The state of the DID Group. Accepted values in this field are:
  • 0 for active (default)
  • 1 for invalidated
  • 2 for disabled

keychain

The keychain array holds the meeting access codes. The three access levels are host, participant, and listener. Note that there can be multiple access codes for each access level.

Field Data Type Description
accessCode string The DTMF sequence that callers enter to access a meeting. This sequence is customizable.
id integer The ID of the access code and role association.
role integer The role associated with the access code. Accepted values in this field are:
  • 1 for host
  • 2 for participant
  • 3 for listener

Create Meeting Room

The following POST request creates a new meeting room.

curl -X POST \
'https://api.carrierx.com/conference/v1/meetingRooms' \
-H 'Content-Type: application/json' \
--data-binary '{"primaryDidGroupId": 219, "callFlowId": 3}' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code and a serialized copy of the new Meeting Room object.

{
    "attributes": [],
    "created": 1544482680000,
    "didGroupReferences": [
        {
            "didGroupId": 219,
            "state": 0
        }
    ],
    "keychain": [],
    "meetingNumber": 273751,
    "primaryDidGroupId": 219,
    "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}

This request creates a new meeting room using the data passed in the query body. To create a meeting room, primaryDidGroupId and callFlowId are required. This information can be found by sending a GET request to the didGroups URL. Refer to the Get DID Group section for more information. The response will contain an id, which will be passed in the body parameter as primaryDidGroupId. The returned callFlowId will also need to be passed in the body when creating a new meeting room.

Note that the meetingNumber is not the meeting access code. The access codes for each access level are stored in the keychain array.

Method URL
POST /meetingRooms

Body Arguments

JSON representation of the fields and values of the Meeting Room object to be created. Required fields to create a Meeting Room object are primaryDidGroupId and callFlowId.

To view all fields that appear in the Meeting Room object, see the Meeting Room Object.

Get Meeting Rooms

The following GET request returns meeting rooms.

curl -X GET \
'https://api.carrierx.com/conference/v1/meetingRooms?excludeFields=attributes' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code and a list of meeting rooms.

{
    "last": 0,
    "meetingRooms": [
        {
            "created": 1544482680000,
            "didGroupReferences": [
                {
                    "didGroupId": 219,
                    "state": 0
                }
            ],
            "keychain": [],
            "meetingNumber": 273751,
            "primaryDidGroupId": 219,
            "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
        }
    ],
    "offset": 0,
    "total": 1
}

This request returns a list of meeting rooms. This request is enabled for Pagination, Result Filtering, and Field Filtering.

Method URL
GET /meetingRooms

Get Meeting Room by meetingNumber

The following GET request returns a meeting room, targeted by meetingNumber.

curl -X GET \
'https://api.carrierx.com/conference/v1/meetingRooms/273751?excludeFields=attributes' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with a Meeting Room object targeted by meetingNumber.

{
    "attributes": [],
    "created": 1544482680000,
    "didGroupReferences": [
        {
            "didGroupId": 219,
            "state": 0
        }
    ],
    "keychain": [],
    "meetingNumber": 273751,
    "primaryDidGroupId": 219,
    "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}

This request returns information about a meeting room. Note that the response to this request will return an extensive list of attributes when no filters have been applied. This request is enabled for Field Filtering.

Method URL
GET /meetingRooms/{meetingNumber}

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting room number.

Update Meeting Room

The following PATCH request updates a meeting room, targeted by meetingNumber.

curl -X PATCH \
'https://api.carrierx.com/conference/v1/meetingRooms/273751' \
-H 'Content-Type: application/json' \
--data-binary '{"description":"Another description"}' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with a serialized copy of the updated Meeting Room object.

{
    "attributes": [],
    "created": 1544482680000,
    "description": "Another description",
    "didGroupReferences": [
        {
            "didGroupId": 219,
            "state": 0
        }
    ],
    "keychain": [],
    "meetingNumber": 273751,
    "primaryDidGroupId": 219,
    "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}

This request updates an existing meeting room. A meeting room can be updated using either a PATCH or PUT request. A PATCH request requires only the fields to be updated be passed. A PUT request requires the entire meeting room object be passed.

Method URL
PATCH /meetingRooms/{meetingNumber}
PUT /meetingRooms/{meetingNumber}

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting room number.

Body Arguments

JSON representation of the fields and values of the meeting room to be updated.

Fields that can be changed are:

  • attributes
  • didGroupReferences
  • keychain
  • meetingNumber
  • primaryDidGroupId

To view all fields that appear in the Meeting Room object, see the Meeting Room Object.

Delete Meeting Room

The following DELETE request deletes a meeting room, targeted by MeetingNumber.

curl -X DELETE \
'https://api.carrierx.com/conference/v1/meetingRooms/452650' \
-u '[your_user_name]:[your_password]'

A successful response will return a 204 status code.

This request deletes a meeting room.

Method URL
GET /meetingRooms/{meetingNumber}

Path Arguments

Parameter Data Type Description
meetingNumber required integer The meeting room number.

Meeting Attributes

The following request is an example of how to update a meeting attribute for a meeting room. Note that you can also add attributes on the DID Group object and DID object.

curl -X PATCH \
'https://api.carrierx.com/conference/v1/meetingRooms/452650' \
-H 'Accept: application/json' \
--data-binary '{"attributes":[{"name":"call_maxduration","value":120}]}' \
-u '[your_user_name]:[your_password]'

A successful response will return a 200 status code with a copy of the Meeting Room object.

{
    "attributes": [
        {
            "description": "Maximal calls duration (s)",
            "group": 0,
            "name": "call_maxduration",
            "value": "120"
        }
    ],
    "created": 1568822760000,
    "description": "another_meeting_room",
    "didGroupReferences": [
        {
            "didGroupId": 2325,
            "state": 0
        }
    ],
    "keychain": [
        {
            "accessCode": "666",
            "id": 5302,
            "role": 3
        },
        {
            "accessCode": "444",
            "id": 5300,
            "role": 1
        },
        {
            "accessCode": "555",
            "id": 5301,
            "role": 2
        }
    ],
    "meetingNumber": 508005,
    "primaryDidGroupId": 4425,
    "subscriberSid": "cxDD96hPO-bGt6TvLlluid23UQs01Djz"
}

The following are meeting attributes that can be applied on the Meeting Room, DID Group, or DID object levels. For each of these levels, the meeting attributes will be passed as a value of attributes as an array of objects.

This will look like the following format: "attributes":[{"name":"call_maxduration","value":120}].

Some fields accept a string containing the first letter of the access level name. The three access levels are host, participant, or listener. To enable a feature for all three access levels, enter the string hpl. Alternatively, to enable the feature for one access level, enter the first letter of the word. For example, participant is p.

Attributes List

Attribute Data Type Description Where to Set
call_announceparticipantcount string Determines for which access levels the number of participants will be announced upon entering the meeting room. Enter the access levels as a string. Meeting Room object, DID Group object
call_associate_dtmf string Determines which access levels will be able to associate calls. Meeting Room object, DID Group object
call_associate_dtmf_binding string The DTMF sequence to associate audio. DID Group object
call_delay integer The number of seconds to delay before the call is answered. DID Group object, DID object
call_exit_dtmf string Determines which access levels will be able to enter the DTMF sequence to leave a call. The DTMF sequence is set as call_exit_dtmf_binding. Meeting Room object, DID Group object
call_exit_dtmf_binding string Determines the DTMF sequence that will trigger exiting a call when call_exit_dtmf is enabled. DID Group object
call_instructions_dtmf string Determines which access levels will be able to enter the DTMF sequence to access the help playback. Enter the access levels as a string for the field value. The DTMF sequence is set as call_instructions_dtmf_binding. Meeting Room object, DID Group object
call_instructions_dtmf_binding string The DTMF sequence that will trigger the help playback for the access levels designated in call_instructions_dtmf. DID Group object
call_jobcodeonenter string Determines whether or not the caller will be prompted for a job code prior to entering the meeting. Accepted values in this field are on and off. Meeting Room object, DID Group object
call_maxduration integer The maximum duration of the call. Meeting Room object, DID Group object
call_mute_dtmf string Determines which access levels can mute themselves. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
call_mute_dtmf_binding string The DTMF sequence that triggers self muting. DID Group object
call_operator_after integer Determines how many times an unsuccessful attempt can be made to enter the access code. Enter -1 to allow unlimited amounts of unsuccessful attempts. DID Group object
call_operator_dtmf string Determines which access levels can call the operator. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
call_operator_dtmf_binding string The DTMF sequence that triggers a call to the operator. DID Group object
call_participantsnumber_dtmf string Determines which access levels can enter the DTMF sequence to hear the number of participants currently in the conference. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
call_participantsnumber_dtmf_binding string The DTMF sequence that triggers stating the number of participants in the conference. DID Group object
conference_appspecific string Application-specific data. Meeting Room object, DID Group object
conference_callerdb string The callers database. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_country string The conference country. Meeting Room object, DID Group object
conference_distributed string Determines whether or not distributed conferencing is enabled. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_entryexittones_dtmf string Determines which access levels can change the entry and exit tone by entering a DMTF sequence. Entering the DTMF sequence will alternate through the following combinations: ON:ON, ON:OFF, OFF:ON, and OFF:OFF. Meeting Room object, DID Group object
conference_entryexittones_dtmf_binding string The DTMF sequence that triggers the change between the tone combinations outlined in conference_entryexittones_dtmf. DID Group object
conference_entrytones string Determines whether or not a noise will be played when a new participant joins the conference. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_exittones string Determines whether or not a noise will be played when a new participant exits the conference. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_hold_dtmf string Determines which access levels will be able to put a conference on hold. Meeting Room object, DID Group object
conference_hold_dtmf_binding string The DTMF sequence that will trigger putting a conference on hold. DID Group object
conference_hold_policy string Determines which access levels will be on hold at the beginning of the conference. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_jobcode_dtmf string Allows participants to enter the * key during a conference followed by a job code. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_jobcode_dtmf_binding string The DTMF sequence to trigger entering a job code. DID Group object
conference_language string Determines the language of the meeting. The default value is EN. Refer to the table below for all of the currently supported languages. Meeting Room object, DID Group object
conference_lock_dtmf string Determines which access levels can lock a conference, meaning that no more participants can join. Note that hosts are still able to join even if lock is enabled. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_lock_dtmf_binding string The DTMF sequence that triggers locking a conference. DID Group object
conference_maxcalls integer The maximum number of calls per conference. Meeting Room object, DID Group object
conference_maxcallsperrole string The maximum number of calls per role per conference. The following denotes that there can be an unlimited amount of calls from each role: -1:-1:-1. Meeting Room object, DID Group object
conference_maxduration integer The maximum duration of the conference. To enable the conference to endure indefinitely, assign the value -1. Meeting Room object, DID Group object
conference_mute_dtmf string Determines which access levels are able to mute other participants. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_mute_dtmf_binding string The DTMF sequence to trigger muting other participants. DID Group object
conference_mute_policy string Defines which roles will be muted at the beginning of the conference. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_qa_dtmf string Determines which access levels can start a Q&A session. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_qa_dtmf_binding string The DTMF sequence to trigger starting a Q&A session. DID Group object
conference_qa_policy string Determines which access levels will be muted when a Q&A session is started. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_realtime string Defines whether or not the conference generates real time notifications, which allows viewing attendee lists and controlling the conference from a computer. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_recording string Defines whether or not a recording will begin once the meeting starts. Accepted values in this field are on, off, and auto. auto means that the recording will begin as soon as the conference begins. Meeting Room object, DID Group object
conference_rollcall string Determines whether or not participants will be prompted to record their names upon entering the conference. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_rollcall_onenter string Determines whether or not the recordings of participants saying their names will be played upon entering the conference. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_rollcall_onexit string Determines whether or not recordings of the participants saying their names will be played upon exiting the conference. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_schedule string The conference schedule. Meeting Room object, DID Group object
conference_schedule_extend string The conference schedule extended maximum time in seconds. DID Group object
conference_schedule_extend_dtmf string Defines the access levels that will be able to extend a conference schedule. Meeting Room object, DID Group object
conference_schedule_extend_dtmf_binding string The DMTF sequence that will trigger extending the conference schedule. DID Group object
conference_schedule_hold integer The amount of time in seconds to wait before the scheduled conference begins. Meeting Room object, DID Group object
conference_schedule_remind integer The amount of time in seconds to wait before the scheduled conference reminder. Meeting Room object, DID Group object
conference_scheduled string Defines whether or not a conference is scheduled. Accepted values in this field are on and off. Meeting Room object, DID Group object
conference_start_how string Determines when the conference will begin. Accepted string values in this field are first, moderator, and explicit. Meeting Room object, DID Group object
conference_start_wait integer The number of seconds to wait before starting a meeting when a moderator has not entered the meeting. Meeting Room object, DID Group object
conference_stop_how string Determines whether the meeting will end when the moderator exits, or when the last participant exits. Accepted string values in this field are last and moderator. Meeting Room object, DID Group object
conference_stop_wait integer The number of seconds to wait before stopping the conference after the host disconnects. Meeting Room object, DID Group object
conference_video_policy string Determines which access levels will have video enabled at the beginning of a conference. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
conference_whitelist string Defines whether or not the conference has a white list. Accepted values in this field are on and off. Meeting Room object, DID Group object
dnis_welcomeprompt URL The URL to a recorded greeting. DID Group object, DID object
polling_dtmf string Determines which access levels can start a polling vote. Meeting Room object, DID Group object
polling_dtmf_binding string The DTMF sequence to trigger starting a polling vote. DID Group object
recording_addr string The recording server address. DID Group object
recording_dtmf string Determines which access levels are able to start a recording. Enter the access levels as a string for the field value. Meeting Room object, DID Group object
recording_dtmf_binding string Defines the DTMF sequence that triggers starting a recording of the meeting. DID Group object
recording_metadata string Defines the recording metadata passing method. Values accepted in this field are contact and custom. DID Group object
recording_method string Determines the recording method. Values accepted in this field are: remote, remote+pin, local, and local+pin. DID Group object
recording_stop_how string Determines the recording method. Values accepted in this field are: last and moderator. Meeting Room object, DID Group object
recording_stop_wait integer Defines the amount of seconds to wait before stopping recording after the moderator has left the conference. Meeting Room object, DID Group object
recording_stop_wait integer Defines the amount of seconds to wait before stopping recording after the moderator has left the conference. Meeting Room object, DID Group object
recording_stop_wait integer Defines the amount of seconds to wait before stopping recording after the moderator has left the conference. Meeting Room object, DID Group object

conference_language

Code Language
EN English (default)
AR Argentinian
DE German
EL Greek
ES Spanish (Spain)
ES-LATAM Spanish (Latin America)
FR French
GB British English
HE Vietnamese
IT Italy
JA Japanese
KO Korean
NL Dutch
PT Portuguese (Portugal)
PT-BR Portuguese (Brazil)
RU Russian
TR Turkish
UA Ukrainian
UK Ukrainian (Ukraine)
ZH Chinese