Webex · Example Payload

Webex Getusersbyskillrequirements Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Getusersbyskillrequirements 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": "getUsersBySkillRequirements",
  "method": "POST",
  "path": "/organization/{orgid}/user/fetch-by-skill-requirements",
  "summary": "Get the agents matching skill requirements criteria",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "skillRequirements": [
          {
            "organizationId": "0271223b-91de-427d-872a-1b3c1bb746b9",
            "id": "5e8cdad5-94da-4ffc-86d7-c904e4490626",
            "skillId": "bc5658a9-5aa7-45ec-b960-43dcfc73c34d",
            "skillName": "skillA",
            "skillType": "TEXT",
            "condition": "IS",
            "skillValue": "abc"
          },
          {
            "condition": "IS",
            "skillValue": "8",
            "skillName": "ProfSkillC",
            "skillType": "PROFICIENCY",
            "skillId": "c683cf8d-49e8-4e85-9e08-c8749affa9cc"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "400",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "400",
              "entity": "cc_user",
              "references": []
            }
          ]
        }
      }
    },
    {
      "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": "409",
      "contentType": "application/json",
      "example": {
        "trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
        "error": {
          "key": "409",
          "reason": "Test reason",
          "message": [
            {
              "description": "Test error",
              "code": "409",
              "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": []
            }
          ]
        }
      }
    }
  ]
}