Update Audio Options

Updates audio options for the authenticated user.

PUT/v1/meetingPreferences/audio
Body Parameters
defaultAudioType
enumrequired

Default audio type. This attribute can be modified by Update Audio Options API.

webexAudio

Webex audio. This supports telephony and VoIP.

voipOnly

Support only VoIP.

otherTeleconferenceService

Other teleconference service. Details are defined in the otherTeleconferenceDescription parameter.

none

No audio.

otherTeleconferenceDescription
stringrequired

Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified by Update Audio Options API.

enabledGlobalCallIn
booleanrequired

Flag to enable/disable global call ins. Note: If the site does not support global call-ins, you cannot set this option. This attribute can be modified by Update Audio Options API.

enabledTollFree
booleanrequired

Flag to enable/disable call-ins from toll-free numbers. Note: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified by Update Audio Options API.

enabledAutoConnection
booleanrequired

Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to true, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified by Update Audio Options API.

audioPin
string

PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified by Update Audio Options API.

officeNumber
PhoneNumberObjectrequired

Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by Update Audio Options API.

mobileNumber
PhoneNumberObjectrequired

Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by Update Audio Options API.

Response Properties
defaultAudioType
enum

Default audio type. This attribute can be modified by Update Audio Options API.

webexAudio

Webex audio. This supports telephony and VoIP.

voipOnly

Support only VoIP.

otherTeleconferenceService

Other teleconference service. Details are defined in the otherTeleconferenceDescription parameter.

none

No audio.

otherTeleconferenceDescription
string

Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified by Update Audio Options API.

enabledGlobalCallIn
boolean

Flag to enable/disable global call ins. Note: If the site does not support global call-ins, you cannot set this option. This attribute can be modified by Update Audio Options API.

enabledTollFree
boolean

Flag to enable/disable call-ins from toll-free numbers. Note: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified by Update Audio Options API.

enabledAutoConnection
boolean

Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to true, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified by Update Audio Options API.

audioPin
string

PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified by Update Audio Options API.

officeNumber
PhoneNumberObject

Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by Update Audio Options API.

mobileNumber
PhoneNumberObject

Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by Update Audio Options API.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
PUT
/v1/meetingPreferences/audio
Log in to try the API.
Header
Body
  • Default audio type. This attribute can be modified by `Update Audio Options` API.
  • Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified by `Update Audio Options` API.
  • Flag to enable/disable global call ins. ***Note***: If the site does not support global call-ins, you cannot set this option. This attribute can be modified by `Update Audio Options` API.
  • Flag to enable/disable call-ins from toll-free numbers. ***Note***: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified by `Update Audio Options` API.
  • Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to `true`, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified by `Update Audio Options` API.
  • PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified by `Update Audio Options` API.
  • Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by `Update Audio Options` API.
  • Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by `Update Audio Options` API.
{
    "defaultAudioType": "webexAudio",
    "otherTeleconferenceDescription": "alxm2",
    "enabledGlobalCallIn": true,
    "enabledTollFree": false,
    "enabledAutoConnection": false,
    "audioPin": "1314",
    "officeNumber": {
        "countryCode": "123",
        "number": "123456",
        "enabledCallInAuthentication": false,
        "enabledCallMe": false
    },
    "mobileNumber": {
        "countryCode": "1",
        "number": "10000000000",
        "enabledCallInAuthentication": false,
        "enabledCallMe": true
    }
}
200 / OK
{
    "defaultAudioType": "webexAudio",
    "otherTeleconferenceDescription": "alxm2",
    "enabledGlobalCallIn": true,
    "enabledTollFree": false,
    "enabledAutoConnection": false,
    "audioPin": "1314",
    "officeNumber": {
        "countryCode": "123",
        "number": "123456",
        "enabledCallInAuthentication": false,
        "enabledCallMe": false
    },
    "mobileNumber": {
        "countryCode": "1",
        "number": "10000000000",
        "enabledCallInAuthentication": false,
        "enabledCallMe": true
    }
}