Webex · Example Payload

Webex Updatemeeting Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Updatemeeting 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

Raw ↑
{
  "operationId": "updateMeeting",
  "method": "PUT",
  "path": "/meetings/{meetingId}",
  "summary": "Update a Meeting",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "title": "Example Daily Meeting Modified",
        "agenda": "Example Agenda Modified",
        "password": "P@ssword789",
        "timezone": "Asia/Shanghai",
        "start": "2020-01-27T20:30:00+08:00",
        "end": "2020-01-27T21:30:00+08:00",
        "enabledAutoRecordMeeting": true,
        "allowAnyUserToBeCoHost": true,
        "enabledJoinBeforeHost": true,
        "enableConnectAudioBeforeHost": true,
        "joinBeforeHostMinutes": 15,
        "excludePassword": false,
        "publicMeeting": false,
        "reminderTime": 30,
        "unlockedMeetingJoinSecurity": "allowJoin",
        "enableAutomaticLock": false,
        "automaticLockMinutes": 0,
        "allowFirstUserToBeCoHost": false,
        "allowAuthenticatedDevices": true,
        "sendEmail": true,
        "hostEmail": "john.andersen@example.com",
        "meetingOptions": {
          "enabledChat": true,
          "enabledVideo": true,
          "enabledPolling": false,
          "enabledNote": true,
          "noteType": "allowAll",
          "enabledFileTransfer": false,
          "enabledUCFRichMedia": false
        },
        "attendeePrivileges": {
          "enabledShareContent": true,
          "enabledSaveDocument": false,
          "enabledPrintDocument": false,
          "enabledAnnotate": false,
          "enabledViewParticipantList": true,
          "enabledViewThumbnails": false,
          "enabledRemoteControl": true,
          "enabledViewAnyDocument": false,
          "enabledViewAnyPage": false,
          "enabledContactOperatorPrivately": false,
          "enabledChatHost": true,
          "enabledChatPresenter": true,
          "enabledChatOtherParticipants": true
        },
        "integrationTags": [
          "dbaeceebea5c4a63ac9d5ef1edfe36b9",
          "85e1d6319aa94c0583a6891280e3437d",
          "27226d1311b947f3a68d6bdf8e4e19a1"
        ],
        "enabledBreakoutSessions": true,
        "trackingCodes": [
          {
            "name": "Department",
            "value": "Sales"
          },
          {
            "name": "Division",
            "value": "Part-time"
          }
        ],
        "enabledAudioWatermark": true,
        "enabledVisualWatermark": true,
        "visualWatermarkOpacity": 40,
        "audioConnectionOptions": {
          "audioConnectionType": "VoIP",
          "enabledTollFreeCallIn": false,
          "enabledGlobalCallIn": false,
          "enabledAudienceCallBack": true,
          "entryAndExitTone": "beep",
          "allowHostToUnmuteParticipants": true,
          "allowAttendeeToUnmuteSelf": false,
          "muteAttendeeUponEntry": true
        },
        "enabledLiveStream": true,
        "liveStream": {
          "destination": "Youtube",
          "rtmpUrl": "rtmps://example.com:1935/MediaLive/WebexStreaming",
          "streamUrl": "https://example.com/Webex-Streaming/index_a.m3u8",
          "layoutWithoutSharedContent": "grid",
          "layoutWithSharedContent": "stack",
          "allowChangeLayoutInMeeting": false,
          "followStageLayoutWhenSynced": true,
          "resolution": "1920x1080"
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json;charset=UTF-8",
      "example": {
        "id": "1d824a4a205042eba9574e00b711b226_20200127T120000Z",
        "meetingSeriesId": "1d824a4a205042eba9574e00b711b226",
        "meetingNumber": "123456789",
        "title": "Example Daily Meeting Modified",
        "agenda": "Example Agenda Modified",
        "password": "P@ssword789",
        "phoneAndVideoSystemPassword": "12345678",
        "meetingType": "scheduledMeeting",
        "state": "scheduled",
        "isModified": true,
        "timezone": "Asia/Shanghai",
        "start": "2020-01-27T20:30:00+08:00",
        "end": "2020-01-27T21:30:00+08:00",
        "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
        "hostDisplayName": "John Andersen",
        "hostEmail": "john.andersen@example.com",
        "hostKey": "123456",
        "siteUrl": "site4-example.webex.com",
        "webLink": "https://site4-example.webex.com/site4/j.php?MTID=m31a1db24db78ac569f739e0cfb2741c1",
        "sipAddress": "123456789@site4-example.webex.com",
        "dialInIpAddress": "192.168.100.100",
        "enabledAutoRecordMeeting": true,
        "allowAnyUserToBeCoHost": true,
        "enabledJoinBeforeHost": true,
        "enableConnectAudioBeforeHost": true,
        "joinBeforeHostMinutes": 15,
        "excludePassword": false,
        "publicMeeting": false,
        "reminderTime": 30,
        "unlockedMeetingJoinSecurity": "allowJoin",
        "sessionTypeId": 3,
        "enableAutomaticLock": false,
        "automaticLockMinutes": 0,
        "allowFirstUserToBeCoHost": false,
        "allowAuthenticatedDevices": true,
        "telephony": {
          "accessCode": "1234567890",
          "callInNumbers": [
            {
              "label": "US Toll",
              "callInNumber": "123456789",
              "tollType": "toll"
            }
          ],
          "links": [
            {
              "rel": "globalCallinNumbers",
              "href": "/api/v1/meetings/1d824a4a205042eba9574e00b711b226_20200127T120000Z/globalCallinNumbers",
              "method": "GET"
            }
          ]
        },
        "meetingOptions": {
          "enabledChat": true,
          "enabledVideo": true,
          "enabledPolling": false,
          "enabledNote": true,
          "noteType": "allowAll",
          "enabledFileTransfer": false,
          "enabledUCFRichMedia": false
        },
        "attendeePrivileges": {
          "enabledShareContent": true,
          "enabledSaveDocument": false,
          "enabledPrintDocument": false,
          "enabledAnnotate": false,
          "enabledViewParticipantList": true,
          "enabledViewThumbnails": false,
          "enabledRemoteControl": true,
          "enabledViewAnyDocument": false,
          "enabledViewAnyPage": false,
          "enabledContactOperatorPrivately": false,
          "enabledChatHost": true,
          "enabledChatPresenter": true,
          "enabledChatOtherParticipants": true
        },
        "registration": {
          "autoAcceptRequest": false,
          "requireFirstName": true,
          "requireLastName": true,
          "requireEmail": true,
          "requireJobTitle": false,
          "requireCompanyName": true,
          "requireAddress1": false,
          "requireAddress2": false,
          "requireCity": false,
          "requireState": false,
          "requireZipCode": false,
          "requireCountryRegion": true,
          "requireWorkPhone": true,
          "requireFax": false,
          "enabledRegistrationId": false
        },
        "integrationTags": [
          "dbaeceebea5c4a63ac9d5ef1edfe36b9",
          "85e1d6319aa94c0583a6891280e3437d",
          "27226d1311b947f3a68d6bdf8e4e19a1"
        ],
        "scheduledType": "meeting",
        "simultaneousInterpretation": {
          "enabled": true,
          "interpreters": [
            {
              "id": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
              "languageCode1": "en",
              "languageCode2": "de",
              "email": "marcus.hoffmann@example.com",
              "displayName": "Hoffmann"
            }
          ]
        },
        "enabledBreakoutSessions": true,
        "links": [
          {
            "rel": "breakoutSessions",
            "href": "/v1/meetings/1d824a4a205042eba9574e00b711b226/breakoutSessions",
            "method": "GET"
          }
        ],
        "trackingCodes": [
          {
            "name": "Department",
            "value": "Sales"
          },
          {
            "name": "Division",
            "value": "Part-time"
          }
        ],
        "enabledAudioWatermark": true,
        "enabledVisualWatermark": true,
        "visualWatermarkOpacity": 40,
        "audioConnectionOptions": {
          "audioConnectionType": "VoIP",
          "enabledTollFreeCallIn": false,
          "enabledGlobalCallIn": false,
          "enabledAudienceCallBack": true,
          "entryAndExitTone": "beep",
          "allowHostToUnmuteParticipants": true,
          "allowAttendeeToUnmuteSelf": false,
          "muteAttendeeUponEntry": true
        },
        "enabledLiveStream": true,
        "liveStream": {
          "destination": "Youtube",
          "rtmpUrl": "rtmps://example.com:1935/MediaLive/WebexStreaming",
          "streamUrl": "https://example.com/Webex-Streaming/index_a.m3u8",
          "layoutWithoutSharedContent": "grid",
          "layoutWithSharedContent": "stack",
          "allowChangeLayoutInMeeting": false,
          "followStageLayoutWhenSynced": true,
          "resolution": "1920x1080"
        }
      }
    }
  ]
}