Webex · Example Payload

Webex Test Call Routing Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Test Call Routing 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": "Test Call Routing",
  "method": "POST",
  "path": "/telephony/config/actions/testCallRouting/invoke",
  "summary": "Test Call Routing",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "originatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
        "originatorType": "PEOPLE",
        "destination": "0007",
        "includeAppliedServices": true
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "callSourceInfo": {
          "callSourceType": "DIAL_PATTERN",
          "routeListName": "routeList1",
          "routeListId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj",
          "dialPlanName": "dialPlan1",
          "dialPattern": "*888",
          "dialPlanId": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI"
        },
        "destinationType": "HOSTED_AGENT",
        "routingAddress": "007",
        "outsideAccessCode": "1234",
        "isRejected": false,
        "hostedAgent": {
          "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMjU4YjhmZi1lODIxLTQ3MDktYTI2My1mMmI4OWZjN2FlYmQ",
          "type": "PEOPLE",
          "firstName": "firstName",
          "lastName": "lastName",
          "locationName": "locationName",
          "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
          "phoneNumber": "9874531287",
          "extension": "111"
        },
        "hostedFeature": {
          "type": "AUTO_ATTENDANT",
          "name": "name1",
          "id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QyRXdhV2R5TVRCamIwQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09",
          "locationName": "locationName1",
          "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
          "phoneNumber": "9874531287",
          "extension": "111"
        },
        "pbxUser": {
          "dialPlanName": "dialPlan1",
          "dialPlanId": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
          "dialPattern": "442xxx",
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "pstnNumber": {
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "virtualExtension": {
          "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OL2U4NTU0MGJjLWFiNDMtNGZjOS05ZThlLTkxZjRkN2E3ZjU5Ng",
          "firstName": "firstName1",
          "lastName": "lastName1",
          "displayName": "displayName1",
          "extension": "0007",
          "phoneNumber": "8701278963",
          "locationName": "locationName1",
          "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "virtualExtensionRange": {
          "id": "OTI0NzM1OTQtZGU1Mi00ZjViLTk0YjItN2Y5MzRmY2Y2NDk3",
          "name": "firstName1",
          "prefix": "+1214555",
          "pattern": "2XXX",
          "locationName": "locationName1",
          "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "routeList": {
          "id": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj",
          "name": "routeListName1",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "locationName": "locationName1",
          "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "featureAccessCode": {
          "code": "*70",
          "name": "Cancel Call Waiting"
        },
        "emergency": {
          "isRedSky": true,
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "repair": {
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "unknownExtension": {
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "unknownNumber": {
          "trunkName": "trunkName1",
          "trunkId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
          "routeGroupName": "routeGroupName1",
          "routeGroupId": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
          "trunkLocationName": "trunkLocationName1",
          "trunkLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA"
        },
        "appliedServices": [
          {
            "translationPattern": {
              "configurationLevel": "ORGANIZATION",
              "name": "TP1",
              "matchingPattern": "+91XXX",
              "replacementPattern": "+91234",
              "matchedNumber": "+91236",
              "translatedNumber": "+91234"
            },
            "interceptDetails": {
              "configurationLevel": "USER",
              "permission": "TRANSFER",
              "transferNumber": "+14157279300"
            },
            "outgoingCallingPlanPermissionsByType": {
              "configurationLevel": "PEOPLE",
              "callType": "INTERNAL_CALL",
              "permission": "ALLOW",
              "transferNumber": "+14157279300",
              "reason": "FRAUD_CONTAINMENT",
              "number": "+14157279300"
            },
            "outgoingCallingPlanPermissionsByDigitPattern": {
              "configurationLevel": "USER",
              "name": "DPattern",
              "permission": "ALLOW",
              "transferNumber": "+14157279300",
              "pattern": "+91!",
              "reason": "FRAUD_CONTAINMENT",
              "number": "+14157279300"
            }
          }
        ]
      }
    }
  ]
}