Webex · Schema

PostVirtualLineObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
firstName string First name defined for a virtual line. Minimum length is 1. Maximum length is 30.
lastName string Last name defined for a virtual line. Minimum length is 1. Maximum length is 30.
displayName string Display name defined for a virtual line.
phoneNumber string Phone number of a virtual line. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory.
extension string Extension of a virtual line. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory.
locationId string ID of location for virtual line.
callerIdLastName string Last name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 30.
callerIdFirstName string First name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 30.
callerIdNumber string Phone number to appear as the CLID for all calls. Minimum length is 1. Maximum length is 23.
View JSON Schema on GitHub

JSON Schema

webex-postvirtuallineobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostVirtualLineObject",
  "title": "PostVirtualLineObject",
  "type": "object",
  "required": [
    "firstName",
    "lastName",
    "locationId"
  ],
  "properties": {
    "firstName": {
      "type": "string",
      "example": "Bob",
      "description": "First name defined for a virtual line. Minimum length is 1. Maximum length is 30."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name defined for a virtual line. Minimum length is 1. Maximum length is 30."
    },
    "displayName": {
      "type": "string",
      "example": "Bob Smith",
      "description": "Display name defined for a virtual line."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Phone number of a virtual line. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory."
    },
    "extension": {
      "type": "string",
      "example": "5309",
      "description": "Extension of a virtual line. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory."
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI",
      "description": "ID of location for virtual line."
    },
    "callerIdLastName": {
      "type": "string",
      "example": "Bob",
      "description": "Last name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 30."
    },
    "callerIdFirstName": {
      "type": "string",
      "example": "Smith",
      "description": "First name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 30."
    },
    "callerIdNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Phone number to appear as the CLID for all calls. Minimum length is 1. Maximum length is 23."
    }
  }
}