phonecom-apiv4.swagger.json

{
  "swagger": "2.0",
  "info": {
    "description": "This is a Phone.com api Swagger definition",
    "version": "1.0.0",
    "title": "Phone.com API",
    "contact": {
      "email": "apisupport@phone.com"
    }
  },
  "host": "api.phone.com",
  "basePath": "/v4",
  "tags": [
    {
      "name": "calls",
      "description": "This API places a call to the caller phone number (or caller extension ID). If that number (or extension) answers within the timeout period, then the callee DID (or extension) will be connected to the call. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Calls API with the following definition: https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/calls",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-calls"
      }
    },
    {
      "name": "oauth",
      "description": "The OAuth 2.0 Authorization Framework enables a third-party application to obtain limited access to HTTP API requests which require an access token. This page describes how to use the /oauth/authorization and /oauth/access-token API's to generate an access token.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/oauth"
      }
    },
    {
      "name": "accounts",
      "description": "This page gives an overview of how to interact with your accounts.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/accounts"
      }
    },
    {
      "name": "applications",
      "description": "Applications are references to your own software integrations that are registered to interact with your Phone.com account.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-applications"
      }
    },
    {
      "name": "call-logs",
      "description": "The Call Logs API returns a list of call detail records for the account. The result includes the id, start time, creation time, caller ID, called number, direction of call, and duration in seconds. If applicable, the result may also include final action, final action duration, listen URL, and/or transcription. Since the call logs usually contains many calls, API users may use filters such as start_time, created_at and direction to limit the result set to calls interested. Users may also use the sorting parameters such as start_time and created_at to list result in ascending or descending order.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-call-logs"
      }
    },
    {
      "name": "devices",
      "description": "Your Phone.com account may have one or more physical handsets or other VoIP devices associated with it. This service only shows generic VoIP devices at this time. If you have any physical handsets or virtualized software-based devices, you will need to continue using the Control Panel to manage them.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-devices"
      }
    },
    {
      "name": "listeners",
      "description": "Call Event Listeners. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Listeners API with the following definition: https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners At the heart of every telephony system is the Events Engine. At Phone.com, our customers (and their call traffic) emit millions of events per day. These events play a key role in advanced integration opportunities such as CRM integration, security/auditing, and real-time contextual call control. The Listeners API Services aim to simplify and standardize the method in which events are extracted from our systems and processed. These services provide consistent interfaces for internal systems to log events, manage subscriptions, and provide interfaces for external systems (e.g. customer applications or integrations such as Salesforce CRM) to subscribe to account-specific events and manage the subscriptions. As of today, Phone.com supports the following events. More events will be added as we continue to upgrade our phone services. - call.new - call.update - call.complete - call.log - sms.in - sms.out The \"call\" events help customers know when a call starts, when the callee answers the call, when a call ends and when a call entry is recorded and ready for retrieval. The \"sms\" events help customers know when a sms is sent or received. This provides enough information for applications such as Incoming Call / SMS Notification and others to improve productivities. More events will be added once we understand more about customer needs. The Listeners service provides an interface for internal and external applications to subscribe to events. Listeners can be added by customers to their Phone.com account using the Phoenix API. A listener sets up an event type and a callback URL, when the event is emitted, it will be forwarded to the URL. For example, a call.new event may be setup with a callback URL http://newcall.phone.com, when an inbound call comes in, the event with all the call info (payload) will be forwarded to http://newcall.phone.com.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-listeners"
      }
    },
    {
      "name": "express-service-codes",
      "description": "An Express Service Code is required when a customer calls Phone.com for support. With the following services, customer may retrieve the Express Service Code associated with his/her account.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-express-srv-codes"
      }
    },
    {
      "name": "extensions",
      "description": "Your Phone.com account will have one or more extensions.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-extensions"
      }
    },
    {
      "name": "caller-ids",
      "description": "API users with Extension scope access token does not have access to the Phone Number API. This API helps user to retrieve available account phone numbers to be used as caller id via the /Calls API. Outgoing calls via the Post /calls API supports Caller ID settings. This page gives an overview on how to retrieve the list of available account phone number to be used as caller ID.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-extension-caller-ids"
      }
    },
    {
      "name": "contacts",
      "description": "Each extension at Phone.com can have its own address book with any number of contacts. This page gives an overview.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-extension-contacts"
      }
    },
    {
      "name": "groups",
      "description": "The entries in an extension's address book can be divided into any number of groups. This page gives an overview.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-extension-contact-groups"
      }
    },
    {
      "name": "media",
      "description": "Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Media API with the following definition: https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/media. Your Phone.com account has two kinds of media that can be used in various ways: Hold Music and Greetings. Hold Music can be used in routes, queues, and anywhere the caller might be placed on hold. Your account has access to a set of standard hold music options, and optionally another set of premium hold music options. You can also upload your own hold music, subject to copyright limitations. Greetings are verbal messages that can be played in various places to provide the caller with important information. For example, greetings are used when a caller first enters a menu or if they enter an invalid option. You also might use a greeting to alert the user to the fact that their call is being recorded.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/list-account-media"
      }
    },
    {
      "name": "menus",
      "description": "We've all been on the consuming side of a phone menu before. You call a company and hear, \"Press '1' for Sales. Press '2' for Support. Press '0' for the operator.\" With Phone.com you can create your own menus!",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-menus"
      }
    },
    {
      "name": "oauth-clients",
      "description": "Phone.com API supports OAuth 2.0 Authorization Framework, which enables a third-party application (client) to obtain limited access to HTTP API requests. This page describes how to use the /oauth/clients API to list, get and delete client.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-oauth-clients"
      }
    },
    {
      "name": "oauth-clients-redirect-uris",
      "description": "The Account OAuth Clients API supports redirect-uri. Since an OAuth Client is created by a Phone.com admin who does not know what redirect uris should be assigned, API users may use the OAuth Client Redirect URIs API to create, list, get and delete redirect uris.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-oauth-clients-redirect-uris"
      }
    },
    {
      "name": "payment-methods",
      "description": "Phone.com accepts credit card payment, and the Account Payment Methods API allows users to add, list, get, update and delete a credit card payment method.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-payment-methods"
      }
    },
    {
      "name": "phone-numbers",
      "description": "Your Phone.com account has one or more phone numbers registered to it.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-phone-numbers"
      }
    },
    {
      "name": "queues",
      "description": "Queues are used when you want to direct calls to a pool of phone numbers and/or extensions. A common utilization of queues is for Customer Service call centers. When a queue is configured on your phone number, Phone.com will route incoming calls to members of the queue. If a queue member is already on another call, our service rings the next phone number or extension in the queue. While your callers are waiting to be connected, you can choose to play Hold Music.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-queues"
      }
    },
    {
      "name": "routes",
      "description": "Routes, a.k.a. \"Call Handling Rules\" or \"Presets\", are used to tell Phone.com how to handle incoming phone calls. They can be used to connect your Phone.com phone number to an extension, a menu, a calling queue, or many other things. The fundamental element of a route is an action. We support many different actions such as forward, menu, and voicemail. See below for the full details. In general, actions are processed one at a time in the order you specify, until the call is answered or disconnected. Answering or disconnecting stops any additional actions from being performed. Note that several actions such as voicemail, menu, and fax completely take over processing the call and do not result in processing any subsequent actions. Actions are grouped into rule sets. Rule sets can be filtered based on the time of day or the caller's phone number. When processing an incoming call, Phone.com's routing engine will evaluate each rule set in the order that was specified when the route was created or updated. The first matching rule set will be used, and all other rule sets will be ignored. Each route must have at least one unfiltered rule set. Note that if your route contains multiple unfiltered rule sets, only the first one will be used.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-routes"
      }
    },
    {
      "name": "schedules",
      "description": "Schedules are used at various places in your Phone.com account. A schedule can specify a recurring weekly pattern such as \"Monday through Friday\" or a single time period such as \"Thanksgiving Weekend 2015\".",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-schedules"
      }
    },
    {
      "name": "sms",
      "description": "The Phone.com /sms service lets you send and show history of SMS messages. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level SMS API with the following definition: https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms. Phone.com’s standard phone service lets you send and receive SMS messages using your Phone.com numbers. The Phone.com API extends this functionality, letting you send SMS messages from your application (through your phone number and our API server) to your users. You can also use the API to retrieve the history of sms sent from / delivered to your account.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-sms"
      }
    },
    {
      "name": "subaccounts",
      "description": "This page gives an overview of how to interact with your subaccounts. Subaccounts are the same as master accounts in terms of the functionality Phone.com supports. The main difference is that subaccounts are grouped with their master account for invoicing purposes.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/subaccounts"
      }
    },
    {
      "name": "pricing",
      "description": "This page gives an overview of how a Phone.com Master Account manages its pricing plan (coupon code) for its Subaccounts. API Token with Billing Scope: Your Phone.com account API token must have Billing Scope enabled in order to use any of our pricing services. Please contact Support if you need this.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-subaccount-pricing"
      }
    },
    {
      "name": "trunks",
      "description": "SIP Trunks are used to connect your Phone.com account to your PBX. SIP Trunking Customers Only: Your Phone.com account must have SIP Trunking enabled in order to use any of our trunking features. Please contact Support if you need this. Otherwise, all requests to these services will result in a 403 Forbidden error.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-trunks"
      }
    },
    {
      "name": "voicemail",
      "description": "Phone.com’s standard phone service allows callers leave voicemail if the incoming call was not answered. The /voicemail services show history of voicemail and allow users download voicemail for offline playback. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Voicemail API with the following definition: https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/voicemail",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/account-voicemail"
      }
    },
    {
      "name": "available-numbers",
      "description": "This service lists phone numbers that are available for purchase through Phone.com.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/available-phone-numbers"
      }
    },
    {
      "name": "number-regions",
      "description": "This service shows the quantities of phone numbers available for purchase, using region-based grouping.",
      "externalDocs": {
        "description": "Find out more",
        "url": "https://apidocs.phone.com/docs/available-phone-number-regions"
      }
    }
  ],
  "securityDefinitions": {
    "apiKey": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header"
    }
  },
  "schemes": [
    "https"
  ],
  "paths": {
    "/ping": {
      "get": {
        "tags": [
          "default"
        ],
        "summary": "The default API command",
        "description": "The default API command",
        "operationId": "ping",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PingResponse"
            }
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/oauth/access-token": {
      "get": {
        "tags": [
          "oauth"
        ],
        "summary": "Retrieve details of an access token, such as scope, expiration and extension ID.",
        "description": "Retrieve details of an access token, such as scope, expiration and extension ID. Voip ID will be returned as well if scope contains account-owner scope.",
        "operationId": "get-oauth-access-token",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/GetOauthAccessToken"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth"
        ],
        "summary": "To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant.",
        "description": "To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant. For Authorization Code Grant, the input parameter 'code' is generated via the Create Authorization API. NOTE: The Create Access Token API now accepts requests in query string format as well as JSON body format. See OAuth for more details on how to obtain client id and client secret to create an access token at real time.",
        "operationId": "create-oauth-access-token",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "data",
            "in": "body",
            "description": "Oauth data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateOauthParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/OauthAccessToken"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/oauth/authorization": {
      "get": {
        "tags": [
          "oauth"
        ],
        "summary": "Create Authorization Code or Access Token.",
        "description": "Create Authorization Code or Access Token. The /oauth/authorization API supports Authorization Grant and Implicit Grant. In Authorization Grant, this API returns a code (response_type=code) for clients implemented in a browser using a scripting language such as JavaScript. Users may then use the code via the Create Access Token API to create an access token. The Implicit Grant is a simplified authorization code flow. In the implicit flow, instead of issuing the client an authorization code, the client is issued an access token (response_type=token) directly. See OAuth for more details on how to obtain client id and client secret to create authorization code access token at real time.",
        "operationId": "create-oauth-authorization",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "client_id",
            "in": "query",
            "description": "Client ID",
            "required": true,
            "type": "string"
          },
          {
            "name": "response_type",
            "in": "query",
            "description": "'token' for Implicit Grant; 'code' for Authorization Code Grant",
            "required": true,
            "type": "string"
          },
          {
            "name": "scope",
            "in": "query",
            "description": "account-owner, extension-user and/or methods:ALL, separated by space (%20)",
            "required": true,
            "type": "string"
          },
          {
            "name": "redirect_uri",
            "in": "query",
            "description": "The URL where the response data of this API is redirected to",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "302": {
            "description": "http://localhost/?code=mRxUuwgl0Xgjg8fIjweikoJPb1aaMBU8bt706656~6&state="
          },
          "401": {
            "$ref": "#/responses/response401"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts": {
      "get": {
        "tags": [
          "accounts"
        ],
        "summary": "Get a list of accounts visible to the authenticated user or client.",
        "description": "Get a list of accounts visible to the authenticated user or client. In most cases, there will only be one such account. See Accounts for more info on the properties.",
        "operationId": "list-accounts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListAccounts"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts/{account_id}": {
      "get": {
        "tags": [
          "accounts"
        ],
        "summary": "Retrieve details of an individual account",
        "description": "Retrieve details of an individual account. See Accounts for more info on the properties.",
        "operationId": "get-account",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/AccountFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts/{account_id}/applications": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "applications"
        ],
        "summary": "This service lists the Applications on a given account",
        "description": "Show details of an individual Application on a given account.",
        "operationId": "list-account-applications",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListApplications"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/applications/{application_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "applications"
        ],
        "summary": "Show details of an individual Application on a given account.",
        "description": "Show details of an individual Application on a given account.",
        "operationId": "get-account-application",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "application_id",
            "in": "path",
            "description": "Application ID",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ApplicationFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      }
    },
    "/accounts/{account_id}/calls": {
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "calls"
        ],
        "summary": "Make a phone call",
        "description": "Make a phone call. See Calls for more details and how to setup caller id's. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Calls API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/calls",
        "operationId": "create-account-call",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Call data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateCallParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/CallFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/call-logs": {
      "get": {
        "tags": [
          "call-logs"
        ],
        "summary": "Get a list of call details associated with your account",
        "description": "Get a list of call details associated with your account. See Call Logs for more detail.",
        "operationId": "list-account-call-logs",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterStartTimeParam"
          },
          {
            "$ref": "#/parameters/filterCreatedAtCallLogsParam"
          },
          {
            "$ref": "#/parameters/filterDirectionCallLogs"
          },
          {
            "$ref": "#/parameters/filterCalledNumber"
          },
          {
            "$ref": "#/parameters/filterType"
          },
          {
            "$ref": "#/parameters/filterExtension"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortStartTime"
          },
          {
            "$ref": "#/parameters/sortCreatedAtCallLogs"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListCallLogs"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts/{account_id}/call-logs/{call_id}": {
      "get": {
        "tags": [
          "call-logs"
        ],
        "summary": "Show details of an individual Call Log entry",
        "description": "Show details of an individual Call Log entry. See Call Logs for more detail.",
        "operationId": "get-account-call-logs",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/callIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CallLogFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts/{account_id}/devices": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "devices"
        ],
        "summary": "Get a list of VoIP devices associated with your account.",
        "description": "Get a list of VoIP devices associated with your account. See Devices for more detail.",
        "operationId": "list-account-devices",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListDevices"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "devices"
        ],
        "summary": "Register a generic VoIP device.",
        "description": "Register a generic VoIP device. See Devices for more detail.",
        "operationId": "create-account-device",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Device data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateDeviceParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/DeviceFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/devices/{device_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "devices"
        ],
        "summary": "Show details of an individual VoIP device.",
        "description": "Show details of an individual VoIP device. See Devices for more detail.",
        "operationId": "get-account-device",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/deviceIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeviceFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "devices"
        ],
        "summary": "Update the details of an individual VoIP device.",
        "description": "Update the details of an individual VoIP device. See Devices for more detail.",
        "operationId": "replace-account-device",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/deviceIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Device data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateDeviceParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeviceFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "devices"
        ],
        "summary": "Delete a VoIP device.",
        "description": "Delete a VoIP device. See Devices for more detail.",
        "operationId": "delete-account-device",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/deviceIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/listeners": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "listeners"
        ],
        "summary": "Get a list of listeners for an account.",
        "description": "Get a list of listeners for an account. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List Listeners API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners",
        "operationId": "list-account-listeners",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListListeners"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "listeners"
        ],
        "summary": "Add a listener object to your account that can be used to subscribe an event.",
        "description": "Add a listener object to your account that can be used to subscribe an event. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Post Listener API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners",
        "operationId": "create-account-listener",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Account Listeners Data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateListenerParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ListenerFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/listeners/{listener_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "listeners"
        ],
        "summary": "Show details of an individual listener.",
        "description": "Show details of an individual event listener. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Get Listener API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id",
        "operationId": "get-account-listener",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/listenerIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/ListenerFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "listeners"
        ],
        "summary": "Update the settings of an individual event listener.",
        "description": "Update the settings of an individual event listener. See Event Listeners for more detail. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Replace Listener API with the following definition: PUT https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id",
        "operationId": "replace-account-listener",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/listenerIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Account Listeners Data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateListenerParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/ListenerFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "listeners"
        ],
        "summary": "Delete an individual event listener.",
        "description": "Delete an individual event listener. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Delete Listener API with the following definition: DELETE https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id",
        "operationId": "delete-account-listener",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/listenerIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/express-service-codes": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "express-service-codes"
        ],
        "summary": "Get the Express Service Code associated with your account in list format.",
        "description": "Get the Express Service Code associated with your account in list format. See Express Service Codes for more detail.",
        "operationId": "list-account-express-srv-codes",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListExpressServiceCodes"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/express-service-codes/{code_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "express-service-codes"
        ],
        "summary": "Show details of an account Express Service Code",
        "description": "This service shows the details of an Account Express Service Code.",
        "operationId": "get-account-express-srv-code",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "code_id",
            "in": "path",
            "description": "Device ID",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ExpressServiceCodeFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "extensions"
        ],
        "summary": "Get a list of extensions visible to the authenticated user or client.",
        "description": "Get a list of extensions visible to the authenticated user or client. See extension for more details.",
        "operationId": "list-account-extensions",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterExtension"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortExtension"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListExtensions"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "extensions"
        ],
        "summary": "Create an individual extension.",
        "description": "Create an individual extension. See extension for more details.",
        "operationId": "create-account-extension",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Account Extensions Data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateExtensionParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ExtensionFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions/{extension_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "extensions"
        ],
        "summary": "Show details of an individual extension.",
        "description": "Show details of an individual extension. See extension for more details.",
        "operationId": "get-account-extension",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/ExtensionFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "extensions"
        ],
        "summary": "Replace an individual extension.",
        "description": "Replace an individual extension. See extension for more details.",
        "operationId": "replace-account-extension",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Account Extensions Data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/ReplaceExtensionParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/ExtensionFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions/{extension_id}/caller-ids": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "caller-ids"
        ],
        "summary": "Show the Caller ID options a given extension can use.",
        "description": "Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.",
        "operationId": "get-caller-ids",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/filterNumber"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortNumber"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListCallerIds"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions/{extension_id}/contacts": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "contacts"
        ],
        "summary": "Show the Caller ID options a given extension can use.",
        "description": "Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.",
        "operationId": "list-account-extension-contacts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterGroupId"
          },
          {
            "$ref": "#/parameters/filterUpdatedAt"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortUpdatedAt"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListContacts"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "contacts"
        ],
        "summary": "Add a new address book contact for an extension.",
        "description": "Add a new address book contact for an extension. See Account Contacts for more info on the fields in each item.",
        "operationId": "create-account-extension-contact",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Contact data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateContactParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/ContactFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "contacts"
        ],
        "summary": "Retrieve the details of an address book contact.",
        "description": "Retrieve the details of an address book contact. See Account Contacts for more info on the fields in each item.",
        "operationId": "get-account-extension-contact",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/contactIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ContactFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "contacts"
        ],
        "summary": "Update the info of a contact in the address book.",
        "description": "Update the info of a contact in the address book. See Account Contacts for more info on the fields in each item.",
        "operationId": "replace-account-extension-contact",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/contactIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Contact data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateContactParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ContactFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "contacts"
        ],
        "summary": "Delete a contact from the address book.",
        "description": "Delete a contact from the address book. See Account Contacts for more info on the fields in each item.",
        "operationId": "delete-account-extension-contact",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/contactIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions/{extension_id}/contact-groups": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "groups"
        ],
        "summary": "Show a list of contact groups belonging to an extension.",
        "description": "Show a list of contact groups belonging to an extension. See Account Contact Groups for details on the properties.",
        "operationId": "list-account-extension-contact-groups",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListGroups"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "groups"
        ],
        "summary": "Add a new contact group to an account extension.",
        "description": "Add a new contact group to an account extension. See Account Contact Groups for details on the properties.",
        "operationId": "create-account-extension-contact-group",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Group data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateGroupParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/GroupFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/extensions/{extension_id}/contact-groups/{group_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "groups"
        ],
        "summary": "Retrieve the information of a contact group.",
        "description": "Retrieve the information of a contact group. See Account Contact Groups for details on the properties.",
        "operationId": "get-account-extension-contact-group",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/groupIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/GroupFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "groups"
        ],
        "summary": "Update the information of a contact group.",
        "description": "Update the information of a contact group. See Account Contact Groups for details on the properties.",
        "operationId": "replace-account-extension-contact-group",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/groupIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Group data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateGroupParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/GroupFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "groups"
        ],
        "summary": "Delete a contact group from the address book.",
        "description": "Delete a contact group from the address book. See Account Contact Groups for details on the properties.",
        "operationId": "delete-account-extension-contact-group",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/extensionIdParam"
          },
          {
            "$ref": "#/parameters/groupIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/media": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Get a list of media recordings for an account.",
        "description": "Get a list of media recordings for an account. See Account Media for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List Media API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/media",
        "operationId": "list-account-media",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListMedia"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/media/files": {
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Add a media object to your account that can be used as a greeting or hold music. Users may create a media by using the built-in Text-to-speech (TTS) facility or upload a file of their choice. (Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB)",
        "description": "See Account Media for more info on the properties.",
        "operationId": "create-account-media-files",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "json",
            "in": "formData",
            "description": "Media extra parameters",
            "required": false,
            "type": "string"
          },
          {
            "name": "file",
            "in": "formData",
            "description": "Media file",
            "required": false,
            "type": "file"
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MediaFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/media/tts": {
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Add a media object to your account that can be used as a greeting or hold music. Users may create a media by using the built-in Text-to-speech (TTS) facility or upload a file of their choice. (Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB)",
        "description": "See Account Media for more info on the properties.",
        "operationId": "create-account-media-tts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Media data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateMediaParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MediaFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/media/files/{media_id}": {
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Update a media object to your account. Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB.",
        "description": "See Account Media for more info on the properties.",
        "operationId": "replace-account-media-files",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/mediaIdParam"
          },
          {
            "name": "json",
            "in": "formData",
            "description": "Media extra parameters",
            "required": false,
            "type": "string"
          },
          {
            "name": "file",
            "in": "formData",
            "description": "Media file",
            "required": false,
            "type": "file"
          }
        ],
        "responses": {
          "201": {
            "description": "Replaced",
            "schema": {
              "$ref": "#/definitions/MediaFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/media/tts/{media_id}": {
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Update a media object to your account.",
        "description": "Update a media object to your account. Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB. See Account Media for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Replace Media API with the following definition: PUT https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/media/:media_id",
        "operationId": "replace-account-media-tts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/mediaIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Media data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateMediaParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Replaced",
            "schema": {
              "$ref": "#/definitions/MediaFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/media/{media_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Show details of an individual media recording (Greeting or Hold Music)",
        "description": "Get individual media recording",
        "operationId": "get-account-media",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/mediaIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/MediaFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "media"
        ],
        "summary": "Delete an individual media record",
        "description": "See Account Media for more info on the properties.",
        "operationId": "delete-account-media",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/mediaIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/menus": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "menus"
        ],
        "summary": "Get a list of menus for an account.",
        "description": "Get a list of menus for an account. See Account Menus for more info on the properties.",
        "operationId": "list-account-menus",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListMenus"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "menus"
        ],
        "summary": "Create an individual menu.",
        "description": "Create an individual menu. See Account Menus for more info on the properties.",
        "operationId": "create-account-menu",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Menu data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateMenuParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/MenuFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/menus/{menu_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "menus"
        ],
        "summary": "Show details of an individual menu.",
        "description": "Show details of an individual menu. See Account Menus for more info on the properties.",
        "operationId": "get-account-menu",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/menuIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/MenuFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "menus"
        ],
        "summary": "Replace an individual menu.",
        "description": "Replace an individual menu. See Account Menus for more info on the properties.",
        "operationId": "replace-account-menu",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/menuIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Menu data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/ReplaceMenuParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/MenuFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "menus"
        ],
        "summary": "Delete an individual menu.",
        "description": "Delete an individual menu. See Account Menus for more info on the properties.",
        "operationId": "delete-account-menu",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/menuIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/oauth/clients": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients"
        ],
        "summary": "Get a list of OAuth clients for an account.",
        "description": "Get a list of OAuth clients for an account. See Account OAuth Clients for more info on the properties.",
        "operationId": "list-account-oauth-clients",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListOauthClients"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/oauth/clients/{client_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients"
        ],
        "summary": "Show details of an individual OAuth client.",
        "description": "Show details of an individual OAuth client. See Account OAuth Clients for more info on the properties.",
        "operationId": "get-account-oauth-client",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/clientIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/OauthClientFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients"
        ],
        "summary": "Delete an individual OAuth client.",
        "description": "Delete an individual OAuth client. See Account OAuth Clients for more info on the properties.",
        "operationId": "delete-account-oauth-client",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/clientIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/oauth/clients/{client_id}/redirect-uris": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients-redirect-uris"
        ],
        "summary": "Get a list of OAuth Client Redirect URIs for an account.",
        "description": "Get a list of OAuth Client Redirect URIs for an account.",
        "operationId": "list-account-oauth-clients-redirect-uris",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/clientIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListOauthClientsRedirectUris"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients-redirect-uris"
        ],
        "summary": "Create an OAuth Client Redirect URI record.",
        "description": "Create an OAuth Client Redirect URI record.",
        "operationId": "create-account-oauth-clients-redirect-uri",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/clientIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Redirect Uri data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateRedirectUriParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/OauthClientRedirectUriFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/oauth/clients/{client_id}/redirect-uris/{uri_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients-redirect-uris"
        ],
        "summary": "Get details of an OAuth Client Redirect URI record.",
        "description": "Get details of an OAuth Client Redirect URI record.",
        "operationId": "get-account-oauth-clients-redirect-uri",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/clientIdParam"
          },
          {
            "$ref": "#/parameters/uriIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/OauthClientRedirectUriFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "oauth-clients-redirect-uris"
        ],
        "summary": "Delete an OAuth Client Redirect URI record.",
        "description": "Delete an OAuth Client Redirect URI record.",
        "operationId": "delete-account-oauth-clients-redirect-uri",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/clientIdParam"
          },
          {
            "$ref": "#/parameters/uriIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/payment-methods": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "payment-methods"
        ],
        "summary": "Get a list of payment methods for an account.",
        "description": "Get a list of payment methods for an account. See Account Payment Methods for more info on the properties.",
        "operationId": "list-account-payment-methods",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListPaymentMethods"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "payment-methods"
        ],
        "summary": "Create an individual payment method.",
        "description": "Create an individual payment method. See Account Payment Methods for more info on the properties.",
        "operationId": "create-account-payment-method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Payment data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreatePaymentParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/PaymentFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/payment-methods/{pm_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "payment-methods"
        ],
        "summary": "Show details of an individual payment method.",
        "description": "Show details of an individual payment method. See Account Payment Methods for more info on the properties.",
        "operationId": "get-account-payment-method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/paymentIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "patch": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "payment-methods"
        ],
        "summary": "Replace the status of an individual payment method.",
        "description": "Replace the status of an individual payment method. See Account Payment Methods for more info on the properties.",
        "operationId": "patch-account-payment-method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/paymentIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Payment data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/PatchPaymentParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PaymentFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "payment-methods"
        ],
        "summary": "Delete an individual payment method.",
        "description": "Delete an individual payment method. See Account Payment Methods for more info on the properties.",
        "operationId": "delete-account-payment-method",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/paymentIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/phone-numbers": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "phone-numbers"
        ],
        "summary": "Get a list of phone numbers registered to an account.",
        "description": "Get a list of phone numbers registered to an account. See Account Phone Numbers for more info on the properties.",
        "operationId": "list-account-phone-numbers",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/filterPhoneNumber"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/sortPhoneNumber"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListPhoneNumbers"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "phone-numbers"
        ],
        "summary": "Add a phone number to an account.",
        "description": "Add a phone number to an account. See Account Phone Numbers for more info on the properties.",
        "operationId": "create-account-phone-number",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Phone Number data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreatePhoneNumberParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/PhoneNumberFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/phone-numbers/{number_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "phone-numbers"
        ],
        "summary": "Show details of an individual phone number.",
        "description": "Show details of an individual phone number. See Account Phone Numbers for more info on the properties.",
        "operationId": "get-account-phone-number",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/numberIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PhoneNumberFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "phone-numbers"
        ],
        "summary": "Update the settings for an existing phone number on your account.",
        "description": "Update the settings for an existing phone number on your account. See Account Phone Numbers for more info on the properties.",
        "operationId": "replace-account-phone-number",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/numberIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Phone Number data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/ReplacePhoneNumberParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PhoneNumberFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/queues": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "queues"
        ],
        "summary": "Get a list of queues for an account.",
        "description": "Get a list of queues for an account. See Account Queues for more info on the properties.",
        "operationId": "list-account-queues",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListQueues"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "queues"
        ],
        "summary": "Create a queue.",
        "description": "Create a queue. See Account Queues for more info on the properties.",
        "operationId": "create-account-queue",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Queue data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateQueueParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/QueueFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/queues/{queue_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "queues"
        ],
        "summary": "Show details of an individual queue.",
        "description": "Show details of an individual queue. See Account Queues for more info on the properties.",
        "operationId": "get-account-queue",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/queueIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/QueueFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "queues"
        ],
        "summary": "Replace a queue.",
        "description": "Replace a queue. See Account Queues for more info on the properties.",
        "operationId": "replace-account-queue",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/queueIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Queue data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateQueueParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/QueueFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "queues"
        ],
        "summary": "Delete a queue.",
        "description": "Delete a queue. See Account Queues for more info on the properties.",
        "operationId": "delete-account-queue",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/queueIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/routes": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "routes"
        ],
        "summary": "Get a list of routes for an account.",
        "description": "Get a list of routes for an account. See Intro to Routes for more info on the properties.",
        "operationId": "list-account-routes",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListRoutes"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "routes"
        ],
        "summary": "Add a new route to the account.",
        "description": "Add a new route to the account. See Intro to Routes for more info on the properties.",
        "operationId": "create-route",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Route data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateRouteParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/RouteFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/routes/{route_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "routes"
        ],
        "summary": "Show details of an individual route.",
        "description": "Show details of an individual route. See Intro to Routes for more info on the properties.",
        "operationId": "get-account-route",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/routeIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/RouteFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "routes"
        ],
        "summary": "Update the information of a route.",
        "description": "Update the information of a route. See Intro to Routes for more info on the properties.",
        "operationId": "replace-account-route",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/routeIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Route data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/CreateRouteParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/RouteFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "routes"
        ],
        "summary": "Delete a route from the account.",
        "description": "Delete a route from the account. See Intro to Routes for more info on the properties.",
        "operationId": "delete-account-route",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/routeIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/schedules": {
      "get": {
        "tags": [
          "schedules"
        ],
        "summary": "Get a list of schedules for an account",
        "description": "Get a list of schedules for an account",
        "operationId": "list-account-schedules",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListSchedules"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts/{account_id}/schedules/{schedule_id}": {
      "get": {
        "tags": [
          "schedules"
        ],
        "summary": "Show details of an individual schedule",
        "description": "Show details of an individual schedule",
        "operationId": "get-account-schedule",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "schedule_id",
            "in": "path",
            "description": "Schedule ID",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ScheduleFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/accounts/{account_id}/sms": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "sms"
        ],
        "summary": "Get a list of SMS messages for an account.",
        "description": "Get a list of SMS messages for an account. See Intro to SMS for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List SMS API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms",
        "operationId": "list-account-sms",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterFrom"
          },
          {
            "$ref": "#/parameters/filterTo"
          },
          {
            "$ref": "#/parameters/filterDirectionSms"
          },
          {
            "$ref": "#/parameters/filterExtension"
          },
          {
            "$ref": "#/parameters/filterCreatedAtSmsVoicemail"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortCreatedAtSms"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListSms"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "sms"
        ],
        "summary": "Send a SMS to one or a group of recipients.",
        "description": "Send a SMS to one or a group of recipients. For details on the input fields, see Intro to SMS. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Create SMS API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms",
        "operationId": "create-account-sms",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "SMS data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateSmsParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/SmsFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          },
          "429": {
            "$ref": "#/responses/response429"
          }
        }
      }
    },
    "/accounts/{account_id}/sms/{sms_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "sms"
        ],
        "summary": "This service shows the details of an individual SMS.",
        "description": "This service shows the details of an individual SMS. See Intro to SMS for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Get SMS API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms/:sms_id",
        "operationId": "get-account-sms",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/smsIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/SmsFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "patch": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "sms"
        ],
        "summary": "Update the is_new parameter in a sms record.",
        "description": "Update the is_new parameter in a sms record. See Account SMS for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Patch SMS API with the following definition: PATCH https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms/:sms_id",
        "operationId": "patch-account-sms",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/smsIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Sms data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/PatchSmsParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/SmsFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      }
    },
    "/accounts/{account_id}/subaccounts": {
      "get": {
        "tags": [
          "subaccounts"
        ],
        "summary": "Get a list of subaccounts for the authenticated user or client",
        "description": "Get a list of subaccounts for the authenticated user or client",
        "operationId": "list-account-subaccounts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListAccounts"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "subaccounts"
        ],
        "summary": "Add a subaccount for the authenticated user or client",
        "description": "Add a subaccount for the authenticated user or client",
        "operationId": "create-account-subaccount",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Subaccount data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateSubaccountParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/AccountFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/subaccounts/{subaccount_id}/pricing": {
      "get": {
        "tags": [
          "subaccount-pricing"
        ],
        "summary": "Get a list of pricing plans for a subaccount.",
        "description": "Get a list of pricing plans for a subaccount. See Account Subaccount Pricing for more info on the properties.",
        "operationId": "list-account-subaccount-pricing",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/subaccountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListPricings"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "subaccount-pricing"
        ],
        "summary": "Add a pricing plan to a subaccount.",
        "description": "Add a pricing plan to a subaccount. See Account Subaccount Pricing for more info on the properties.",
        "operationId": "create-account-subaccount-pricing",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/subaccountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Subaccount pricing data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreatePricingParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/PricingFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/subaccounts/{subaccount_id}/pricing/{pricing_id}": {
      "get": {
        "tags": [
          "subaccount-pricing"
        ],
        "summary": "Get the details of a pricing plan for a subaccount.",
        "description": "Get the details of a pricing plan for a subaccount. See Account Subaccount Pricing for more info on the properties.",
        "operationId": "get-account-subaccount-pricing",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/subaccountIdParam"
          },
          {
            "$ref": "#/parameters/pricingIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PricingFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "subaccount-pricing"
        ],
        "summary": "Delete a pricing plan from a subaccount.",
        "description": "Delete a pricing plan from a subaccount. See Account Subaccount Pricing for more info on the properties.",
        "operationId": "delete-account-subaccount-pricing",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/subaccountIdParam"
          },
          {
            "$ref": "#/parameters/pricingIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/trunks": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "trunks"
        ],
        "summary": "Get a list of trunks for an account.",
        "description": "Get a list of trunks for an account. See Account Trunks for more info on the properties.",
        "operationId": "list-account-trunks",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterNameParam"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortNameParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListTrunks"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      },
      "post": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "trunks"
        ],
        "summary": "Add a trunk record with SIP information.",
        "description": "Add a trunk record with SIP information. See Account Trunks for more info on the properties.",
        "operationId": "create-account-trunk",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Trunk data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateTrunkParams"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/TrunkFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/accounts/{account_id}/trunks/{trunk_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "trunks"
        ],
        "summary": "Show details of an individual trunk.",
        "description": "Show details of an individual trunk. See Account Trunks for more info on the properties.",
        "operationId": "get-account-trunk",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/trunkIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/TrunkFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "put": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "trunks"
        ],
        "summary": "Replace parameters in a trunk.",
        "description": "Replace parameters in a trunk. See Account Trunks for more info on the properties.",
        "operationId": "replace-account-trunk",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/trunkIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Trunk data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CreateTrunkParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/TrunkFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      },
      "delete": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "trunks"
        ],
        "summary": "Delete a trunk from account.",
        "description": "Delete a trunk from account. See Account Trunks for more info on the properties.",
        "operationId": "delete-account-trunk",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/trunkIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/DeleteEntry"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "409": {
            "$ref": "#/responses/response409"
          }
        }
      }
    },
    "/accounts/{account_id}/voicemail": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "voicemail"
        ],
        "summary": "Get a list of voicemail messages for an account.",
        "description": "Get a list of voicemail messages for an account. See Intro to Voicemail for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the List Voicemail API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/voicemail",
        "operationId": "list-account-voicemail",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/filterIdParam"
          },
          {
            "$ref": "#/parameters/filterFrom"
          },
          {
            "$ref": "#/parameters/filterTo"
          },
          {
            "$ref": "#/parameters/filterIsNew"
          },
          {
            "$ref": "#/parameters/filterCreatedAtSmsVoicemail"
          },
          {
            "$ref": "#/parameters/filterExtension"
          },
          {
            "$ref": "#/parameters/sortIdParam"
          },
          {
            "$ref": "#/parameters/sortCreatedAtVoicemail"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListVoicemail"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/accounts/{account_id}/voicemail/{voicemail_id}": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "voicemail"
        ],
        "summary": "This service shows the details of an individual voicemail.",
        "description": "This service shows the details of an individual voicemail. See Intro to Voicemail for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Get Voicemail API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/voicemail/:voicemail_id",
        "operationId": "get-account-voicemail",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/voicemailIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/VoicemailFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          }
        }
      },
      "patch": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "voicemail"
        ],
        "summary": "Update the is_new parameter in a voicemail record.",
        "description": "Update the is_new parameter in a voicemail record. See Account Voicemail for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Patch Voicemail API with the following definition: PATCH https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/voicemail/:voicemail_id",
        "operationId": "patch-account-voicemail",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/accountIdParam"
          },
          {
            "$ref": "#/parameters/voicemailIdParam"
          },
          {
            "name": "data",
            "in": "body",
            "description": "Payment data",
            "required": false,
            "schema": {
              "$ref": "#/definitions/PatchVoicemailParams"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/VoicemailFull"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "403": {
            "$ref": "#/responses/response403"
          },
          "404": {
            "$ref": "#/responses/response404"
          },
          "422": {
            "$ref": "#/responses/response422"
          }
        }
      }
    },
    "/phone-numbers/available": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "available-numbers"
        ],
        "summary": "",
        "description": "",
        "operationId": "list-available-phone-numbers",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/filterPhoneNumber"
          },
          {
            "$ref": "#/parameters/filterCountryCode"
          },
          {
            "$ref": "#/parameters/filterNpa"
          },
          {
            "$ref": "#/parameters/filterNxx"
          },
          {
            "$ref": "#/parameters/filterXxxx"
          },
          {
            "$ref": "#/parameters/filterCity"
          },
          {
            "$ref": "#/parameters/filterProvince"
          },
          {
            "$ref": "#/parameters/filterCountry"
          },
          {
            "$ref": "#/parameters/filterPrice"
          },
          {
            "$ref": "#/parameters/filterCategory"
          },
          {
            "$ref": "#/parameters/sortInternal"
          },
          {
            "$ref": "#/parameters/sortPrice"
          },
          {
            "$ref": "#/parameters/sortPhoneNumber"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListAvailableNumbers"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "429": {
            "$ref": "#/responses/response403"
          }
        }
      }
    },
    "/phone-numbers/available/regions": {
      "get": {
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "number-regions"
        ],
        "summary": "",
        "description": "This service lists the quantities of available phone numbers by region.",
        "operationId": "list-available-phone-number-regions",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/filterCountryCode"
          },
          {
            "$ref": "#/parameters/filterNpa"
          },
          {
            "$ref": "#/parameters/filterNxx"
          },
          {
            "$ref": "#/parameters/filterIsTollFree"
          },
          {
            "$ref": "#/parameters/filterCity"
          },
          {
            "$ref": "#/parameters/filterProvincePostalCode"
          },
          {
            "$ref": "#/parameters/filterCountryPostalCode"
          },
          {
            "$ref": "#/parameters/sortCountryCode"
          },
          {
            "$ref": "#/parameters/sortNpa"
          },
          {
            "$ref": "#/parameters/sortNxx"
          },
          {
            "$ref": "#/parameters/sortIsTollFree"
          },
          {
            "$ref": "#/parameters/sortCity"
          },
          {
            "$ref": "#/parameters/sortProvincePostalCode"
          },
          {
            "$ref": "#/parameters/sortCountryPostalCode"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/fieldsParam"
          },
          {
            "name": "group_by",
            "in": "query",
            "description": "Fields to group by (supports the same set of fields as the filters and sorting)",
            "required": false,
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ListPhoneNumbersRegions"
            }
          },
          "401": {
            "$ref": "#/responses/response401"
          },
          "429": {
            "$ref": "#/responses/response403"
          }
        }
      }
    }
  },
  "parameters": {
    "filterIdParam": {
      "name": "filters[id]",
      "in": "query",
      "description": "ID filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterNameParam": {
      "name": "filters[name]",
      "in": "query",
      "description": "Name filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterStartTimeParam": {
      "name": "filters[start_time]",
      "in": "query",
      "description": "Call start time filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterCreatedAtCallLogsParam": {
      "name": "filters[created_at]",
      "in": "query",
      "description": "Call log creation time filter",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterCreatedAtSmsVoicemail": {
      "name": "filters[created_at]",
      "in": "query",
      "description": "Date string representing the UTC time that sms was created",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterDirectionCallLogs": {
      "name": "filters[direction]",
      "in": "query",
      "description": "Call direction filter: in or out",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterDirectionSms": {
      "name": "filters[direction]",
      "in": "query",
      "description": "Direction filter",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterCalledNumber": {
      "name": "filters[called_number]",
      "in": "query",
      "description": "Called number",
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterType": {
      "name": "filters[type]",
      "in": "query",
      "description": "Call type, such as 'call', 'fax', 'audiogram'",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterExtension": {
      "name": "filters[extension]",
      "in": "query",
      "description": "Extension filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterNumber": {
      "name": "filters[number]",
      "in": "query",
      "description": "Number filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterGroupId": {
      "name": "filters[group_id]",
      "in": "query",
      "description": "Group filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterUpdatedAt": {
      "name": "filters[updated_at]",
      "in": "query",
      "description": "Updated At filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterPhoneNumber": {
      "name": "filters[phone_number]",
      "in": "query",
      "description": "Phone number filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterFrom": {
      "name": "filters[from]",
      "in": "query",
      "description": "Caller ID filter",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterTo": {
      "name": "filters[to]",
      "in": "query",
      "description": "Callee ID filter, the E.164 phone number to send the SMS TO. Note you must encode the + as %2B",
      "required": false,
      "type": "string",
      "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
    },
    "filterCountryCode": {
      "name": "filters[country_code]",
      "in": "query",
      "description": "Country Code filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterIsNew": {
      "name": "filters[is_new]",
      "in": "query",
      "required": false,
      "type": "boolean"
    },
    "filterNpa": {
      "name": "filters[npa]",
      "in": "query",
      "description": "Area Code filter (North America only)",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterNxx": {
      "name": "filters[nxx]",
      "in": "query",
      "description": "2nd set of 3 digits filter (North America only)",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterXxxx": {
      "name": "filters[xxxx]",
      "in": "query",
      "description": "NANP XXXX filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterCity": {
      "name": "filters[city]",
      "in": "query",
      "description": "City filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterProvince": {
      "name": "filters[province]",
      "in": "query",
      "description": "State or Province (postal code) filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterCountry": {
      "name": "filters[country]",
      "in": "query",
      "description": "Country (postal code) filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterPrice": {
      "name": "filters[price]",
      "in": "query",
      "description": "Price filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterCategory": {
      "name": "filters[category]",
      "in": "query",
      "description": "Category filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterIsTollFree": {
      "name": "filters[is_toll_free]",
      "in": "query",
      "description": "Toll-free status filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterProvincePostalCode": {
      "name": "filters[province_postal_code]",
      "in": "query",
      "description": "State or Province filter",
      "required": false,
      "type": "array",
      "collectionFormat": "multi",
      "items": {
        "type": "string",
        "pattern": "^eq:.*|^ne:.*|^lt:.*|^gt:.*|^lte:.*|^gte:.*|^starts-with:.*|^ends-with:.*|^contains:.*|^not-starts-with:.*|^not-ends-with:.*|^not-contains:.*|^between:.*,.*|^not-between:.*,.*"
      }
    },
    "filterCountryPostalCode": {
      "name": "filters[country_postal_code]",
      "in": "query",
      "description": "Country filter",
      "required": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortIdParam": {
      "name": "sort[id]",
      "in": "query",
      "description": "ID sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortNameParam": {
      "name": "sort[name]",
      "in": "query",
      "description": "Name sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortStartTime": {
      "name": "sort[start_time]",
      "in": "query",
      "description": "Sorting by call start time: asc or desc",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortCreatedAtCallLogs": {
      "name": "sort[created_at]",
      "in": "query",
      "description": "Sorting by call log creation time: asc or desc",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortCreatedAtSms": {
      "name": "sort[created_at]",
      "in": "query",
      "description": "Sort by created time of message",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortCreatedAtVoicemail": {
      "name": "sort[created_at]",
      "in": "query",
      "description": "Sort by the UTC time that voicemail was created",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortExtension": {
      "name": "sort[extension]",
      "in": "query",
      "description": "Extension sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortNumber": {
      "name": "sort[number]",
      "in": "query",
      "description": "Number sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortUpdatedAt": {
      "name": "sort[updated_at]",
      "in": "query",
      "description": "Updated At sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortPhoneNumber": {
      "name": "sort[phone_number]",
      "in": "query",
      "description": "Phone number sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortInternal": {
      "name": "sort[internal]",
      "in": "query",
      "description": "Internal (quasi-random) sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortPrice": {
      "name": "sort[price]",
      "in": "query",
      "description": "Price sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortCountryCode": {
      "name": "sort[country_code]",
      "in": "query",
      "description": "International calling code sorting",
      "required": false,
      "type": "string"
    },
    "sortNpa": {
      "name": "sort[npa]",
      "in": "query",
      "description": "Area Code sorting (North America only)",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortNxx": {
      "name": "sort[nxx]",
      "in": "query",
      "description": "2nd set of 3 digits sorting (North America)",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortIsTollFree": {
      "name": "sort[is_toll_free]",
      "in": "query",
      "description": "Toll Free status sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortCity": {
      "name": "sort[city]",
      "in": "query",
      "description": "City sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortProvincePostalCode": {
      "name": "sort[province_postal_code]",
      "in": "query",
      "description": "State or Province sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "sortCountryPostalCode": {
      "name": "sort[country_postal_code]",
      "in": "query",
      "description": "Country sorting",
      "required": false,
      "type": "string",
      "pattern": "asc|desc"
    },
    "limitParam": {
      "name": "limit",
      "in": "query",
      "description": "Max results",
      "required": false,
      "type": "integer"
    },
    "offsetParam": {
      "name": "offset",
      "in": "query",
      "description": "Results to skip",
      "required": false,
      "type": "integer"
    },
    "fieldsParam": {
      "name": "fields",
      "in": "query",
      "description": "Field set",
      "required": false,
      "type": "string"
    },
    "accountIdParam": {
      "name": "account_id",
      "in": "path",
      "description": "Account ID",
      "required": true,
      "type": "integer"
    },
    "subaccountIdParam": {
      "name": "subaccount_id",
      "in": "path",
      "description": "Subaccount ID",
      "required": true,
      "type": "integer"
    },
    "pricingIdParam": {
      "name": "pricing_id",
      "in": "path",
      "description": "Pricing Object ID",
      "required": true,
      "type": "integer"
    },
    "extensionIdParam": {
      "name": "extension_id",
      "in": "path",
      "description": "Extension ID",
      "required": true,
      "type": "integer"
    },
    "callIdParam": {
      "name": "call_id",
      "in": "path",
      "description": "Call ID",
      "required": true,
      "type": "string"
    },
    "deviceIdParam": {
      "name": "device_id",
      "in": "path",
      "description": "Device ID",
      "required": true,
      "type": "integer"
    },
    "listenerIdParam": {
      "name": "listener_id",
      "in": "path",
      "description": "Listener ID",
      "required": true,
      "type": "integer"
    },
    "contactIdParam": {
      "name": "contact_id",
      "in": "path",
      "description": "Contact ID",
      "required": true,
      "type": "integer"
    },
    "groupIdParam": {
      "name": "group_id",
      "in": "path",
      "description": "Group ID",
      "required": true,
      "type": "integer"
    },
    "mediaIdParam": {
      "name": "media_id",
      "in": "path",
      "description": "Media ID",
      "required": true,
      "type": "integer"
    },
    "menuIdParam": {
      "name": "menu_id",
      "in": "path",
      "description": "Menu ID",
      "required": true,
      "type": "integer"
    },
    "clientIdParam": {
      "name": "client_id",
      "in": "path",
      "description": "Client ID",
      "required": true,
      "type": "integer"
    },
    "uriIdParam": {
      "name": "uri_id",
      "in": "path",
      "description": "Redirect URI ID",
      "required": true,
      "type": "integer"
    },
    "paymentIdParam": {
      "name": "pm_id",
      "in": "path",
      "description": "Payment Method ID",
      "required": true,
      "type": "integer"
    },
    "numberIdParam": {
      "name": "number_id",
      "in": "path",
      "description": "Number ID",
      "required": true,
      "type": "integer"
    },
    "queueIdParam": {
      "name": "queue_id",
      "in": "path",
      "description": "Queue ID",
      "required": true,
      "type": "integer"
    },
    "routeIdParam": {
      "name": "route_id",
      "in": "path",
      "description": "Route ID",
      "required": true,
      "type": "integer"
    },
    "smsIdParam": {
      "name": "sms_id",
      "in": "path",
      "description": "SMS ID",
      "required": true,
      "type": "string"
    },
    "trunkIdParam": {
      "name": "trunk_id",
      "in": "path",
      "description": "Trunk ID",
      "required": true,
      "type": "integer"
    },
    "voicemailIdParam": {
      "name": "voicemail_id",
      "in": "path",
      "description": "Voicemail ID",
      "required": true,
      "type": "string"
    }
  },
  "responses": {
    "response401": {
      "description": "Unauthorized access"
    },
    "response403": {
      "description": "Forbidden"
    },
    "response404": {
      "description": "Not Found"
    },
    "response409": {
      "description": "Conflict"
    },
    "response422": {
      "description": "Invalid Data"
    },
    "response429": {
      "description": "Rate Limit Reached"
    }
  },
  "definitions": {
    "CreateOauthParams": {
      "type": "object",
      "properties": {
        "grant_type": {
          "type": "string",
          "description": "authorization_code, client_credentials, password or refresh_token"
        },
        "client_id": {
          "type": "string",
          "description": "Client ID"
        },
        "client_secret": {
          "type": "string",
          "description": "Client Secret Key"
        },
        "code": {
          "type": "string",
          "description": "Authorization Code created via the /oauth/authorization API"
        },
        "redirect_uri": {
          "type": "string",
          "description": "The redirect URI where user enters authentication information"
        },
        "scope": {
          "type": "string",
          "description": "account-owner, extension-user and/or methods:ALL, separated by space (%20)"
        },
        "username": {
          "type": "string",
          "description": "User name"
        },
        "password": {
          "type": "string",
          "description": "Password"
        },
        "refresh_token": {
          "type": "string",
          "description": "Refresh token"
        }
      }
    },
    "CreateCallParams": {
      "type": "object",
      "properties": {
        "caller_phone_number": {
          "type": "string",
          "description": "Caller phone number in E.164 format"
        },
        "caller_extension": {
          "type": "integer",
          "description": "Caller Extension ID"
        },
        "caller_caller_id": {
          "type": "string",
          "description": "Caller caller ID in E.164 format"
        },
        "caller_private": {
          "type": "string",
          "description": "Flag to set caller ID to private"
        },
        "callee_phone_number": {
          "type": "string",
          "description": "Callee phone number in E.164 format"
        },
        "callee_extension": {
          "type": "integer",
          "description": "Callee Extension ID"
        },
        "callee_caller_id": {
          "type": "string",
          "description": "Callee caller ID in E.164 format"
        },
        "callee_private": {
          "type": "string",
          "description": "Flag to set callee ID to private"
        }
      }
    },
    "PingResponse": {
      "description": "The ping response object.",
      "type": "object",
      "properties": {
        "datetime": {
          "type": "string"
        },
        "remote_ip": {
          "type": "string"
        },
        "timestamp": {
          "type": "integer"
        },
        "user_agent": {
          "type": "string"
        }
      }
    },
    "CreateDeviceParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Device Name"
        },
        "lines": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "List of line objects"
        }
      }
    },
    "CreateListenerParams": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of listener. Must be 'callback'"
        },
        "event_type": {
          "type": "string",
          "description": "Type of event to subscribe. 'call.new', 'call.update', 'call.complete'"
        },
        "callbacks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CallbackObject"
          },
          "description": "Array of Callback Objects."
        }
      }
    },
    "CallbackObject": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "URL of webhook, where the event is emitted to. Note: The listener supports both HTTP & HTTPS, we highly recommend that users use HTTPS on all callbacks (with user name and password) to ensure no one may send malicious events pretending to be Phone.com."
        },
        "role": {
          "type": "string",
          "description": "Role of callback: main or backup"
        },
        "verb": {
          "type": "string",
          "description": "HTTP method: get or post"
        },
        "username": {
          "type": "string",
          "description": "Optional user name needed to logon to the webhook URL"
        },
        "password": {
          "type": "string",
          "description": "Optional password needed to logon to the webhook URL"
        },
        "timeout": {
          "type": "integer",
          "description": "Optional : Duration of HTTP response will time out while sending the event to the callback URL. (1 - 10 seconds)"
        }
      }
    },
    "CreateExtensionParams": {
      "type": "object",
      "properties": {
        "voicemail": {
          "$ref": "#/definitions/VoicemailInput"
        },
        "call_notifications": {
          "$ref": "#/definitions/CallNotifications"
        },
        "caller_id": {
          "type": "string",
          "description": "Caller ID"
        },
        "usage_type": {
          "type": "string",
          "description": "Extension type"
        },
        "extension": {
          "type": "integer",
          "description": "Extension number (auto-generated if empty)"
        },
        "include_in_directory": {
          "type": "string",
          "description": "Include in dial-by-name directory"
        },
        "name": {
          "type": "string",
          "description": "Name (auto-generated if empty)"
        },
        "full_name": {
          "type": "string",
          "description": "Contact name"
        },
        "timezone": {
          "type": "string",
          "description": "Timezone"
        },
        "name_greeting": {
          "type": "object",
          "description": "Recording lookup object"
        },
        "local_area_code": {
          "type": "string",
          "description": "Local area code"
        },
        "enable_outbound_calls": {
          "type": "string",
          "description": "Enable outgoing calls"
        },
        "enable_call_waiting": {
          "type": "string",
          "description": "Enable Call Waiting"
        }
      }
    },
    "ReplaceExtensionParams": {
      "type": "object",
      "properties": {
        "voicemail": {
          "$ref": "#/definitions/VoicemailInput"
        },
        "call_notifications": {
          "$ref": "#/definitions/CallNotifications"
        },
        "name_greeting": {
          "type": "object",
          "description": "Recording lookup object"
        },
        "name": {
          "type": "string",
          "description": "Name (required)"
        },
        "timezone": {
          "type": "string",
          "description": "Timezone"
        },
        "include_in_directory": {
          "type": "string",
          "description": "Include in dial-by-name directory"
        },
        "extension": {
          "type": "integer",
          "description": "Extension number (required)"
        },
        "enable_outbound_calls": {
          "type": "string",
          "description": "Enable outgoing calls"
        },
        "usage_type": {
          "type": "string",
          "description": "Extension type"
        },
        "full_name": {
          "type": "string",
          "description": "Contact name"
        },
        "enable_call_waiting": {
          "type": "string",
          "description": "Enable Call Waiting"
        },
        "caller_id": {
          "type": "string",
          "description": "Caller ID"
        },
        "local_area_code": {
          "type": "string",
          "description": "Local area code"
        },
        "route": {
          "type": "string",
          "description": "Route object lookup (must belong to this extension)"
        }
      }
    },
    "CreateContactParams": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First Name"
        },
        "middle_name": {
          "type": "string",
          "description": "Middle Name"
        },
        "last_name": {
          "type": "string",
          "description": "Last Name"
        },
        "prefix": {
          "type": "string",
          "description": "Prefix"
        },
        "phonetic_first_name": {
          "type": "string",
          "description": "Phonetic First Name"
        },
        "phonetic_middle_name": {
          "type": "string",
          "description": "Phonetic Middle Name"
        },
        "phonetic_last_name": {
          "type": "string",
          "description": "Phonetic Last Name"
        },
        "suffix": {
          "type": "string",
          "description": "Suffix"
        },
        "nickname": {
          "type": "string",
          "description": "Nickname"
        },
        "company": {
          "type": "string",
          "description": "Company Name"
        },
        "department": {
          "type": "string",
          "description": "Department Name"
        },
        "job_title": {
          "type": "string",
          "description": "Job Title"
        },
        "emails": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Email"
          },
          "description": "Email Addresses"
        },
        "phone_numbers": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PhoneNumberContact"
          },
          "description": "Phone Numbers"
        },
        "addresses": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AddressListContacts"
          },
          "description": "Addresses"
        },
        "group": {
          "type": "object",
          "description": "Contact Group"
        }
      }
    },
    "CreateGroupParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Group name"
        }
      }
    },
    "CreateMediaParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of media"
        },
        "origin": {
          "type": "string",
          "description": "'tts', 'file'"
        },
        "type": {
          "type": "string",
          "description": "'hold_music', 'greeting'"
        },
        "tts_voice": {
          "type": "string",
          "description": "'allison', 'amy', 'belle', 'callie', 'callieq', 'dallas', 'damien', 'david', 'designerdave', 'diane', 'diesel', 'dog', 'duchess', 'duncan', 'emily', 'evilgenius', 'frank', 'french-fry', 'gregory', 'isabelle', 'jean-pierre', 'jerkface', 'katrin', 'kayla', 'kidaroo', 'lawrence', 'layo', 'linda', 'marta', 'matthias', 'miguel', 'millie', 'princess', 'ransomnote', 'robin', 'shouty', 'shygirl', 'tamika', 'tophat', 'vittoria', 'vixen', 'vlad', 'walter', 'whispery', 'william', 'wiseguy', 'zach'"
        },
        "tts_text": {
          "type": "string",
          "description": "Text used for text-to-speech conversion, maximum 800 characters"
        },
        "is_temparary": {
          "type": "string",
          "description": "'Y', 'N'. Media file is temporary, will be deleted after a specified period."
        },
        "expiration_date": {
          "type": "integer",
          "description": "If is_temporary is 'Y', media will be deleted after the specified time in seconds"
        },
        "duration": {
          "type": "integer",
          "description": "Length of media in seconds"
        },
        "notes": {
          "type": "string",
          "description": "Notes about the media object"
        },
        "randomized": {
          "type": "string",
          "description": "'Y', 'N'. Start playing the media file in random location, instead of from the beginning"
        }
      }
    },
    "CreateMenuParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "greeting": {
          "type": "object"
        },
        "keypress_error": {
          "type": "object"
        },
        "allow_extension_dial": {
          "type": "string"
        },
        "keypress_wait_time": {
          "type": "integer"
        },
        "timeout_handler": {
          "type": "object"
        },
        "options": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    "ReplaceMenuParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "greeting": {
          "type": "object"
        },
        "keypress_error": {
          "type": "object"
        },
        "allow_extension_dial": {
          "type": "string"
        },
        "keypress_wait_time": {
          "type": "integer"
        },
        "timeout_handler": {
          "type": "object"
        },
        "options": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    "CreatePaymentParams": {
      "type": "object",
      "properties": {
        "nickname": {
          "type": "string",
          "description": "Name of payment method"
        },
        "status": {
          "type": "string",
          "description": "primary, onfile or hidden"
        },
        "type": {
          "type": "string",
          "description": "Credit Card Type"
        },
        "cc_token": {
          "type": "string",
          "description": "Credit Card Token. Token is obtained by entering credit card info via the Credit Card Entry Form"
        }
      }
    },
    "CreateRedirectUriParams": {
      "type": "object",
      "properties": {
        "redirect_uri": {
          "type": "string",
          "description": "Redirect URI string for use in redirect-based flows such as the authorization code and implicit flows"
        }
      }
    },
    "PatchPaymentParams": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "primary, onfile or hidden"
        }
      }
    },
    "CreatePhoneNumberParams": {
      "type": "object",
      "properties": {
        "phone_number": {
          "type": "object",
          "description": "Phone number"
        },
        "route": {
          "type": "object",
          "description": "Route lookup object"
        },
        "name": {
          "type": "string",
          "description": "Phone Name"
        },
        "block_incoming": {
          "type": "string",
          "description": "Block incoming calls"
        },
        "block_anonymous": {
          "type": "string",
          "description": "Block anonymous calls"
        },
        "caller_id": {
          "$ref": "#/definitions/CallerIdPhoneNumber"
        },
        "sms_forwarding": {
          "$ref": "#/definitions/SmsForwardingParams"
        },
        "call_notifications": {
          "$ref": "#/definitions/CallNotifications"
        }
      }
    },
    "SmsForwardingParams": {
      "description": "SMS Forwarding Object, or NULL",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Can be \"extension\" or \"application\"",
          "pattern": "extension|application"
        },
        "extension": {
          "type": "integer",
          "description": "Required if type = \"extension\". Extension that messages should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object."
        },
        "application": {
          "type": "integer",
          "description": "Required if type = \"application\". Application that messages should be directed to. Output is an Application Summary Object. Input must be an Application Lookup Object."
        }
      }
    },
    "ReplacePhoneNumberParams": {
      "type": "object",
      "properties": {
        "route": {
          "type": "object",
          "description": "Route lookup object"
        },
        "name": {
          "type": "string",
          "description": "Phone Name"
        },
        "block_incoming": {
          "type": "string",
          "description": "Block incoming calls"
        },
        "block_anonymous": {
          "type": "string",
          "description": "Block anonymous calls"
        },
        "caller_id": {
          "$ref": "#/definitions/CallerIdPhoneNumber"
        },
        "sms_forwarding": {
          "$ref": "#/definitions/SmsForwardingParams"
        },
        "pool_item": {
          "type": "object",
          "description": "Pool lookup object"
        },
        "call_notifications": {
          "$ref": "#/definitions/CallNotifications"
        }
      }
    },
    "CreateQueueParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of queue"
        },
        "greeting": {
          "type": "object",
          "description": "Recording lookup object"
        },
        "hold_music": {
          "type": "object",
          "description": "Recording lookup object"
        },
        "max_hold_time": {
          "type": "integer",
          "description": "Max seconds for hold"
        },
        "caller_id_type": {
          "type": "string",
          "description": "Type of caller id"
        },
        "ring_time": {
          "type": "integer",
          "description": "Number of seconds to ring each member"
        },
        "members": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Extensions or phone numbers"
        }
      }
    },
    "CreateRouteParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name"
        },
        "rules": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Rule Sets"
        },
        "extension": {
          "type": "object",
          "description": "Extension Reference"
        }
      }
    },
    "CreateSmsParams": {
      "type": "object",
      "required": [
        "from",
        "to",
        "text"
      ],
      "properties": {
        "from": {
          "type": "string",
          "description": "Phone number of sender"
        },
        "to": {
          "type": "string",
          "description": "Outgoing destination numbers"
        },
        "text": {
          "type": "string",
          "description": "Text body of the outgoing SMS message. Maximum 160 characters per message."
        },
        "extension_id": {
          "type": "integer",
          "description": "ID of Extension where the sms is saved"
        }
      }
    },
    "PatchSmsParams": {
      "type": "object",
      "properties": {
        "is_new": {
          "type": "string",
          "description": "Status of SMS"
        }
      }
    },
    "CreateSubaccountParams": {
      "type": "object",
      "required": [
        "username",
        "password"
      ],
      "properties": {
        "username": {
          "type": "string",
          "description": "Sub account password"
        },
        "password": {
          "type": "string",
          "description": "Sub account password"
        },
        "contact": {
          "$ref": "#/definitions/ContactResponse",
          "description": "Contact Object. See below for details."
        },
        "billing_contact": {
          "$ref": "#/definitions/ContactResponse",
          "description": "Contact Object for billing purposes. See below for details."
        }
      }
    },
    "CreatePricingParams": {
      "type": "object",
      "properties": {
        "pricing_id": {
          "type": "integer",
          "description": "Pricing plan code"
        },
        "reason": {
          "type": "string",
          "description": "Reason this pricing plan is added to the subaccount"
        },
        "expire_date": {
          "type": "integer",
          "description": "Pricing plan expiration time in UNIX format. Disregard or set it to null for plan which never expires"
        }
      }
    },
    "CreateTrunkParams": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of Trunk"
        },
        "uri": {
          "type": "string",
          "description": "URI of Trunk (in the form of SIP/user@host.com:port)"
        },
        "max_concurrent_calls": {
          "type": "integer",
          "description": "Max concurrent calls"
        },
        "max_minutes_per_month": {
          "type": "integer",
          "description": "Max minutes per month"
        },
        "greeting": {
          "type": "object",
          "description": "Recording lookup object"
        },
        "error_message": {
          "type": "object",
          "description": "Recording lookup object"
        },
        "codecs": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Custom audio codec configuration"
        }
      }
    },
    "PatchVoicemailParams": {
      "type": "object",
      "properties": {
        "is_new": {
          "type": "string",
          "description": "Status of voicemail"
        }
      }
    },
    "GetOauthAccessToken": {
      "type": "object",
      "properties": {
        "scope": {
          "type": "string"
        },
        "expires_at": {
          "type": "integer"
        },
        "scope_details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ScopeDetails"
          }
        }
      }
    },
    "ListAccounts": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdArray"
        },
        "sort": {
          "$ref": "#/definitions/SortId"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AccountFull"
          }
        }
      }
    },
    "ListPricings": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdArray"
        },
        "sort": {
          "$ref": "#/definitions/SortId"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PricingFull"
          }
        }
      }
    },
    "ListApplications": {
      "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/ApplicationFull"
          }
        }
      }
    },
    "ListCallLogs": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterCallLogs"
        },
        "sort": {
          "$ref": "#/definitions/SortCallLogs"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CallLogFull"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "ListListeners": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdArray"
        },
        "sort": {
          "$ref": "#/definitions/SortId"
        },
        "total": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ListenerFull"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "ListExtensions": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdExtensionNameArray"
        },
        "sort": {
          "$ref": "#/definitions/SortIdExtensionName"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ExtensionFull"
          }
        }
      }
    },
    "ListCallerIds": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterNameNumberArray"
        },
        "sort": {
          "$ref": "#/definitions/SortNameNumber"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CallerIdFull"
          }
        }
      }
    },
    "ListContacts": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdGroupIdUpdatedAtArray"
        },
        "sort": {
          "$ref": "#/definitions/SortIdUpdatedAt"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ContactFull"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "ListOauthClients": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdArray"
        },
        "sort": {
          "$ref": "#/definitions/SortId"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OauthClientFull"
          }
        }
      }
    },
    "ListOauthClientsRedirectUris": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdArray"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OauthClientRedirectUriFull"
          }
        }
      }
    },
    "ListPaymentMethods": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdArray"
        },
        "sort": {
          "$ref": "#/definitions/SortId"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/PaymentFull"
          }
        }
      }
    },
    "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/PhoneNumberFull"
          }
        }
      }
    },
    "PhoneNumberContact": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of phone number, must be one of: home, business, mobile, fax, pager. Default is home."
        },
        "number": {
          "type": "string",
          "description": "Phone number, as entered. Does not need to be formatted in any particular way. Required."
        },
        "normalized": {
          "type": "string",
          "description": "Phone number in E.164 format. Read-only."
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "ListSchedules": {
      "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/ScheduleFull"
          }
        }
      }
    },
    "ListSms": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterIdDirectionFrom"
        },
        "sort": {
          "$ref": "#/definitions/SortIdCreatedAt"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SmsFull"
          }
        }
      }
    },
    "ListTrunks": {
      "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/TrunkFull"
          }
        }
      }
    },
    "ListVoicemail": {
      "type": "object",
      "properties": {
        "filters": {
          "$ref": "#/definitions/FilterVoicemailArray"
        },
        "sort": {
          "$ref": "#/definitions/SortIdCreatedAt"
        },
        "total": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/VoicemailFull"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "ScopeDetails": {
      "type": "object",
      "properties": {
        "voip_id": {
          "type": "integer"
        }
      }
    },
    "OauthAccessToken": {
      "type": "object",
      "properties": {
        "access_token": {
          "type": "string"
        },
        "token_type": {
          "type": "string"
        },
        "scope": {
          "type": "string"
        },
        "refresh_token": {
          "type": "string"
        },
        "expires_in": {
          "type": "integer"
        }
      }
    },
    "AccountFull": {
      "description": "The Full Account Object includes all of the properties in the Account Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Account ID. Sometimes referred to as \"Voip ID\" or \"voip_id\"."
        },
        "name": {
          "type": "string",
          "description": "Name on the account. Read-only."
        },
        "username": {
          "type": "string",
          "description": "Account user name"
        },
        "password": {
          "type": "string",
          "description": "Account password. For security reason, this is masked as \"**\""
        },
        "master_account": {
          "description": "If this account is a subaccount, this property shows the master account that it belongs to. Otherwise it is NULL. Read-only. Output is an Account Summary Object.",
          "$ref": "#/definitions/AccountSummary"
        },
        "contact": {
          "$ref": "#/definitions/ContactAccount",
          "description": "Contact Object. See below for details."
        },
        "billing_contact": {
          "$ref": "#/definitions/ContactAccount",
          "description": "Contact Object for billing purposes. See below for details."
        }
      }
    },
    "AccountSummary": {
      "description": "The Account Summary Object is used to briefly represent an account. It can occur in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Account ID. Sometimes referred to as \"Voip ID\" or \"voip_id\"."
        },
        "name": {
          "type": "string",
          "description": "Name on the account. Read-only."
        }
      }
    },
    "PricingFull": {
      "description": "The Full Pricing Object is identical to the Pricing Summary Object. The Pricing Summary Object is used to briefly represent a pricing plan. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID of this object."
        },
        "pricing": {
          "$ref": "#/definitions/PricingObject",
          "description": "Pricing Object"
        },
        "voip_id": {
          "type": "integer",
          "description": "Phone.com API Account (VoIP) ID"
        },
        "reason": {
          "type": "string",
          "description": "Reason this pricing plan is applied"
        },
        "who": {
          "type": "string",
          "description": "Name of the person / process who added this pricing plan to the subaccount"
        },
        "expire_date": {
          "type": "string",
          "description": "Pricing plan expiration timestamp in unix format. If pricing plan never expires, this item will not be returned"
        }
      }
    },
    "PricingObject": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Pricing code / ID"
        },
        "name": {
          "type": "string",
          "description": "Name of pricing plan"
        }
      }
    },
    "ContactAccount": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name. Required."
        },
        "company": {
          "type": "string",
          "description": "Company name"
        },
        "address": {
          "$ref": "#/definitions/Address"
        },
        "phone": {
          "type": "string",
          "description": "Phone number. Required."
        },
        "fax": {
          "type": "string",
          "description": "Fax number"
        },
        "primary_email": {
          "type": "string",
          "description": "Primary email address. Required."
        },
        "alternate_email": {
          "type": "string",
          "description": "Alternate email address"
        }
      }
    },
    "Address": {
      "description": "Contact Address Object. See below for details.",
      "type": "object",
      "required": [
        "line_1",
        "city",
        "country"
      ],
      "properties": {
        "line_1": {
          "type": "string",
          "description": "Street address line 1. Required."
        },
        "line_2": {
          "type": "string",
          "description": "Street address line 2"
        },
        "city": {
          "type": "string",
          "description": "City. Required."
        },
        "province": {
          "type": "string",
          "description": "Province. Required if country is US"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal code"
        },
        "country": {
          "type": "string",
          "description": "2-character country code. Required."
        }
      }
    },
    "ApplicationFull": {
      "description": "The Full Application Object is identical to the Application Summary Object. See above for details.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Application ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Application name"
        }
      }
    },
    "ApplicationSummary": {
      "description": "The Application Summary Object is used to briefly represent an application. It can occur in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Application ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Application name"
        }
      }
    },
    "CallFull": {
      "description": "",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": ""
        }
      }
    },
    "CallLogFull": {
      "description": "The Full Call Log Object includes the properties in the Call Log Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID"
        },
        "uuid": {
          "type": "string",
          "description": "Internal system id, may be null"
        },
        "extension": {
          "$ref": "#/definitions/ExtensionSummary",
          "description": "Account extension"
        },
        "caller_id": {
          "type": "string",
          "description": "Call made from this phone number"
        },
        "called_number": {
          "type": "string",
          "description": "Call made to this phone number"
        },
        "start_time": {
          "type": "string",
          "description": "Call start time"
        },
        "created_at": {
          "type": "string",
          "description": "Call log creation time. Same as call end time + time needed to create call log"
        },
        "direction": {
          "type": "string",
          "description": "Call direction: in or out"
        },
        "type": {
          "type": "string",
          "description": "Call type: call, fax, audiogram ..."
        },
        "call_duration": {
          "type": "integer",
          "description": "Call duration in seconds"
        },
        "is_monitored": {
          "type": "string",
          "description": "Was call being monitored?"
        },
        "call_number": {
          "type": "string",
          "description": "Internal system call reference number"
        },
        "final_action": {
          "type": "string",
          "description": "Last action of call flow"
        },
        "voicemail_url": {
          "type": "string",
          "description": "URL of voicemail if available. User may download the audio via this URL. Empty string if voicemail does not exist"
        },
        "voicemail_cp_url": {
          "type": "string",
          "description": "URL of voicemail if available. User may listen to the audio online via this URL. Empty string if voicemail does not exist"
        },
        "voicemail_transcript": {
          "type": "string",
          "description": "Transcript of voicemail if enabled and available"
        },
        "call_recording_url": {
          "type": "string",
          "description": "URL of call recording if available. User may download the audio via this URL. Empty string if call recording does not exist"
        },
        "call_recording_cp_url": {
          "type": "string",
          "description": "URL of call recording if available. User may listen to the audio online via this URL. Empty string if call recording does not exist"
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CallDetails"
          },
          "description": "A list of call flows from beginning of call to end of call."
        },
        "caller_cnam": {
          "type": "string",
          "description": "Internal system caller id / name"
        }
      }
    },
    "CallDetails": {
      "description": "Each item in the 'details' record may contain the following properties:",
      "type": "object",
      "properties": {
        "start_time": {
          "type": "integer",
          "description": "UNIX time stamp representing the UTC time that this call item starts"
        },
        "type": {
          "type": "string",
          "description": "Endpoint for this call item, such as call, voicemail, fax, menu, menu item, queue ..."
        },
        "id_value": {
          "type": "integer",
          "description": "ID associated with this call item endpoint (type)"
        },
        "voip_id": {
          "type": "integer",
          "description": "Same as account id"
        },
        "voip_phone_id": {
          "type": "integer",
          "description": "Same as account extension id"
        }
      }
    },
    "DeviceFull": {
      "description": "The Full Device Object includes the properties in the Device Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID"
        },
        "name": {
          "type": "string",
          "description": "User-supplied name, otherwise NULL"
        },
        "sip_authentication": {
          "$ref": "#/definitions/SipAuthentication"
        },
        "lines": {
          "type": "array",
          "description": "Array of Line Objects showing which extensions are attached to this device, and their assigned line numbers. See below for details.",
          "items": {
            "$ref": "#/definitions/Line"
          }
        }
      }
    },
    "SipAuthentication": {
      "description": "A SIP Authentication Properties Object. See below for details. Read-only.",
      "type": "object",
      "properties": {
        "host": {
          "type": "string",
          "description": "Hostname"
        },
        "port": {
          "type": "integer",
          "description": "Port number"
        },
        "username": {
          "type": "string",
          "description": "Username. This is the ID of the device."
        },
        "password": {
          "type": "string",
          "description": "Password."
        }
      }
    },
    "Line": {
      "type": "object",
      "properties": {
        "line": {
          "type": "integer",
          "description": "Line number"
        },
        "extension": {
          "$ref": "#/definitions/ExtensionSummary",
          "description": "Extensions object that this line number is mapped to."
        }
      }
    },
    "DeviceSummary": {
      "description": "The Device Summary Object is used to briefly represent a VoIP device. It consists of the ID and name only:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID"
        },
        "name": {
          "type": "string",
          "description": "User-supplied name, otherwise NULL"
        }
      }
    },
    "ListenerFull": {
      "description": "The Listener Object is used to represent a listener. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "voip_id": {
          "type": "integer"
        },
        "type": {
          "type": "string",
          "description": "Type of listener: callback"
        },
        "event_type": {
          "type": "string",
          "description": "Type of event subscribed by the listener: call.new, call.update, call.complete, call.log, sms.in, sms.out"
        },
        "callbacks": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of Callback Object"
        },
        "updated_at": {
          "type": "integer"
        },
        "created_at": {
          "type": "integer"
        }
      }
    },
    "ExpressServiceCodeFull": {
      "description": "The Full Express Service Code Object includes the properties in the Express Service Code Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID"
        },
        "express_service_code": {
          "type": "string",
          "description": "An 8-digit number in string format"
        },
        "expire_date": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "UNIX time stamp representing the UTC time that the Express Service Code expires. Please note that every time this service is executed, the expire_date is set to now + 24 hours."
        }
      }
    },
    "ExtensionFull": {
      "description": "The Full Extension Object has the same properties as the Extension Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID of the extension. This is the internal Phone.com ID, not the extension number callers may dial."
        },
        "name": {
          "type": "string",
          "description": "User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required."
        },
        "extension": {
          "type": "integer",
          "description": "Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required."
        },
        "voip_id": {
          "type": "integer",
          "description": "API Account ID. Optional, object may return the voip_id."
        },
        "full_name": {
          "type": "string",
          "description": "Full name of the individual or department to which this extension is assigned"
        },
        "usage_type": {
          "type": "string",
          "description": "Can be \"limited\" or \"unlimited\". In most cases, changing this will affect your monthly bill. Please see our Control Panel or contact Customer Service for pricing."
        },
        "device_membership": {
          "$ref": "#/definitions/DeviceMembership"
        },
        "timezone": {
          "type": "string",
          "description": "Time zone. Can be in any commonly recognized format, such as \"America/Los_Angeles\"."
        },
        "name_greeting": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting that communicates the extension's name. Output is a Greeting Summary Object. Input must be a Greeting Lookup Object."
        },
        "include_in_directory": {
          "type": "boolean",
          "description": "Whether this extension should be included in the dial-by-name directory for this account. Boolean."
        },
        "caller_id": {
          "type": "string",
          "description": "Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone numbers. You can use our List Caller Ids service to see a current list. To unassign, you may set this to \"private\", NULL, or an empty string."
        },
        "local_area_code": {
          "type": "string",
          "description": "For outbound calls, this is the North American area code that this extension is calling from."
        },
        "enable_call_waiting": {
          "type": "boolean",
          "description": "Whether Call Waiting is enabled. Boolean. Default is TRUE."
        },
        "enable_outbound_calls": {
          "type": "boolean",
          "description": "Whether outgoing calls are enabled. Boolean. Default is TRUE."
        },
        "voicemail": {
          "$ref": "#/definitions/Voicemail"
        },
        "call_notifications": {
          "$ref": "#/definitions/Notification"
        },
        "route": {
          "$ref": "#/definitions/RouteSummary",
          "description": "Route which will handle incoming voice and fax calls. Only valid on PUT requests, not POST. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route. Route must belong to this extension already."
        }
      }
    },
    "DeviceMembership": {
      "description": "Device Membership Object, or NULL. Read-only. See below for details.",
      "type": "object",
      "properties": {
        "line": {
          "type": "integer",
          "description": "Line number to which this extension is assigned. Integer."
        },
        "device": {
          "description": "Device that this extension belongs to. Output is an Device Summary Object.",
          "$ref": "#/definitions/DeviceSummary"
        }
      }
    },
    "Voicemail": {
      "description": "Voicemail Object. See below for details.",
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether voicemail is enabled. Boolean."
        },
        "password": {
          "type": "string",
          "description": "Password for accessing voicemail box. Must be digits only."
        },
        "greeting": {
          "$ref": "#/definitions/Greeting"
        },
        "attachments": {
          "type": "string",
          "description": "If notification emails are being used, this defines the format of the audio attachments. Can be \"wav\" for WAV format, \"mp3\" for MP3 format, or NULL to disable attachments."
        },
        "notifications": {
          "$ref": "#/definitions/Notification",
          "description": "Voicemail Notifications Object. See below for details. Can be set to NULL to disable notifications."
        },
        "transcription": {
          "type": "string",
          "description": "Type of voicemail transcription to use. Can be \"human\" for high-quality manual transcriptions by human operators, \"automated\" for machine-generated transcriptions, or NULL to omit trancriptions. Changing this option will affect your monthly bill. Please see our Control Panel or contact Customer Service for details."
        }
      }
    },
    "VoicemailInput": {
      "description": "Voicemail Object. See below for details.",
      "type": "object",
      "properties": {
        "enabled": {
          "type": "string",
          "description": "Whether voicemail is enabled. Boolean."
        },
        "password": {
          "type": "string",
          "description": "Password for accessing voicemail box. Must be digits only."
        },
        "greeting": {
          "$ref": "#/definitions/GreetingInput"
        },
        "attachments": {
          "type": "string",
          "description": "If notification emails are being used, this defines the format of the audio attachments. Can be \"wav\" for WAV format, \"mp3\" for MP3 format, or NULL to disable attachments."
        },
        "notifications": {
          "$ref": "#/definitions/Notification",
          "description": "Voicemail Notifications Object. See below for details. Can be set to NULL to disable notifications."
        },
        "transcription": {
          "type": "string",
          "description": "Type of voicemail transcription to use. Can be \"human\" for high-quality manual transcriptions by human operators, \"automated\" for machine-generated transcriptions, or NULL to omit trancriptions. Changing this option will affect your monthly bill. Please see our Control Panel or contact Customer Service for details."
        }
      }
    },
    "Greeting": {
      "description": "Voicemail Greeting Object. See below for details. Can be set to NULL to reset greeting options.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The greeting to play. Can be \"name\" for the name_greeting as described above, \"standard\" for the standard greeting, or \"alternate\" for an alternate greeting. See below for details."
        },
        "alternate": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting to be played when type=\"alternate\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object."
        },
        "standard": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting to be played when type=\"standard\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object."
        },
        "enable_leave_message_prompt": {
          "type": "boolean",
          "description": "Whether to prompt the caller with the following words after the voicemail greeting has been played: \"Please leave your message after the tone. When finished, hang up or press the pound key.\" Boolean."
        }
      }
    },
    "GreetingInput": {
      "description": "Voicemail Greeting Object. See below for details. Can be set to NULL to reset greeting options.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The greeting to play. Can be \"name\" for the name_greeting as described above, \"standard\" for the standard greeting, or \"alternate\" for an alternate greeting. See below for details."
        },
        "alternate": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting to be played when type=\"alternate\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object."
        },
        "standard": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting to be played when type=\"standard\". Output is a Greeting Summary Object. Input must be a Greeting Lookup Object."
        },
        "enable_leave_message_prompt": {
          "type": "string",
          "description": "Whether to prompt the caller with the following words after the voicemail greeting has been played: \"Please leave your message after the tone. When finished, hang up or press the pound key.\" Boolean."
        }
      }
    },
    "Notification": {
      "description": "The Call Notifications object configures the recipient(s) of notifications when calls are received to this extension.",
      "type": "object",
      "properties": {
        "emails": {
          "type": "array",
          "description": "Array of email addresses",
          "items": {
            "type": "string"
          }
        },
        "sms": {
          "type": "string",
          "description": "Phone number capable of receiving SMS messages"
        }
      }
    },
    "ExtensionSummary": {
      "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:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID of the extension. This is the internal Phone.com ID, not the extension number callers may dial."
        },
        "name": {
          "type": "string",
          "description": "User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required."
        },
        "extension": {
          "type": "integer",
          "description": "Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required."
        }
      }
    },
    "CallerIdFull": {
      "description": "Here are all of the properties you can expect for Caller ID objects:",
      "type": "object",
      "properties": {
        "number": {
          "type": "string",
          "description": "Phone number, in E.164 format"
        },
        "name": {
          "type": "string",
          "description": "Name you have supplied for this number"
        },
        "type": {
          "type": "string",
          "description": "Type of Caller ID. account means this number is registered to your account, and extra refers to extra numbers which you have authorized, which are not managed under Phone.com."
        }
      }
    },
    "ContactFull": {
      "description": "The Full Contact Object includes all of the properties in the Contact Summary Object, along with several more:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "prefix": {
          "type": "string",
          "description": "Salutation, such as Mr, Mrs, or Dr"
        },
        "first_name": {
          "type": "string",
          "description": "First name or given name"
        },
        "middle_name": {
          "type": "string",
          "description": "Middle or second name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name or surname"
        },
        "suffix": {
          "type": "string",
          "description": "Suffix, such as \"Jr.\", \"Sr.\", \"II\", or \"III\""
        },
        "nickname": {
          "type": "string",
          "description": "Nickname, or a shortened informal version of the contact's name"
        },
        "company": {
          "type": "string",
          "description": "Name of the contact's company"
        },
        "phonetic_first_name": {
          "type": "string",
          "description": "Phonetic first name. Useful for remembering how to pronounce the contact's name."
        },
        "phonetic_middle_name": {
          "type": "string",
          "description": "Phonetic middle name. Useful for remembering how to pronounce the contact's name."
        },
        "phonetic_last_name": {
          "type": "string",
          "description": "Phonetic last name. Useful for remembering how to pronounce the contact's name."
        },
        "department": {
          "type": "string",
          "description": "Name of the contact's department"
        },
        "job_title": {
          "type": "string",
          "description": "Contact's job title"
        },
        "emails": {
          "description": "Array of Contact Email Objects. See below for details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Email"
          }
        },
        "phone_numbers": {
          "description": "Array of Contact Phone Number Objects. See below for details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/PhoneNumberContact"
          }
        },
        "addresses": {
          "description": "Array of Contact Address Objects. See below for details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/AddressListContacts"
          }
        },
        "group": {
          "$ref": "#/definitions/GroupListContacts"
        },
        "created_at": {
          "type": "integer",
          "description": "Integer UNIX timestamp when the contact was created. Read-only."
        },
        "updated_at": {
          "type": "integer",
          "description": "Integer UNIX timestamp when the contact was created. Read-only."
        }
      }
    },
    "Email": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Email type, one of: primary or alternate. Default is primary."
        },
        "email": {
          "type": "string",
          "description": "Email address. Required."
        }
      }
    },
    "AddressListContacts": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Address type, one of: home or business. Default is home."
        },
        "street": {
          "type": "string",
          "description": "House number and street name, including apartment, suite, etc."
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "state": {
          "type": "string",
          "description": "State or province"
        },
        "zip": {
          "type": "string",
          "description": "Zip code or postal code"
        },
        "country": {
          "type": "string",
          "description": "Country name"
        }
      }
    },
    "GroupListContacts": {
      "description": "Contact Group that this contact is filed under. Output is a Group Summary Object. Input is a Group Lookup Object.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        }
      }
    },
    "ContactSummary": {
      "description": "The Contact Summary Object is used to briefly represent a contact from your address book. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "prefix": {
          "type": "string",
          "description": "Salutation, such as Mr, Mrs, or Dr"
        },
        "first_name": {
          "type": "string",
          "description": "First name or given name"
        },
        "middle_name": {
          "type": "string",
          "description": "Middle or second name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name or surname"
        },
        "suffix": {
          "type": "string",
          "description": "Suffix, such as 'Jr.', 'Sr.', 'II', or 'III'"
        },
        "nickname": {
          "type": "string",
          "description": "Nickname, or a shortened informal version of the contact's name"
        },
        "company": {
          "type": "string",
          "description": "Name of the contact's company"
        }
      }
    },
    "GroupFull": {
      "description": "The Full Group Object is identical to the Group Summary Object. See above for details.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        }
      }
    },
    "GroupSummary": {
      "description": "The Group Summary Object is used to briefly represent a contact group. It can occur in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        }
      }
    },
    "MediaFull": {
      "description": "The Full Recording Object and the Summary Recording Object are the same.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Recording ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name of recording"
        },
        "type": {
          "type": "string",
          "description": "Can be hold_music or greeting. Indicates the purpose of this recording and where it can be used.",
          "pattern": "hold_music|greeting"
        }
      }
    },
    "MediaSummary": {
      "description": "The Recording Summary Object is used to briefly represent a media recording. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Recording ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name of recording"
        }
      }
    },
    "MenuFull": {
      "description": "The Full Menu Object contains the same properties as the Menu Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Menu ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name. Required. Unique."
        },
        "allow_extension_dial": {
          "type": "boolean",
          "description": "Boolean. Determines whether a caller can enter an extension number to bypass the menu."
        },
        "keypress_wait_time": {
          "type": "integer",
          "description": "Number of seconds to wait for the caller to choose a menu option. Must be between 1 and 5 seconds."
        },
        "greeting": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting that is played when a caller enters a menu. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE."
        },
        "keypress_error": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Message that is played when the caller makes a keypress error. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE."
        },
        "timeout_handler": {
          "$ref": "#/definitions/RouteSummary",
          "description": "Route that will be entered when the caller fails to choose a menu option within the allotted time. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route."
        },
        "options": {
          "description": "Array of menu option objects. See below for details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Option"
          }
        }
      }
    },
    "MenuSummary": {
      "description": "The Menu Summary Object is used to briefly represent a menu. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Menu ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name. Required. Unique."
        }
      }
    },
    "Option": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "Keypad key. Must equal a single digit or the pound sign (\"#\")."
        },
        "route": {
          "$ref": "#/definitions/RouteSummary",
          "description": "Route which will be entered when the user presses the designated key. Output is a Route Summary Object if the route is named, otherwise the Full Route Object will be shown. Input must be a Route Lookup Object pointing to a named route."
        }
      }
    },
    "OauthClientFull": {
      "description": "An OAuth Client Full Object is identical as a Summary Object.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Client ID"
        },
        "client_name": {
          "type": "string",
          "description": "Name of Client"
        }
      }
    },
    "RedirectUriFull": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Redirect URI ID"
        },
        "uri": {
          "type": "string",
          "description": "The Uniform Resource Identifier is a string used to identify the path to be redirected"
        },
        "type": {
          "type": "string",
          "description": "redirect"
        }
      }
    },
    "OauthClientRedirectUriFull": {
      "description": "An OAuth Client Full Object is identical as a Summary Object.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "OAuth Client Redirect URI ID"
        },
        "client": {
          "$ref": "#/definitions/OauthClientFull",
          "description": "Client details"
        },
        "redirect_uri": {
          "$ref": "#/definitions/RedirectUriFull",
          "description": "Redirect URI details"
        }
      }
    },
    "PaymentSummary": {
      "description": "The Payment Method Summary Object is used to briefly represent a Credit Card. It consists of parameters in the table below:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Payment Method ID"
        },
        "voip_id": {
          "type": "integer",
          "description": "API Account ID"
        },
        "status": {
          "type": "string",
          "description": "'primary' = primary card used for billing; 'onfile' = card on file; 'hidden' = deleted card;"
        },
        "nickname": {
          "type": "string",
          "description": "Name of Card"
        },
        "type": {
          "type": "string",
          "description": "'cc' for credit card"
        },
        "created_at": {
          "type": "integer",
          "description": "Time payment record is created"
        }
      }
    },
    "PaymentFull": {
      "description": "The Payment Method Full Object contains the same properties as the Payment Method Summary Object, along with the following:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Payment Method ID"
        },
        "voip_id": {
          "type": "integer",
          "description": "API Account ID"
        },
        "status": {
          "type": "string",
          "description": "'primary' = primary card used for billing; 'onfile' = card on file; 'hidden' = deleted card;"
        },
        "nickname": {
          "type": "string",
          "description": "Name of Card"
        },
        "type": {
          "type": "string",
          "description": "'cc' for credit card"
        },
        "created_at": {
          "type": "integer",
          "description": "Time payment record is created"
        },
        "contact": {
          "$ref": "#/definitions/ContactResponse",
          "description": "Detail of contact person"
        },
        "decline_count": {
          "type": "integer",
          "description": "Number of times the payment method was declined"
        },
        "next_charge_date": {
          "type": "integer",
          "description": "Next billing date"
        },
        "updated_at": {
          "type": "integer",
          "description": "Last time the payment method was updated"
        },
        "cc_token": {
          "type": "string",
          "description": "Encrypted credit card token to be used for billing"
        },
        "cc_number": {
          "type": "string",
          "description": "Credit card number partially masked with xxxxxxxx"
        },
        "cc_exp": {
          "type": "string",
          "description": "Credit card expiration date"
        }
      }
    },
    "PhoneNumberFull": {
      "description": "The Full Phone Number Object has all of the properties of the Phone Number Summary Object, along with several more, as shown below:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Phone number ID. This is the internal Phone.com ID for this number, not the phone number itself. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number, in E.164 format"
        },
        "block_incoming": {
          "type": "boolean",
          "description": "Whether to block incoming calls. Boolean."
        },
        "block_anonymous": {
          "type": "boolean",
          "description": "Whether to block anonymous calls. Boolean."
        },
        "route": {
          "$ref": "#/definitions/RouteSummary",
          "description": "The Route assigned to handle incoming calls for this number, if any. Output is a Route Summary Object, or NULL if not set. Input can be a Route Lookup Object or NULL to unset."
        },
        "caller_id": {
          "$ref": "#/definitions/CallerIdPhoneNumber"
        },
        "sms_forwarding": {
          "$ref": "#/definitions/SmsForwarding"
        },
        "call_notifications": {
          "$ref": "#/definitions/CallNotifications"
        }
      }
    },
    "CallerIdPhoneNumber": {
      "description": "Here are all of the properties you can expect for Caller ID objects:",
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name that this number will be associated with. Must be no longer than 15 characters, and can only contain English letters, numbers, spaces, and commas."
        },
        "type": {
          "type": "string",
          "description": "Can be \"business\" or \"personal\"",
          "pattern": "business|personal"
        }
      }
    },
    "SmsForwarding": {
      "description": "SMS Forwarding Object, or NULL",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Can be \"extension\" or \"application\"",
          "pattern": "extension|application"
        },
        "extension": {
          "$ref": "#/definitions/ExtensionSummary",
          "description": "Required if type = \"extension\". Extension that messages should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object."
        },
        "application": {
          "$ref": "#/definitions/ApplicationSummary",
          "description": "Required if type = \"application\". Application that messages should be directed to. Output is an Application Summary Object. Input must be an Application Lookup Object."
        }
      }
    },
    "CallNotifications": {
      "description": "Call Notifications Object or NULL",
      "type": "object",
      "properties": {
        "emails": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of email addresses"
        },
        "sms": {
          "type": "string",
          "description": "A phone number capable of receiving SMS messages"
        }
      }
    },
    "QueueFull": {
      "description": "The Full QueueObject has the same properties as the Queue Summary Object, along with the following:",
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name. Required."
        },
        "greeting": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting to be played when caller first connects. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE. Can be set to NULL to disable the greeting."
        },
        "hold_music": {
          "$ref": "#/definitions/HoldMusic"
        },
        "max_hold_time": {
          "type": "integer",
          "description": "Maximum hold time in seconds. If provided, must equal one of: 60, 120, 180, 240, 300, 600, 900, 1200, 1800, 2700, 3600. Default is 300."
        },
        "caller_id_type": {
          "type": "string",
          "description": "Caller id type to show members. If provided, must equal one of: 'called_number', 'calling_number'. Default is 'calling_number'."
        },
        "ring_time": {
          "type": "integer",
          "description": "Number of seconds to ring a member before cycling to the next member. If provided, must equal one of: 5, 10, 15, 20, 25, 30. Default is 5."
        },
        "members": {
          "description": "Array of Member Objects. Non-virtual account extensions or phone numbers. See below for details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Member"
          }
        }
      }
    },
    "QueueSummary": {
      "description": "The Queue Summary Object is used to briefly represent a calling queue. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name. Required."
        }
      }
    },
    "HoldMusic": {
      "description": "Hold Music to be played while callers are waiting. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to TRUE. Default is to play a standard ring tone.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Recording ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name of recording"
        }
      }
    },
    "Member": {
      "type": "object",
      "properties": {
        "extension": {
          "$ref": "#/definitions/ExtensionSummary",
          "description": "Extension that this member refers to. Output is an Extension Summary Object. Input must be an Extension Lookup Object."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number"
        }
      }
    },
    "RouteFull": {
      "description": "The root level of the Full Route Object includes all of the properties in the Route Summary Object, along with two more:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "extension": {
          "$ref": "#/definitions/ExtensionSummary",
          "description": "Extension to which this route belongs. Output is an Extension Summary Object. Input must be an Extension Lookup Object. Optional. Cannot be changed after a route is created."
        },
        "rules": {
          "type": "array",
          "description": "Array of Rule Set Objects. Required. See below for details. When processing incoming calls, the first matching rule set will be used, and all others will be ignored.",
          "items": {
            "$ref": "#/definitions/RuleSet"
          }
        }
      }
    },
    "RuleSet": {
      "type": "object",
      "properties": {
        "filter": {
          "$ref": "#/definitions/RuleSetFilter"
        },
        "actions": {
          "description": "Array of Action Objects. Required. Routes have rule sets, and rule sets have one or more actions. The supported actions are described below:",
          "type": "array",
          "items": {
            "$ref": "#/definitions/RuleSetAction"
          }
        }
      }
    },
    "RuleSetFilter": {
      "description": "Filter Object. Optional. See below for details.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Required.",
          "pattern": "schedule|contact|contact_group"
        },
        "schedule": {
          "$ref": "#/definitions/ScheduleSummary",
          "description": "Schedule that this filter refers to. Output is a Schedule Summary Object. Input must be a Schedule Lookup Object. Required."
        },
        "contact": {
          "$ref": "#/definitions/ContactSummary",
          "description": "Address Book Contact that this filter refers to. Output is a Contact Summary Object. Input must be a Contact Lookup Object. Required."
        },
        "group": {
          "$ref": "#/definitions/GroupSummary",
          "description": "Address Book Group that this filter refers to. Output is a Contact Group Summary Object. Input must be a Contact Group Lookup Object. Required."
        }
      }
    },
    "RuleSetAction": {
      "description": "Filter Object. Optional. See below for details.",
      "type": "object",
      "properties": {
        "action": {
          "type": "string",
          "description": "Required.",
          "pattern": "directory|disconnect|fax|forward|greeting|hold|menu|queue|trunk|voicemail"
        },
        "extension": {
          "description": "Extension that this action refers to. Output is an Extension Summary Object. Input must be an Extension Lookup Object. Required.",
          "$ref": "#/definitions/ExtensionSummary"
        },
        "items": {
          "type": "array",
          "description": "This action is for forwarding calls to any number of extensions or phone numbers. The forwarding is handled in parallel, meaning that all phone numbers and/or extensions will ring simultaneously. When the call is answered by any single phone number or extension, ringing will stop for all of them. Subsequent actions in this rule set will be performed if the call is not answered before the timeout period is reached, or if it is forwarded to an extension that has its own route and that route does not result in any actions that disconnect the call or take over call handling.",
          "items": {
            "$ref": "#/definitions/RuleSetForwardItem"
          }
        },
        "timeout": {
          "type": "integer",
          "description": "Seconds that our routing engine should wait until moving on. Optional. Must be an integer between 5 and 90. Default is 5 seconds.",
          "default": 5
        },
        "hold_music": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Hold Music to be played while callers are waiting. Output is a Media Summary Object. Input must be a Media Lookup Object. Optional. Must refer to a media recording that has is_hold_music set to TRUE. Default is to play a standard ring tone."
        },
        "greeting": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting that this action refers to. Output is a Media Summary Object. Input must be a Media Lookup Object. Required. Must refer to a media recording that has is_hold_music set to FALSE."
        },
        "duration": {
          "type": "integer",
          "description": "Required. Seconds that the caller should be placed on hold before being moved onto the next action. Must be an integer between 1 and 60 seconds."
        },
        "menu": {
          "$ref": "#/definitions/MenuSummary",
          "description": "Menu that this action refers to. Required. Output is a Menu Summary Object. Input must be a Menu Lookup Object."
        },
        "queue": {
          "$ref": "#/definitions/QueueSummary",
          "description": "Queue that this action refers to. Required. Output is a Queue Summary Object. Input must be a Queue Lookup Object."
        },
        "trunk": {
          "$ref": "#/definitions/TrunkSummary",
          "description": "Trunk that this action refers to. Required. Output is a Trunk Summary Object. Input must be a Trunk Lookup Object."
        }
      }
    },
    "RuleSetForwardItem": {
      "description": "Array of Forward Item Objects. See below for details. Required.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Required. Must equal phone_number or extension.",
          "pattern": "phone_number|extension"
        },
        "extension": {
          "description": "Required if type = \"extension\". Extension that callers should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object.",
          "$ref": "#/definitions/ExtensionSummary"
        },
        "number": {
          "type": "string",
          "description": "Required if type = \"phone_number\". Phone number that callers should be directed to. Must be a string in E.164 format."
        },
        "screening": {
          "type": "boolean",
          "description": "Boolean. Optional. Default is FALSE. Use this to activate call screening. If TRUE, the timeout on the parent action should be at least 30 seconds.",
          "default": false
        },
        "caller_id": {
          "type": "string",
          "description": "Optional. Must equal calling_number or called_number. Defines which phone number should be used for Caller ID. Default is calling_number.",
          "pattern": "calling_number|called_number",
          "default": "calling_number"
        },
        "voice_tag": {
          "type": "string",
          "description": "Optional string. If screening = TRUE, this value will be passed into our Text-To-Speech engine and used to inform the caller of who they have reached."
        },
        "distinctive_ring": {
          "type": "string",
          "description": "Optional. Must equal one of: DEFAULT, STYLE_2, STYLE_3, STYLE_4, STYLE_5, STYLE_6, STYLE_7, STYLE_8, or STYLE_9. Identifies the style of ring tone you will hear when an incoming call is waiting.",
          "pattern": "DEFAULT|STYLE_2|STYLE_3|STYLE_4|STYLE_5|STYLE_6|STYLE_7|STYLE_8|STYLE_9"
        }
      }
    },
    "RouteSummary": {
      "description": "The Route Summary Object is used to briefly represent a route. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        }
      }
    },
    "ScheduleFull": {
      "description": "The Full Schedule Object is identical to the Schedule Summary Object. See above for details.",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Schedule ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        }
      }
    },
    "ScheduleSummary": {
      "description": "The Schedule Summary Object is used to briefly represent a schedule. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Schedule ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name"
        }
      }
    },
    "SmsFull": {
      "description": "The Full SMS Object includes all of the properties in the SMS Summary Object.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique SMS ID. Read-only."
        },
        "from": {
          "type": "string",
          "description": "Caller ID number to display on the incoming/outgoing SMS message. For an outgoing message, it must be a phone number associated with your Phone.com account."
        },
        "to": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Recipient"
          },
          "description": "An array of SMS recipients."
        },
        "direction": {
          "type": "string",
          "description": "Direction of SMS. 'in' for Incoming messages, 'out' for Outgoing messages."
        },
        "created_epoch": {
          "type": "integer",
          "description": "Unix time stamp representing the UTC time that the object was created in the Phone.com API system."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "Date string representing the UTC time that the object was created in the Phone.com API system."
        },
        "text": {
          "type": "string",
          "description": "Body of the SMS text"
        },
        "is_new": {
          "type": "boolean",
          "description": "True when SMS is new; False when SMS has been read."
        }
      }
    },
    "Recipient": {
      "type": "object",
      "properties": {
        "number": {
          "type": "string",
          "description": "Phone number that will receive the SMS message"
        },
        "status": {
          "type": "string",
          "description": "Indicate the status of your SMS object. May be 'sent', 'received', 'queued', 'new' ..."
        }
      }
    },
    "ContactResponse": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Contact name"
        },
        "address": {
          "$ref": "#/definitions/Address"
        },
        "primary_email": {
          "type": "string",
          "description": "Primary email address. Required."
        },
        "alternate_email": {
          "type": "string",
          "description": "Alternate email address"
        },
        "company": {
          "type": "string",
          "description": "Company name"
        },
        "phone": {
          "type": "string",
          "description": "Phone number. Required."
        },
        "fax": {
          "type": "string",
          "description": "Fax number"
        }
      }
    },
    "TrunkFull": {
      "description": "The Full Trunk Object is identical to the Trunk Summary Object, along with the following:",
      "type": "object",
      "required": [
        "id",
        "name",
        "uri",
        "codecs",
        "max_concurrent_calls",
        "max_minutes_per_month",
        "greeting",
        "error_message"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Trunk ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name. Required."
        },
        "uri": {
          "type": "string",
          "description": "Fully-qualified SIP URI. Required."
        },
        "max_concurrent_calls": {
          "type": "integer",
          "description": "Max concurrent calls. Default is 10."
        },
        "max_minutes_per_month": {
          "type": "integer",
          "description": "Max minutes per month. Default is 750."
        },
        "greeting": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Greeting. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE."
        },
        "error_message": {
          "$ref": "#/definitions/MediaSummary",
          "description": "Error Message. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE."
        },
        "codecs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Custom audio codec configuration, if any is needed. If provided, must be a simple array containing the prioritized list of desired codecs. Supported codecs are: g711u 64k, g711u 56k, g711a 64k, g711a 56k, g7231, g728, g729, g729A, g729B, g729AB, gms full, rfc2833, t38, ilbc, h263, g722, g722_1, g729D, g729E, amr, amr_wb, efr, evrc, h264, mpeg4, red, cng, SIP Info to 2833"
        }
      }
    },
    "TrunkSummary": {
      "description": "The Trunk Summary Object is used to briefly represent a trunk. It can be seen in several places throughout this API. Here are the properties:",
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Integer Trunk ID. Read-only."
        },
        "name": {
          "type": "string",
          "description": "Name. Required."
        }
      }
    },
    "VoicemailFull": {
      "description": "The Full Voicemail Object includes all of the properties in the Voicemail Summary Object.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique Voicemail ID. Read-only."
        },
        "download_url": {
          "type": "string",
          "description": "Name. Required."
        },
        "extension": {
          "$ref": "#/definitions/ExtensionSummary",
          "description": "Extension where the voicemail is saved into."
        },
        "from": {
          "$ref": "#/definitions/FromObject",
          "description": "The caller's information"
        },
        "to": {
          "type": "string",
          "description": "The phone number where the caller is calling"
        },
        "is_new": {
          "type": "boolean",
          "description": "True when Voicemail is new; False when Voicemail has been listened"
        },
        "created_at": {
          "type": "integer",
          "description": "Date string representing the UTC time that the object was created in the Phone.com API system."
        },
        "folder": {
          "type": "string",
          "description": "Folder name where voicemail is saved"
        },
        "duration": {
          "type": "integer",
          "description": "Length of voicemail in seconds"
        }
      }
    },
    "FromObject": {
      "description": "Each entry in a Voicemail's from list is an object with the following properties:",
      "type": "object",
      "properties": {
        "number": {
          "type": "string",
          "description": "The caller phone number"
        },
        "name": {
          "type": "string",
          "description": "The name / caller ID of the caller"
        },
        "city": {
          "type": "string",
          "description": "The city where the caller is from"
        },
        "state": {
          "type": "string",
          "description": "The state where the caller is from"
        }
      }
    },
    "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."
        }
      }
    },
    "PhoneNumbersRegionFull": {
      "description": "The Region Object may include any of several fields describing the group, as well as the quantity of phone numbers available in that group. Here are the properties:",
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "description": "Optional. Integer representing the international calling code for the phone number's country."
        },
        "npa": {
          "type": "integer",
          "description": "Optional. Area Code, for North American phone numbers."
        },
        "nxx": {
          "type": "integer",
          "description": "Optional. Second set of 3 digits, for North American phone numbers."
        },
        "is_toll_free": {
          "type": "integer",
          "description": "Optional. Boolean describing whether the phone numbers in this group are toll free."
        },
        "city": {
          "type": "string",
          "description": "Optional. City name."
        },
        "province_postal_code": {
          "type": "string",
          "description": "Optional. Two-letter postal code for the state or province."
        },
        "country_postal_code": {
          "type": "string",
          "description": "Optional. Two-letter postal code for the country."
        },
        "quantity": {
          "type": "integer",
          "description": "Integer. Quantity of phone numbers currently available in the given region."
        }
      }
    },
    "DeleteEntry": {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean"
        }
      }
    },
    "SortListAvailableNumbers": {
      "type": "object",
      "properties": {
        "internal": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        }
      }
    },
    "SortListPhoneNumbersRegions": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string"
        },
        "npa": {
          "type": "string"
        },
        "nxx": {
          "type": "string"
        },
        "is_toll_free": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "province_postal_code": {
          "type": "string"
        },
        "country_postal_code": {
          "type": "string"
        }
      }
    },
    "SortIdCreatedAt": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        }
      }
    },
    "SortIdUpdatedAt": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      }
    },
    "SortCallLogs": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "start_time": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        }
      }
    },
    "SortIdNamePhoneNumber": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        }
      }
    },
    "SortNameNumber": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "number": {
          "type": "string"
        }
      }
    },
    "SortIdExtensionName": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "extension": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "SortIdName": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "SortId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "FilterListAvailableNumbers": {
      "type": "object",
      "properties": {
        "phone_number": {
          "type": "string"
        },
        "country_code": {
          "type": "string"
        },
        "npa": {
          "type": "string"
        },
        "nxx": {
          "type": "string"
        },
        "xxxx": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "province": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "category": {
          "type": "string"
        }
      }
    },
    "FilterListPhoneNumbersRegions": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string"
        },
        "npa": {
          "type": "string"
        },
        "nxx": {
          "type": "string"
        },
        "is_toll_free": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "province_postal_code": {
          "type": "string"
        },
        "country_postal_code": {
          "type": "string"
        }
      }
    },
    "FilterIdDirectionFrom": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "direction": {
          "type": "string"
        },
        "from": {
          "type": "string"
        }
      }
    },
    "FilterIdGroupIdUpdatedAtArray": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "group_id": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      }
    },
    "FilterCallLogs": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "start_time": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "direction": {
          "type": "string"
        },
        "called_number": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "FilterIdNamePhoneNumberArray": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        }
      }
    },
    "FilterNameNumberArray": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "number": {
          "type": "string"
        }
      }
    },
    "FilterIdExtensionNameArray": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "extension": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "FilterIdNameArray": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "FilterIdArray": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "FilterVoicemailArray": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        },
        "is_new": {
          "type": "string"
        },
        "created_at": {
          "type": "integer"
        },
        "extension": {
          "type": "string"
        }
      }
    }
  }
}