Webex · Example Payload

Webex Get Available Phone Numbers For A Location With Given Criter Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Get Available Phone Numbers For A Location With Given Criter 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

{
  "operationId": "Get Available Phone Numbers for a Location with Given Criteria",
  "method": "GET",
  "path": "/telephony/config/locations/{locationId}/availableNumbers",
  "summary": "Get Available Phone Numbers for a Location with Given Criteria",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "phoneNumbers": [
          {
            "phoneNumber": "+12056350001",
            "state": "ACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": true,
            "owner": {
              "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
              "type": "PEOPLE",
              "firstName": "Test",
              "lastName": "Person"
            }
          },
          {
            "phoneNumber": "+12056350002",
            "state": "ACTIVE",
            "isMainNumber": true,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": false,
            "isServiceNumber": false,
            "owner": {
              "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9lZjJkMjg3Ny1hYTY0LTRkMjQtYTFjNi02OWExMmNhMWI2YTA=",
              "type": "PLACE",
              "displayName": "TestWorkSpace"
            }
          },
          {
            "phoneNumber": "+12056350003",
            "state": "INACTIVE",
            "isMainNumber": false,
            "telephonyType": "PSTN_NUMBER",
            "tollFreeNumber": true,
            "isServiceNumber": false
          }
        ]
      }
    }
  ]
}