Specialty Line

Create a specialty line

Use to create a new specialty line on an account

post/v2/partition/{partitionId}/account/{accountId}/specialty-line

Request

Path parameters

accountIdstring required

ID of account, refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">partition.id</a>

Request body

callerIdstring required

The phone number displayed on the phone of the person being called.

callingPlanIdsstring[] required

Calling plans allow you to control where your customers are allowed to call and what, if any, the cost should be for those calls. Each of your plans can be set up with a number of included minutes or a per-minute rate, depending on how you want to charge for services. The calling plans created at the partition level can be assigned to individual accounts and users based on their needs or the bundle they purchased.

deviceTypestring

The generic device type that matches the customer's device configuration.

e911CallbackNumberstring required

The phone number that will be transmitted to 911.

macAddressstring

The device's MAC address.

namestring required

A name for the specialty line, such as Elevator C or another descriptive term.

portNumberinteger

The physical port number the line is provisioned on (1–9).

sipPasswordstring

A unique plain-text password is automatically generated and displayed here. Use this one or enter your own, using at least 6 characters.

sipUsernamestring

A unique 14-character SIP username is automatically generated and displayed here. Use this one or enter your own, between 8-36 characters long.

Response

Line created successfully

accountIdstring required
callerIdstring

The phone number displayed on the phone of the person being called.

callingPlanIdsstring[] required

Calling plans allow you to control where your customers are allowed to call and what, if any, the cost should be for those calls. Each of your plans can be set up with a number of included minutes or a per-minute rate, depending on how you want to charge for services. The calling plans created at the partition level can be assigned to individual accounts and users based on their needs or the bundle they purchased.

deviceIdstring
deviceTypestring

The generic device type that matches the customer's device configuration.

e911CallbackNumberstring

The phone number that will be transmitted to 911.

idstring required

The ID is immutable and cannot be changed.

linkedPhoneNumbersstring[]
macAddressstring

The device's MAC address.

namestring required

A name for the specialty line, such as Elevator C or another descriptive term.

partitionIdstring required
portNumberinteger

The physical port number the line is provisioned on (1–9).

sipPasswordstring

A unique plain-text password is automatically generated and displayed here. Use this one or enter your own, using at least 6 characters.

sipUsernamestring

A unique 14-character SIP username is automatically generated and displayed here. Use this one or enter your own, between 8-36 characters long.

Changes

No recorded changes to this operation across all 1 revision of this API.