Properties
| Name | Type | Description |
|---|---|---|
| number | string | Phone numbers that need to be validated. |
| state | object | The state of the number. |
| tollFreeNumber | boolean | If `true`, it's a toll-free number. |
| detail | array | Error details if the number is unavailable. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Number",
"title": "Number",
"type": "object",
"required": [
"number",
"state",
"tollFreeNumber"
],
"properties": {
"number": {
"type": "string",
"example": "+2145557901",
"description": "Phone numbers that need to be validated."
},
"state": {
"$ref": "#/components/schemas/NumberState",
"description": "The state of the number."
},
"tollFreeNumber": {
"type": "boolean",
"description": "If `true`, it's a toll-free number."
},
"detail": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if the number is unavailable."
}
}
}