Webex · Example Payload
Webex Gettemplatebyid Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Gettemplatebyid 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": "getTemplateById",
  "method": "GET",
  "path": "/meetings/templates/{templateId}",
  "summary": "Get a Meeting Template",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json;charset=UTF-8",
      "example": {
        "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
        "name": "Meeting template 1",
        "locale": "en_US",
        "siteUrl": "site4-example.webex.com",
        "templateType": "meeting",
        "isDefault": false,
        "isStandard": false,
        "meeting": {
          "title": "My meeting template 1",
          "agenda": "My meeting template 1 agenda",
          "password": "gugUTMY4?25",
          "start": "2021-11-09T03:19:00Z",
          "end": "2021-11-09T03:39:00Z",
          "timezone": "UTC",
          "enabledJoinBeforeHost": false,
          "joinBeforeHostMinutes": 0,
          "enableConnectAudioBeforeHost": false,
          "hostEmail": "john.andersen@example.com",
          "sendEmail": true,
          "invitees": [
            {
              "email": "brenda.song@example.com",
              "displayName": "Brenda Song",
              "coHost": false,
              "panelist": false
            },
            {
              "email": "catherine.sinu@example.com",
              "displayName": "Catherine Sinu",
              "coHost": false,
              "panelist": false
            }
          ],
          "enabledAutoRecordMeeting": false,
          "allowAnyUserToBeCoHost": false,
          "allowFirstUserToBeCoHost": false,
          "allowAuthenticatedDevices": false,
          "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": false,
            "requireAddress1": false,
            "requireAddress2": false,
            "requireCity": false,
            "requireState": false,
            "requireZipCode": false,
            "requireCountryRegion": false,
            "requireWorkPhone": false,
            "requireFax": false,
            "enabledRegistrationId": false
          },
          "siteUrl": "site4-example.webex.com",
          "excludePassword": false,
          "reminderTime": 15,
          "unlockedMeetingJoinSecurity": "allowJoin",
          "enableAutomaticLock": true,
          "automaticLockMinutes": 15,
          "sessionTypeId": 636,
          "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"
            }
          ],
          "audioConnectionOptions": {
            "audioConnectionType": "webexAudio",
            "enabledTollFreeCallIn": true,
            "enabledGlobalCallIn": true,
            "enabledAudienceCallBack": false,
            "entryAndExitTone": "beep",
            "allowHostToUnmuteParticipants": false,
            "allowAttendeeToUnmuteSelf": true,
            "muteAttendeeUponEntry": false
          }
        }
      }
    }
  ]
}