Webex · Example Payload
Webex Createmeeting Example
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Createmeeting 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": "createMeeting",
"method": "POST",
"path": "/meetings",
"summary": "Create a Meeting",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"start": "2019-11-01 20:00:00",
"end": "2019-11-01 21:00:00",
"timezone": "Asia/Shanghai",
"recurrence": "FREQ=DAILY;INTERVAL=1;COUNT=10",
"enabledAutoRecordMeeting": false,
"allowAnyUserToBeCoHost": false,
"enabledJoinBeforeHost": false,
"enableConnectAudioBeforeHost": false,
"joinBeforeHostMinutes": 0,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 10,
"unlockedMeetingJoinSecurity": "allowJoin",
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": false,
"invitees": [
{
"email": "john.andersen@example.com",
"displayName": "John Andersen",
"coHost": false,
"panelist": false
},
{
"email": "brenda.song@example.com",
"displayName": "Brenda Song",
"coHost": false,
"panelist": false
}
],
"sendEmail": true,
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"registration": {
"requireFirstName": true,
"requireLastName": true,
"requireEmail": true,
"requireCompanyName": true,
"requireCountryRegion": false,
"requireWorkPhone": true,
"enabledRegistrationId": false,
"customizedQuestions": [
{
"question": "What color do you like?",
"required": true,
"type": "checkbox",
"options": [
{
"value": "green"
},
{
"value": "black"
},
{
"value": "yellow"
},
{
"value": "red"
}
],
"rules": [
{
"condition": "notEquals",
"value": "red",
"result": "reject",
"matchCase": true
}
]
},
{
"question": "Project Team",
"type": "singleLineTextBox",
"maxLength": 120
},
{
"question": "How are you",
"type": "multiLineTextBox"
},
{
"question": "Dropdownlist Q",
"type": "dropdownList",
"options": [
{
"value": "A1"
},
{
"value": "A2"
}
]
},
{
"question": "weather",
"required": false,
"type": "radioButtons",
"maxLength": 120,
"options": [
{
"value": "sunny"
},
{
"value": "rain"
}
]
}
],
"rules": [
{
"question": "lastName",
"condition": "endsWith",
"value": "tom",
"result": "reject",
"matchCase": false,
"order": 1
}
]
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"simultaneousInterpretation": {
"enabled": true,
"interpreters": [
{
"languageCode1": "en",
"languageCode2": "de",
"email": "marcus.hoffmann@example.com",
"displayName": "Hoffmann"
},
{
"languageCode1": "en",
"languageCode2": "fr",
"email": "antoine.martin@example.com",
"displayName": "Martin"
}
]
},
"enabledBreakoutSessions": true,
"breakoutSessions": [
{
"name": "Breakout Session 1",
"invitees": [
"rachel.green@example.com",
"monica.geller@example.com"
]
},
{
"name": "Breakout Session N",
"invitees": [
"ross.geller@example.com",
"chandler.bing@example.com"
]
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Full-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"scheduledType": "meeting",
"audioConnectionOptions": {
"audioConnectionType": "VoIP"
},
"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": "870f51ff287b41be84648412901e0402",
"meetingNumber": "123456789",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"phoneAndVideoSystemPassword": "12345678",
"meetingType": "meetingSeries",
"state": "active",
"timezone": "Asia/Shanghai",
"start": "2019-11-01T20:00:00+08:00",
"end": "2019-11-01T21:00:00+08:00",
"recurrence": "FREQ=DAILY;COUNT=10;INTERVAL=1",
"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=md41817da6a55b0925530cb88b3577b1e",
"registerLink": "https://cisco.webex.com/weblink/register/r55981368ee48e2a6f00b93231508c404",
"sipAddress": "123456789@site4-example.webex.com",
"dialInIpAddress": "192.168.100.100",
"enabledAutoRecordMeeting": false,
"allowAnyUserToBeCoHost": false,
"enabledJoinBeforeHost": false,
"enableConnectAudioBeforeHost": false,
"joinBeforeHostMinutes": 0,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 10,
"unlockedMeetingJoinSecurity": "allowJoin",
"sessionTypeId": 3,
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": false,
"telephony": {
"accessCode": "1234567890",
"callInNumbers": [
{
"label": "US Toll",
"callInNumber": "123456789",
"tollType": "toll"
}
],
"links": [
{
"rel": "globalCallinNumbers",
"href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/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,
"requireCompanyName": true,
"requireCountryRegion": false,
"requireWorkPhone": true,
"enabledRegistrationId": false,
"customizedQuestions": [
{
"id": "3386787",
"question": "What color do you like?",
"required": true,
"type": "checkbox",
"options": [
{
"id": "1",
"value": "green"
},
{
"id": "2",
"value": "black"
},
{
"id": "3",
"value": "yellow"
},
{
"id": "4",
"value": "red"
}
],
"rules": [
{
"condition": "notEquals",
"value": "red",
"result": "reject",
"matchCase": true,
"order": 1
}
]
},
{
"id": "3386792",
"question": "Project Team",
"required": false,
"type": "singleLineTextBox",
"maxLength": 120
},
{
"id": "3386797",
"question": "How are you",
"required": false,
"type": "multiLineTextBox",
"maxLength": 999
},
{
"id": "3386802",
"question": "Dropdownlist Q",
"required": false,
"type": "dropdownList",
"options": [
{
"id": "1",
"value": "A1"
},
{
"id": "2",
"value": "A2"
}
]
},
{
"id": "3386891",
"question": "weather",
"required": false,
"type": "radioButtons",
"maxLength": 120,
"options": [
{
"id": "1",
"value": "sunny"
},
{
"id": "2",
"value": "rain"
}
]
}
],
"rules": [
{
"question": "lastName",
"condition": "endsWith",
"value": "tom",
"result": "reject",
"matchCase": false,
"order": 1
}
]
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"simultaneousInterpretation": {
"enabled": true,
"interpreters": [
{
"id": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
"languageCode1": "en",
"languageCode2": "de",
"email": "marcus.hoffmann@example.com",
"displayName": "Hoffmann"
},
{
"id": "3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM",
"languageCode1": "en",
"languageCode2": "fr",
"email": "antoine.martin@example.com",
"displayName": "Martin"
}
]
},
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href": "/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
"method": "GET"
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Full-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"audioConnectionOptions": {
"audioConnectionType": "VoIP",
"enabledTollFreeCallIn": false,
"enabledGlobalCallIn": false,
"enabledAudienceCallBack": false,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": false,
"allowAttendeeToUnmuteSelf": true,
"muteAttendeeUponEntry": false
},
"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"
}
}
},
{
"status": "400",
"contentType": "application/json;charset=UTF-8",
"example": {
"message": "The input parameters contain invalid items.",
"errors": [
{
"description": "Meeting password validation failed. A mix of uppercase and lowercase letters (A, a, B, b, C, c, etc.) is required."
}
],
"trackingId": "19085D1FCFEE445DA358375500D25E44_1598154356721"
}
}
]
}