Get number details

This action will return a specific number configured in the given unit.

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

id Integer

Structures

Include extended attributes?	Yes - include extended attributes
Include expansions?	destination

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter	Type	Default
id Required The ID of the number	Integer	null

Parameter

Type

Default

id Required

The ID of the number

Integer

null

Errors

Error	Attributes
NumberNotFound No number was found given the ID provided	id The provided ID
NoAccessToNumber Your authenticated identity is not permitted to access this number

Error

Attributes

NumberNotFound

No number was found given the ID provided

id

The provided ID

NoAccessToNumber

Your authenticated identity is not permitted to access this number

Response Data

This action will return a number structure.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive all expansions for the structure. You remove any/all of them by providing an array of new expansion names in the _expansions parameter on the request.