PlaceCallerIdGet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlaceCallerIdGet",
  "title": "PlaceCallerIdGet",
  "type": "object",
  "required": [
    "types",
    "selected",
    "directNumber",
    "locationNumber",
    "tollFreeLocationNumber",
    "displayName",
    "displayDetail",
    "blockInForwardCallsEnabled",
    "externalCallerIdNamePolicy",
    "locationExternalCallerIdName"
  ],
  "properties": {
    "types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CLIDPolicySelection"
      },
      "description": "Allowed types for the `selected` field. This field is read-only and cannot be modified."
    },
    "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 shows the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID shows the main number for the location.\n * `CUSTOM` - Outgoing caller ID shows the value from the customNumber field.\n"
    },
    "directNumber": {
      "type": "string",
      "example": "+12815550003",
      "description": "Direct number which is shown if `DIRECT_LINE` is selected."
    },
    "locationNumber": {
      "type": "string",
      "example": "+12815550002",
      "description": "Location number which is shown if `LOCATION_NUMBER` is selected"
    },
    "tollFreeLocationNumber": {
      "type": "boolean",
      "description": "Flag to indicate if the location number is toll-free number."
    },
    "customNumber": {
      "type": "string",
      "example": "+12815550003",
      "description": "Custom number which is shown if CUSTOM is selected. This value must be a number from the workspace's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the workspace's location."
    },
    "displayName": {
      "type": "string",
      "example": "Clockmaker's shop 7.1",
      "description": "Workspace's caller ID display name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "displayDetail": {
      "type": "string",
      "example": ".",
      "description": "Workspace's caller ID display details. Default is `.`. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "blockInForwardCallsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Block this workspace'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 shows the caller's direct line name.\n * `LOCATION` - Outgoing caller ID shows the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID shows the value from the `customExternalCallerIdName` field.\n"
    },
    "customExternalCallerIdName": {
      "type": "string",
      "example": "Custom external caller name",
      "description": "Custom external caller ID name which is shown if external caller ID name policy is `OTHER`."
    },
    "locationExternalCallerIdName": {
      "type": "string",
      "example": "Anna",
      "description": "Location's external caller ID name which is shown if external caller ID name policy is `LOCATION`."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObject",
      "description": "Settings for the direct line caller ID name to be shown for this workspace."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "The name to be used for dial by name functions."
    }
  }
}