Text Phone Device Parameters

The following table lists the web service parameters for text phone 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

number

The text phone's number.

Note: For deployments using the AlarmPointWebService WSDL, this parameter should include the Device's country code.

no

String; maximum length of 30 characters, must be positive integers, and cannot start with 0.

countryCode

The country code to use for this Device; if not specified, the Device will use the country code of the User's Site.

Note: This parameter is only available on deployments NOT using the AlarmPointWebService WSDL.

yes A valid two-letter 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:textPhoneDevice>
  <sch:name>SMS Phone</sch:name>
  <sch:active>true</sch:active>
  <sch:default>true</sch:default>
  <sch:number>3383937</sch:number>
  <sch:countryCode />
  <sch:userServiceProvider>
    <sch:name>Phone Provider</sch:name>
  </sch:userServiceProvider>
  <sch:delay>0</sch:delay>
  <sch:priorityThreshold>HIGH</sch:priorityThreshold>
  <sch:externallyOwned>true</sch:externallyOwned>
</sch:textPhoneDevice>

Web Service Device Specification

AddDevice

UpdateDevice