Webex · Example Payload
Webex Get Meeting Preference Details Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Get Meeting Preference Details Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload

{
  "operationId": "Get Meeting Preference Details",
  "method": "GET",
  "path": "/meetingPreferences",
  "summary": "Get Meeting Preference Details",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json;charset=UTF-8",
      "example": {
        "audio": {
          "defaultAudioType": "webexAudio",
          "otherTeleconferenceDescription": "Example Description",
          "enabledGlobalCallIn": true,
          "enabledTollFree": false,
          "enabledAutoConnection": false,
          "audioPin": "1314",
          "officeNumber": {
            "countryCode": "123",
            "number": "123456",
            "enabledCallInAuthentication": false,
            "enabledCallMe": false
          },
          "mobileNumber": {
            "countryCode": "1",
            "number": "123456789",
            "enabledCallInAuthentication": false,
            "enabledCallMe": true
          }
        },
        "video": {
          "videoDevices": [
            {
              "deviceName": "device1",
              "deviceAddress": "device1@example.com",
              "isDefault": false
            },
            {
              "deviceName": "device2",
              "deviceAddress": "device2@example.com",
              "isDefault": true
            }
          ]
        },
        "schedulingOptions": {
          "enabledJoinBeforeHost": false,
          "joinBeforeHostMinutes": 0,
          "enabledAutoShareRecording": false,
          "enabledWebexAssistantByDefault": false,
          "delegateEmails": [
            "marcus.hoffmann@example.com",
            "brenda.song@example.com"
          ]
        },
        "sites": [
          {
            "siteUrl": "site1-example.webex.com",
            "default": false
          },
          {
            "siteUrl": "site2-example.webex.com",
            "default": false
          },
          {
            "siteUrl": "site3-example.webex.com",
            "default": false
          },
          {
            "siteUrl": "site4-example.webex.com",
            "default": true
          }
        ],
        "personalMeetingRoom": {
          "topic": "John's PMR",
          "hostPin": "4325",
          "enabledAutoLock": false,
          "autoLockMinutes": 10,
          "enabledNotifyHost": true,
          "supportCoHost": true,
          "supportAnyoneAsCoHost": false,
          "allowFirstUserToBeCoHost": false,
          "allowAuthenticatedDevices": false,
          "coHosts": [
            {
              "email": "john.andersen@example.com",
              "displayName": "John Andersen"
            }
          ],
          "personalMeetingRoomLink": "https://site4-example.webex.com/meet/john",
          "sipAddress": "john.andersen@example.com",
          "dialInIpAddress": "192.168.100.100",
          "telephony": {
            "accessCode": "1234567890",
            "callInNumbers": [
              {
                "label": "US Toll",
                "callInNumber": "123456789",
                "tollType": "toll"
              }
            ],
            "links": [
              {
                "rel": "globalCallinNumbers",
                "href": "/v1/meetings/0fc6ec1109e0d9b6c94e1f6caccda976/globalCallinNumbers",
                "method": "GET"
              }
            ]
          }
        }
      }
    },
    {
      "status": "403",
      "contentType": "application/json;charset=UTF-8",
      "example": {
        "message": "The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses.",
        "errors": [
          {
            "description": "Not permitted to view or change other user's preferences."
          }
        ],
        "trackingId": "B4A8FB611CFE4BF697CC49B345730269_1572666125876"
      }
    }
  ]
}