Skip to content

Changes to phonecom apiv4.swagger.json in v1.0

Jump to bottom
Igor Simevski edited this page Mar 28, 2017 · 1 revision

Changes:

In Paths

List Accounts

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListAccountsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListAccounts"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  }
}

List Applications

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListApplicationsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListApplications"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

Get call logs (List method)

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListCallLogsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListCallLogs"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

Before "description": "Fetch a list of call logs associated with your account."
After "description": "See Call Logs for more detail."

Get call log

Before
Existed
After
Removed

List Devices

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListDevicesFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListDevices
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Express Service Codes

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListExpressServiceCodesFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListExpressServiceCodes"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Extensions

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListExtensionsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListExtensions"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Caller Ids

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListCallerIdsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListCallerIds"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Contacts

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListContactsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListContacts"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

Replace Contact

Replace Contact is placed under this path:
"/accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id}"
Previously it was under this:
"/accounts/{account_id}/extensions/{extension_id}/contacts"

This parameter is added:

{
  "$ref": "#/parameters/contactIdParam"
}

List Groups

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListGroupsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListGroups"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

Replace Group

The create group params are added

{
  "name": "data",
  "in": "body",
  "description": "Group name",
  "required": true,
  "schema": {
    "$ref": "#/definitions/CreateGroupParams"
  }
}

List Media

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListMediaFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListMedia"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Menus

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListMenusFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListMenus"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Phone Numbers

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListPhoneNumbersFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListPhoneNumbers"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

ListPhoneNumbersSummary Removed

List Queues

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListQueuesFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListQueues"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Routes

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListRoutesFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListRoutes"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Schedules

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListSchedulesFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListSchedules"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Sms

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListSmsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListSms"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

Get Sms

Sms id type changed from integer to string

List Subaccounts

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListAccountsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListAccounts"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Trunks

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListTrunksFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListTrunks"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "403": {
    "$ref": "#/responses/response403"
  }
}

List Available Phone Numbers

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListAvailableNumbersFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "429": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListAvailableNumbers"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "429": {
    "$ref": "#/responses/response403"
  }
}

This parameter is removed:

{
  "$ref": "#/parameters/filterIsTollFree"
}

List Available Phone Number Regions

Before

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListPhoneNumbersRegionsFull"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "429": {
    "$ref": "#/responses/response403"
  }
}

After

"responses": {
  "200": {
    "description": "OK",
    "schema": {
      "$ref": "#/definitions/ListPhoneNumbersRegions"
    }
  },
  "401": {
    "$ref": "#/responses/response401"
  },
  "429": {
    "$ref": "#/responses/response403"
  }
}

In Parameters

Removed:

"callLogIdParam": {
  "name": "callLog_id",
  "in": "path",
  "description": "Call Log ID",
  "required": true,
  "type": "integer"
}

In Definitions

Before

"CreateDeviceParams": {
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Device Name"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/Line"
      },
      "description": "List of line objects"
    }
  }
}

After

"CreateDeviceParams": {
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Device Name"
    },
    "lines": {
      "type": "array",
      "items": {
        "type": "object"
      }
      "description": "List of line objects"
    }
  }
}

In "CreateSmsParams"
Added:

"extension_id": {
  "type": "integer",
  "description": "ID of Extension where the sms is saved"
}

In "CreateSubaccountParams"
Changed description of username property:
Before "description": "Sub account user name"
After "description": "Sub account password"

In "CreateTrunkParams"
Removed:

"required": [
  "name",
  "url"
]

Property url changed to uri

Changed ListAccountsFull to ListAccounts
ListAccountsSummary Removed
Changed ListApplicationsFull to ListApplications
ListApplicationsSummary Removed
Changed ListCallLogsFull to ListCallLogs
ListCallLogsSummary Removed

Before

"ListDevicesFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/DevicesFull"
    }
  }
}

After

"ListDevices": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/DeviceFull"
      }
    }
  }
}

ListDevicesSummary Removed
DevicesFull Removed
DevicesSummary Removed

Before

"ListExpressServiceCodesFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdArray"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/ExpressServiceCodesFull"
    }
  }
}

After

"ListExpressServiceCodes": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdArray"
    },
    "sort": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/SortId"
      }
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/ExpressServiceCodeFull"
      }
    }
  }
}

ExpressServiceCodesFull Removed
ListExpressServiceCodesSummary Removed
ExpressServiceCodesSummary Removed
ListExtensionsFull to ListExtensions
ListExtensionsSummary Removed
ListCallerIdsFull to ListCallerIds
ListCallerIdsSummary Removed
ListContactsFull to ListContacts
ListContactsSummary Removed

Before

"ListGroupsFull": {
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/GroupsFull"
    }
  }
}

After

"ListGroups": {
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/GroupFull"
      }
    }
  }
}

GroupsFull Removed
ListGroupsSummary Removed
GroupsSummary Removed

Before

"ListMediaFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/MediaFull"
      }
    }
  }
}

After

"ListMedia": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/MediaSummary"
      }
    }
  }
}

ListMediaSummary Removed

Before

"ListMenusFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/MenusFull"
    }
  }
}

After

"ListMenus": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/MenuFull"
      }
    }
  }
}

ListMenusSummary Removed
MenusFull Removed
MenusSummary Removed

Before

"ListPhoneNumbersFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNamePhoneNumberArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdNamePhoneNumber"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/PhoneNumbersFull"
    }
  }
}

After

"ListPhoneNumbers": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNamePhoneNumberArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdNamePhoneNumber"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "description": "Array of Contact Phone Number Objects. See below for details.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/PhoneNumberContact"
      }
    }
  }
}

PhoneNumbersFull Removed
PhoneNumbersSummary Removed

Before

"ListQueuesFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/Queues"
    }
  }
}

After

"ListQueues": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/QueueFull"
      }
    }
  }
}

Queues Removed
ListQueuesSummary Removed
QueuesSummary Removed

Before

"ListRoutesFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/RoutesFull"
    }
  }
}

After

"ListRoutes": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterIdNameArray"
    },
    "sort": {
      "$ref": "#/definitions/SortIdName"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/RouteFull"
      }
    }
  }
}

RoutesFull Removed
ListRoutesSummary Removed
RoutesSummary Removed
ListSchedulesFull to ListSchedules
ListSchedulesSummary Removed
ListSmsFull to ListSms
ListSmsSummary Removed
ListTrunksFull to ListTrunks
ListTrunksSummary Removed

Before

"ListAvailableNumbersFull": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterListAvailableNumbers"
    },
    "sort": {
      "$ref": "#/definitions/SortListAvailableNumbers"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/AvailableNumbersFull"
    }
  }
}

After

"ListAvailableNumbers": {
  "type": "object",
  "properties": {
    "filters": {
      "$ref": "#/definitions/FilterListAvailableNumbers"
    },
    "sort": {
      "$ref": "#/definitions/SortListAvailableNumbers"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/AvailableNumbersFull"
      }
    }
  }
}

ListAvailableNumbersSummary Removed
AvailableNumbersSummary Removed

Before

"AvailableNumbersFull": {
  "type": "array",
  "items": {
    "$ref": "#/definitions/AvailableNumberFull"
  }
}

After

"AvailableNumbersFull": {
  "description": "The Full Available Phone Number Object includes the properties in the Summary Object, along with the following:",
  "type": "object",
  "properties": {
    "phone_number": {
      "type": "string",
      "description": "Phone number, in E.164 format"
    },
    "formatted": {
      "type": "string",
      "description": "Human-readable formatted version of the phone number"
    },
    "price": {
      "type": "integer",
      "description": "The one-time initial price for this number, in USD. Some numbers show REQUEST_QUOTE here. Please contact our sales department if you are interested in these numbers."
    },
    "is_toll_free": {
      "type": "boolean",
      "description": "Whether the number is toll-free"
    },
    "country_code": {
      "type": "string",
      "description": "The international dialing prefix for this number. For US and Canadian numbers, for example, this will be \"1\"."
    },
    "npa": {
      "type": "string",
      "description": "Area code (a.k.a. NPA). Included for North American numbers only."
    },
    "nxx": {
      "type": "string",
      "description": "Second 3 digits (a.k.a. NXX). Included for North American numbers only."
    },
    "xxxx": {
      "type": "string",
      "description": "Last 4 digits (a.k.a. XXXX). Included for North American numbers only."
    },
    "city": {
      "type": "string",
      "description": "City with which this number is associated, if known. Otherwise NULL."
    },
    "province": {
      "type": "string",
      "description": "State or Province with which this number is associated, if known. Postal Code. Otherwise NULL."
    },
    "country": {
      "type": "string",
      "description": "Country with which this number is associated, if known. Otherwise NULL."
    }
  }
}

