Webex · Example Payload

Webex Get Phone Numbers For An Organization With Given Criteria Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Get Phone Numbers For An Organization With Given Criteria 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": "Get Phone Numbers for an Organization with Given Criteria",
  "method": "GET",
  "path": "/telephony/config/numbers",
  "summary": "Get Phone Numbers for an Organization with Given Criteria",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "count": {
          "assigned": 33,
          "unAssigned": 114,
          "inActive": 12,
          "extensionOnly": 692,
          "tollFreeNumbers": 1,
          "total": 839,
          "mobileNumber": 6,
          "serviceNumber": 1
        },
        "phoneNumbers": [
          {
            "phoneNumber": "+12056350001",
            "extension": "11",
            "routingPrefix": "1234",
            "esn": "123411",
            "state": "ACTIVE",
            "phoneNumberType": "FAX",
            "mainNumber": false,
            "includedTelephonyTypes": "MOBILE_NUMBER",
            "mobileNetwork": "mobileNetwork",
            "routingProfile": "AttRtPf",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "location": {
              "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
              "name": "Banglore"
            },
            "owner": {
              "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
              "type": "PEOPLE",
              "firstName": "sadiqhussain96",
              "lastName": "sadiqhussain96"
            }
          },
          {
            "phoneNumber": "",
            "state": "ACTIVE",
            "phoneNumberType": "ALTERNATE",
            "extension": "568",
            "routingPrefix": "1234",
            "esn": "1234568",
            "mainNumber": false,
            "includedTelephonyTypes": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "location": {
              "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M2MDliOGE1LTAxNmQtNDAwNy1hN2E0LTJhMThiZmZjY2FmNg",
              "name": "Richardson"
            },
            "owner": {
              "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNzVkMjI4Mi0yZjk1LTQ2MmMtYjFiNC1kYjRlZjU1OTk3MWE",
              "type": "PEOPLE",
              "firstName": "chandru_2",
              "lastName": "test_2"
            }
          },
          {
            "phoneNumber": "+12026282002",
            "state": "ACTIVE",
            "phoneNumberType": "PRIMARY",
            "mainNumber": true,
            "includedTelephonyTypes": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": true,
            "location": {
              "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEwN2EzNTkwLWY3OWMtNGM0OS1iM2I2LWQ1MzhjYTA0YWU1MA",
              "name": "Washington"
            }
          }
        ]
      }
    }
  ]
}