Webex · Schema
GetVoicePortalObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Voice Portal ID |
| name | string | Voice Portal Name. |
| language | string | Language for audio announcements. |
| languageCode | string | Language code for voicemail group audio announcement. |
| extension | string | Extension of incoming call. |
| phoneNumber | string | Phone Number of incoming call. |
| firstName | string | Caller ID First Name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. |
| lastName | string | Caller ID Last Name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. |
| directLineCallerIdName | object | Settings for the direct line caller ID name to be shown for this voice portal. |
| dialByName | string | The name to be used for dial by name functions. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetVoicePortalObject",
"title": "GetVoicePortalObject",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1ZPSUNFTUFJTF9HUk9VUC8yZmQzZGMwMy0yZWRhLTQ4NmUtODdhYS0xODY1ZDI5YWExZWI",
"description": "Voice Portal ID"
},
"name": {
"type": "string",
"example": "test voicePortal",
"description": "Voice Portal Name."
},
"language": {
"type": "string",
"example": "English",
"description": "Language for audio announcements."
},
"languageCode": {
"type": "string",
"example": "en_us",
"description": "Language code for voicemail group audio announcement."
},
"extension": {
"type": "string",
"example": "0007",
"description": "Extension of incoming call."
},
"phoneNumber": {
"type": "string",
"example": "+1345325235",
"description": "Phone Number of incoming call."
},
"firstName": {
"type": "string",
"example": "firstName",
"description": "Caller ID First Name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
},
"lastName": {
"type": "string",
"example": "lastName",
"description": "Caller ID Last Name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
},
"directLineCallerIdName": {
"$ref": "#/components/schemas/DirectLineCallerIdNameObject",
"description": "Settings for the direct line caller ID name to be shown for this voice portal."
},
"dialByName": {
"type": "string",
"example": "Hakim Smith",
"description": "The name to be used for dial by name functions."
}
}
}