Webex · Example Payload

Webex Getallfilteredconfigwithpagedmetadata Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Getallfilteredconfigwithpagedmetadata 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": "getAllFilteredConfigWithPagedMetaData",
  "method": "GET",
  "path": "/organization/{orgid}/v2/contact-service-queue",
  "summary": "List Contact Service Queue(s)",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "*/*",
      "example": {
        "data": [
          {
            "recordingPermitted": true,
            "ivrRequeueUrl": "https://www.youtube.com",
            "agentsLastUpdatedByUserEmailPrefix": "string",
            "personalizedAIRouting": "string",
            "timezone": "America/New_York",
            "socialChannelType": "MESSENGER",
            "controlFlowScriptUrl": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield",
            "description": "Queue created by system",
            "monitoringPermitted": true,
            "vendorId": "AB123CSDR",
            "queueLevelRealTimeTranscriptionsInclusion": "INCLUDED",
            "channelType": "TELEPHONY",
            "queueRoutingType": "TEAM_BASED",
            "recordingAllCallsPermitted": true,
            "organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
            "recordingPauseDuration": 2,
            "systemDefault": false,
            "defaultMusicInQueueMediaFileId": "defaultmusic_on_hold.wav",
            "queueLevelPredictedWaitTimeInclusion": "INCLUDED",
            "queueLevelAutoCsatInclusion": "INCLUDED",
            "serviceLevelThreshold": 0,
            "routingType": "SKILLS_BASED",
            "skillBasedRoutingType": "BEST_AVAILABLE_AGENT",
            "createdTime": "string",
            "lastUpdatedTime": "string",
            "id": "93912f11-6017-404b-bf14-5331890b1797",
            "maxTimeInQueue": 2,
            "xspVersion": "xsp-24.0",
            "maxActiveContacts": 5,
            "pauseRecordingPermitted": true,
            "checkAgentAvailability": true,
            "outdialCampaignEnabled": true,
            "assistantSkill": "string",
            "parkingPermitted": true,
            "agentsLastUpdatedByUserName": "string",
            "active": true,
            "version": 1,
            "queueLevelSummariesInclusion": "INCLUDED",
            "overflowNumber": 1245677,
            "agentsLastUpdatedTime": "2025-03-21T10:30:00Z",
            "queueLevelSentimentAnalysisInclusion": "INCLUDED",
            "name": "Queue-1",
            "queueType": "INBOUND",
            "subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
            "manuallyAssignable": false
          }
        ],
        "meta": {
          "additionalProp1": "string",
          "additionalProp3": "string",
          "additionalProp2": "string"
        }
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "401",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "401",
              "entity": "cc_user",
              "references": []
            }
          ]
        }
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "403",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "403",
              "entity": "cc_user",
              "references": []
            }
          ]
        }
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "404",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "404",
              "entity": "cc_user",
              "references": []
            }
          ]
        }
      }
    },
    {
      "status": "429",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "429",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "429",
              "entity": "cc_user",
              "references": []
            }
          ]
        }
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "500",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "500",
              "entity": "cc_user",
              "references": []
            }
          ]
        }
      }
    }
  ]
}