[Index]

Model: device/skypeforbusinesshybrid/CsVoiceRoute

Model Details

Title Description Details
InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.
  • Field Name: InMemory
  • Type: Boolean
NumberPattern A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. Default: [0-9]{10}
  • Field Name: NumberPattern
  • Type: String
PstnUsages A list of PSTN usages (such as Local, Long Distance, etc.) that can be applied to this voice route. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the Get-CsPstnUsage cmdlet.) By default this list is empty. However, if you leave this parameter blank when creating a new voice route, you'll receive a warning message.
  • Field Name: PstnUsages.[n]
  • Type: Array
Name * The unique name of the voice route. If this parameter is set, the value will be automatically applied to the voice route Identity. You cannot specify both an Identity and a Name.
  • Field Name: Name
  • Type: String
PstnGatewayList In Skype for Business Server 2015 a Mediation Server can be associated with multiple gateways. This parameter contains a list of gateways associated with this voice route. Each member of this list must be the service Identity of the PSTN gateway or Mediation Server. The value can refer to a Mediation Server only if the Mediation Server is configured for Microsoft Office Communications Server 2007 or Microsoft Office Communications Server 2007 R2. For Skype for Business Server 2015, a PSTN gateway must be used. The service Identity is a string in the format <ServiceRole>:<FQDN>, where ServiceRole is the name of the service role (PSTNGateway), and FQDN is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, PSTNGateway:redmondpool.litwareinc.com. Service identities can be retrieved by calling the command Get-CsService | Select-Object Identity. By default this list is empty. However, if you leave this parameter blank when creating a new voice route, you'll receive a warning message.
  • Field Name: PstnGatewayList
  • Type: String
SuppressCallerId Determines whether a caller's ID will be revealed on outbound calls. If this parameter is set to True, caller ID will be suppressed. In place of the actual ID, the value of the AlternateCallerId will be displayed. When SuppressCallerId is set to True, a value for AlternateCallerId must be supplied.
  • Field Name: SuppressCallerId
  • Type: Boolean
Priority A number could resolve to multiple voice routes. The priority determines the order in which the routes will be applied if more than one route is possible.
  • Field Name: Priority
  • Type: Integer
AlternateCallerId If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. This value must match the regular expression (\+)?[1-9]\d*(;ext=[1-9]\d*)?. In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits; and may be followed by an extension that begins with ;ext= followed by any number of digits. (Note that if you include an extension the string must be placed within double quotes.)
  • Field Name: AlternateCallerId
  • Type: String
Element
  • Field Name: Element
  • Type: String
Identity * A name that uniquely identifies the voice route. Voice routes can be defined only at the global scope, so the identity is simply the name you want to give the route. (You can have spaces in the route name, for instance Test Route, but you must enclose the full string in double quotes in the call to the New-CsVoiceRoute cmdlet.) If Identity is specified, the Name must be left blank. The value of the Identity will be assigned to the Name.
  • Field Name: Identity
  • Type: String
Description A description of what this voice route is for.
  • Field Name: Description
  • Type: String
API reference for device/skypeforbusinesshybrid/CsVoiceRoute