Purchase a new number

This action will purchase a specific number for the given unit.

Try this request in your browser

/api/ /numbers/acquire

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

token String
destination_type String
destination_id Integer
name String
unit_id Integer

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/numbers/acquire

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

token Required

The token of the number you wish to acquire

String null

destination_type

The type of destination

String null

destination_id

The ID of the destintion

Integer null

name

A name for the newly acquired number

String null

unit_id

The ID of the unit

Integer null

Errors

Error Attributes

UnitNotFound

The given unit was not found

  • id

    The provided ID

NumberNotFound

No number found with the given token

  • token

    The provided token

InsufficientCredit

You do not have sufficient credit to acquire this number

CouldNotAcquire

The number requested could not be acquired

Response Data

This action will return a number structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.