{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CallerIdPut",
"title": "CallerIdPut",
"type": "object",
"required": [
"selected"
],
"properties": {
"selected": {
"type": "string",
"enum": [
"DIRECT_LINE",
"LOCATION_NUMBER",
"CUSTOM"
],
"description": "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n"
},
"customNumber": {
"type": "string",
"example": "2025551212",
"description": "Custom number which will be shown if CUSTOM is selected. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location."
},
"firstName": {
"type": "string",
"example": "Hakim",
"description": "Virtual line's Caller ID first name. The characters `%`, `+`, ``, `\"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByFirstName` instead."
},
"lastName": {
"type": "string",
"example": "Gonzales",
"description": "Virtual line's Caller ID last name. The characters `%`, `+`, ``, `\"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByLastName` instead."
},
"blockInForwardCallsEnabled": {
"type": "boolean",
"example": true,
"description": "Block this virtual line's identity when receiving a call."
},
"externalCallerIdNamePolicy": {
"type": "string",
"enum": [
"DIRECT_LINE",
"LOCATION",
"OTHER"
],
"description": "Designates which type of External Caller ID Name policy is used. Default is DIRECT_LINE.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line name.\n * `LOCATION` - Outgoing caller ID will show the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID will show the value from the `customExternalCallerIdName` field.\n"
},
"customExternalCallerIdName": {
"type": "string",
"example": "Hakim Custom",
"description": "Custom external caller ID name which will be shown if external caller ID name policy is `OTHER`."
},
"additionalExternalCallerIdDirectLineEnabled": {
"type": "boolean",
"example": true,
"description": "Set the virtual line's direct line number as additional external caller ID."
},
"additionalExternalCallerIdLocationNumberEnabled": {
"type": "boolean",
"description": "Set the Location main number as additional external caller ID for the virtual line."
},
"additionalExternalCallerIdCustomNumber": {
"type": "string",
"example": "2025552000",
"description": "To set a custom number as additional external caller ID for the virtual line. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location."
},
"directLineCallerIdName": {
"$ref": "#/components/schemas/UserDirectLineCallerIdNameObject",
"description": "Settings for the direct line caller ID name to be shown for this virtual line."
},
"dialByFirstName": {
"type": "string",
"example": "Hakim",
"description": "Sets or clears the first name to be used for dial-by-name functions. To clear the `dialByFirstName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\\`, `\"` and Unicode characters are not allowed."
},
"dialByLastName": {
"type": "string",
"example": "Smith",
"description": "Sets or clears the last name to be used for dial-by-name functions. To clear the `dialByLastName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\\`, `\"` and Unicode characters are not allowed."
}
}
}