Before

"ListPhoneNumbersRegionsFull": {
  "type": "object",
  "properties": {
    "group_by": {
      "$ref": "#/definitions/GroupByListPhoneNumbersRegions"
    },
    "filters": {
      "$ref": "#/definitions/FilterListPhoneNumbersRegions"
    },
    "sort": {
      "$ref": "#/definitions/SortListPhoneNumbersRegions"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "$ref": "#/definitions/PhoneNumbersRegionsFull"
    }
  }
}

After

"ListPhoneNumbersRegions": {
  "type": "object",
  "properties": {
    "group_by": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "filters": {
      "$ref": "#/definitions/FilterListPhoneNumbersRegions"
    },
    "sort": {
      "$ref": "#/definitions/SortListPhoneNumbersRegions"
    },
    "total": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/PhoneNumbersRegionFull"
      }
    }
  }
}

CallLogSummary Removed
PhoneNumbersRegionsFull Removed
ExpressServiceCodeSummary Removed

In "ExtensionSummary"
Before "description": "The Full Extension Object has the same properties as the Extension Summary Object, along with the following:"
After "description": "The Extension Summary Object is used to briefly represent an extension. It can be seen in several places throughout this API. Here are the properties:"

Removed:

"required": [
  "id",
  "name",
  "extension"
],

Before
In "ContactFull":

"emails": {
  "$ref": "#/definitions/Emails"
}

After

"emails": {
  "description": "Array of Contact Email Objects. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/Email"
  }
}

Before

"phone_numbers": {
  "type": "array",
  "items": {
    "$ref": "#/definitions/PhoneNumberContact"
  }
}

After

"phone_numbers": {
  "description": "Array of Contact Phone Number Objects. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/PhoneNumberContact"
  }
}

Before

"addresses": {
  "$ref": "#/definitions/Addresses"
}

After

"addresses": {
  "description": "Array of Contact Address Objects. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/AddressListContacts"
  }
}

Emails Removed

In "MenuFull":

Before

"options": {
  "$ref": "#/definitions/OptionsListMenus"
}

After

"options": {
  "description": "Array of menu option objects. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/Option"
  }
}

OptionsListMenus Removed
PhoneNumberSummary Removed

In "QueueFull":

Before

"members": {
  "$ref": "#/definitions/Members"
}

After

"members": {
  "description": "Array of Member Objects. Non-virtual account extensions or phone numbers. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/Member"
  }
}

Members Removed

In "SmsFull":

Before "description": "The Full SMS Object includes all of the properties in the SMS Summary Object, along with several more."
After "description": "The Full SMS Object is identical to the SMS Summary Object. See above for details."

SmsSummary Removed

Removed:

"AvailableNumbersFull": {
  "type": "array",
  "items": {
    "$ref": "#/definitions/AvailableNumberFull"
  }
}

Changed AvailableNumberFull to AvailableNumbersFull

AvailableNumberSummary Removed

In "PhoneNumbersRegionFull":
npa changed type from string to integer
nxx changed type from string to integer

GroupByListPhoneNumbersRegions Removed
SortIdArray Removed

In "FilterListAvailableNumbers":

Before

"npa": {
  "type": "array",
  "items": {
    "type": "integer"
  }
}

After

"npa": {
  "type": "integer"
}

In "FilterListPhoneNumbersRegions":

Before

"npa": {
  "type": "array",
  "items": {
    "type": "integer"
  }
}

After

"npa": {
  "type": "integer"
}
Clone this wiki locally