{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/NumberObject",
"title": "NumberObject",
"type": "object",
"required": [
"state",
"phoneNumberType",
"mainNumber",
"includedTelephonyTypes",
"tollFreeNumber",
"isServiceNumber"
],
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12056350001",
"description": "A unique identifier for the phone number."
},
"extension": {
"type": "string",
"example": "000",
"description": "Extension for a phone number."
},
"routingPrefix": {
"type": "string",
"example": "1234",
"description": "Routing prefix of location."
},
"esn": {
"type": "string",
"example": "1234000",
"description": "Routing prefix + extension of a person or workspace."
},
"state": {
"type": "string",
"example": "ACTIVE",
"description": "Phone number's state."
},
"phoneNumberType": {
"type": "string",
"enum": [
"PRIMARY",
"ALTERNATE",
"FAX",
"DNIS",
"Default"
],
"description": "Returns the filtered list of phone numbers of the given `phoneNumberType`. Response excludes any extensions without numbers. Possible input values:\n * `PRIMARY` - Filter the results to include only primary phone numbers.\n * `ALTERNATE` - Filter the results to include only alternate phone numbers.\n * `FAX` - Filter the results to include only FAX phone numbers.\n * `DNIS` - Filter the results to include only Dialed Number Identification Service (DNIS) phone numbers.\n * `Default` - Filter the results to include all numbers.\n"
},
"mainNumber": {
"type": "boolean",
"example": true,
"description": "If `true`, the phone number is used as location CLID."
},
"includedTelephonyTypes": {
"$ref": "#/components/schemas/TelephonyType",
"description": "The telephony type for the number."
},
"mobileNetwork": {
"type": "string",
"example": "mobileNetwork",
"description": "Mobile Network for the number if the number is MOBILE_NUMBER."
},
"routingProfile": {
"type": "string",
"example": "AttRtPf",
"description": "Routing Profile for the number if the number is MOBILE_NUMBER."
},
"tollFreeNumber": {
"type": "boolean",
"example": true,
"description": "If `true`, the phone number is a toll-free number."
},
"isServiceNumber": {
"type": "boolean",
"example": true,
"description": "If `true`, the phone number is a service number; otherwise, it is a standard number."
},
"location": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"description": "ID of location in which phone number exists."
},
"name": {
"type": "string",
"example": "Banglore",
"description": "Name of the location for phone number."
}
}
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "ID of the owner to which phone number is assigned."
},
"type": {
"$ref": "#/components/schemas/NumberOwnerType",
"description": "Type of the phone number's owner."
},
"firstName": {
"type": "string",
"example": "Mark",
"description": "First name of the phone number's owner."
},
"lastName": {
"type": "string",
"example": "Zand",
"description": "Last name of the phone number's owner."
}
}
}
}
}