Webex · Example Payload

Webex Getcallqueuewithcustomerassist Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Getcallqueuewithcustomerassist 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": "getCallQueueWithCustomerAssist",
  "method": "GET",
  "path": "/telephony/config/locations/{locationId}/queues/{queueId}",
  "summary": "Get Details for a Call Queue with Customer Assist",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx",
        "name": "CallQueue-1",
        "hasCxEssentials": true,
        "enabled": true,
        "language": "English",
        "languageCode": "en-US",
        "firstName": "Hakim",
        "lastName": "Smith",
        "timeZone": "Central/Chicago",
        "alternateNumberSettings": {
          "distinctiveRingEnabled": true,
          "alternateNumbers": [
            {
              "phoneNumber": "9725554726",
              "ringPattern": "NORMAL"
            },
            {
              "phoneNumber": "9725554729",
              "ringPattern": "NORMAL"
            }
          ]
        },
        "callPolicies": {
          "policy": "REGULAR",
          "callBounce": {
            "callBounceEnabled": true,
            "callBounceMaxRings": 8,
            "agentUnavailableEnabled": false,
            "alertAgentEnabled": false,
            "alertAgentMaxSeconds": 30,
            "callBounceOnHoldEnabled": false,
            "callBounceOnHoldMaxSeconds": 60
          },
          "distinctiveRing": {
            "enabled": false,
            "ringPattern": "NORMAL"
          }
        },
        "queueSettings": {
          "queueSize": 10,
          "callOfferToneEnabled": false,
          "resetCallStatisticsEnabled": false,
          "overflow": {
            "action": "PERFORM_BUSY_TREATMENT",
            "sendToVoicemail": false,
            "overflowAfterWaitEnabled": false,
            "overflowAfterWaitTime": 30,
            "playOverflowGreetingEnabled": false,
            "greeting": "DEFAULT",
            "isTransferNumberSet": false
          },
          "waitMessage": {
            "enabled": false,
            "waitMode": "TIME",
            "handlingTime": 100,
            "queuePosition": 100,
            "highVolumeMessageEnabled": true,
            "defaultHandlingTime": 5
          },
          "welcomeMessage": {
            "enabled": true,
            "alwaysEnabled": false,
            "greeting": "DEFAULT"
          },
          "comfortMessage": {
            "enabled": true,
            "timeBetweenMessages": 10,
            "greeting": "DEFAULT"
          },
          "mohMessage": {
            "normalSource": {
              "enabled": false,
              "greeting": "DEFAULT"
            },
            "alternateSource": {
              "enabled": false,
              "greeting": "DEFAULT"
            }
          }
        },
        "allowCallWaitingForAgentsEnabled": false,
        "agents": [],
        "department": {
          "id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ",
          "name": "HR"
        },
        "directLineCallerIdName": {
          "selection": "CUSTOM_NAME",
          "customName": "Hakim Smith"
        },
        "dialByName": "Hakim Smith"
      }
    }
  ]
}