Webex · Example Payload

Webex Createcallqueue Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Createcallqueue 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": "createCallQueue",
  "method": "POST",
  "path": "/telephony/config/locations/{locationId}/queues",
  "summary": "Create a Call Queue with Customer Assist",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "name": "CallQueue-1",
        "phoneNumber": "+12225555309",
        "extension": "5309",
        "firstName": "Hakim",
        "lastName": "Smith",
        "callPolicies": {
          "policy": "CIRCULAR",
          "routingType": "SKILL_BASED",
          "waitingEnabled": false,
          "noAnswer": {
            "nextAgentEnabled": false,
            "nextAgentRings": 5,
            "forwardEnabled": false,
            "numberOfRings": 0,
            "destinationVoicemailEnabled": false
          },
          "businessContinuity": {
            "enabled": false,
            "destinationVoicemailEnabled": false
          }
        },
        "queueSettings": {
          "queueSize": 10,
          "callOfferToneEnabled": true,
          "resetCallStatisticsEnabled": true,
          "overflow": {
            "action": "PERFORM_BUSY_TREATMENT",
            "overflowAfterWaitEnabled": false,
            "overflowAfterWaitTime": 30,
            "playOverflowGreetingEnabled": false,
            "greeting": "DEFAULT",
            "audioAnnouncementFiles": [
              {
                "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                "fileName": "announcement.wav",
                "mediaFileType": "WAV",
                "level": "LOCATION"
              }
            ]
          },
          "welcomeMessage": {
            "enabled": true,
            "alwaysEnabled": false,
            "greeting": "DEFAULT",
            "audioAnnouncementFiles": [
              {
                "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                "fileName": "announcement.wav",
                "mediaFileType": "WAV",
                "level": "LOCATION"
              }
            ]
          },
          "waitMessage": {
            "enabled": true,
            "waitMode": "POSITION",
            "handlingTime": 100,
            "defaultHandlingTime": 100,
            "queuePosition": 100,
            "highVolumeMessageEnabled": false,
            "estimatedWaitingTime": 600,
            "playUpdatedEstimatedWaitMessage": true
          },
          "comfortMessage": {
            "enabled": true,
            "timeBetweenMessages": 10,
            "greeting": "DEFAULT",
            "audioAnnouncementFiles": [
              {
                "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                "fileName": "announcement.wav",
                "mediaFileType": "WAV",
                "level": "LOCATION"
              }
            ]
          },
          "mohMessage": {
            "normalSource": {
              "enabled": true,
              "greeting": "DEFAULT",
              "audioAnnouncementFiles": [
                {
                  "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                  "fileName": "announcement.wav",
                  "mediaFileType": "WAV",
                  "level": "LOCATION"
                }
              ]
            },
            "alternateSource": {
              "enabled": true,
              "greeting": "DEFAULT",
              "audioAnnouncementFiles": [
                {
                  "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                  "fileName": "announcement.wav",
                  "mediaFileType": "WAV",
                  "level": "LOCATION"
                }
              ]
            }
          },
          "comfortMessageBypass": {
            "enabled": true,
            "callWaitingAgeThreshold": 30,
            "greeting": "CUSTOM",
            "audioAnnouncementFiles": [
              {
                "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                "fileName": "announcement.wav",
                "mediaFileType": "WAV",
                "level": "LOCATION"
              }
            ]
          },
          "whisperMessage": {
            "enabled": true,
            "greeting": "DEFAULT",
            "audioAnnouncementFiles": [
              {
                "id": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI",
                "fileName": "announcement.wav",
                "mediaFileType": "WAV",
                "level": "LOCATION"
              }
            ]
          }
        },
        "agents": [
          {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGU3MjYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ",
            "skillLevel": 7
          },
          {
            "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ",
            "skillLevel": 1
          }
        ],
        "enabled": true,
        "phoneNumberForOutgoingCallsEnabled": true,
        "callingLineIdPolicy": "DIRECT_LINE",
        "callingLineIdPhoneNumber": "+12072342368",
        "allowAgentJoinEnabled": true,
        "directLineCallerIdName": {
          "selection": "CUSTOM_NAME",
          "customName": "Hakim Smith"
        },
        "dialByName": "Hakim Smith"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0"
      }
    }
  ]
}