Webex · Schema

PutVoicePortalObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Voice Portal Name.
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.
passcode	object	Voice Portal Admin Passcode.
directLineCallerIdName	object	Settings for the direct line caller ID name to be shown for this voice portal.
dialByName	string	Sets or clears the name to be used for dial by name functions. To clear the `dialByName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutVoicePortalObject",
  "title": "PutVoicePortalObject",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "test voicePortal",
      "description": "Voice Portal Name."
    },
    "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."
    },
    "passcode": {
      "type": "object",
      "properties": {
        "newPasscode": {
          "type": "string",
          "example": "testPass123",
          "description": "New passcode."
        },
        "confirmPasscode": {
          "type": "string",
          "example": "testPass123",
          "description": "Confirm new passcode."
        }
      },
      "description": "Voice Portal Admin Passcode."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObjectForPut",
      "description": "Settings for the direct line caller ID name to be shown for this voice portal."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "Sets or clears the name to be used for dial by name functions. To clear the `dialByName`, the attribute must be set to null or empty string. Characters of `%`,  `+`, `\\`, `\"` and Unicode characters are not allowed."
    }
  }
}