Voice Device Parameters

The following table lists the web service parameters for voice Devices:

Name

Description

Optional

Valid Values

name

Device name

no

Any valid unused Device name

active

Indicates whether the Device should be active

no

true or false

default

Indicates whether the Device should be set as the default Device for the User

no

true or false

areaCode

The area code for the voice Device

yes

String; maximum length of 10 characters matching the following:

[0-9]+

number

The phone number of the voice Device

no

String; maximum length of 30 characters matching the following:

[0-9]{1}[0-9()., -]+

extension

The phone extension for the voice Device

yes

maximum length of 10 characters matching the following:

[0-9]{1}[0-9()., -]

countryCodeOverride

The country code override, if required

yes

A valid country code

userServiceProvider

ID of the User Service Provider to associate with this Device

no

SoapUserServiceProvider

delay

Delay to use for this Device (in minutes)

no

Integer

priorityThreshold

Priority threshold to set for this Device

no

A valid priority threshold setting; the default available values are LOW, MEDIUM, and HIGH.

externallyOwned

Indicates whether an external data source owns this Device

no

true or false

Example

<sch:voiceDevice>
  <sch:name>Mobile Phone</sch:name>
  <sch:active>true</sch:active>
  <sch:default>true</sch:default>
  <sch:areaCode>482</sch:areaCode>
  <sch:number>2928282</sch:number>
  <sch:extension>302</sch:extension>
  <sch:countryCodeOverride>2004</sch:countryCodeOverride>
  <sch:userServiceProvider>
    <sch:name>Voice Provider</sch:name>
  </sch:userServiceProvider>
  <sch:delay>0</sch:delay>
  <sch:priorityThreshold>LOW</sch:priorityThreshold>
  <sch:externallyOwned>true</sch:externallyOwned>
</sch:voiceDevice>

Web Service Device Specification

AddDevice

UpdateDevice