Account26

Account Device13

Account Device Line13

Account Prevalidate3

Account User7

Address3

Asynchronous JOB Tracker5

Authorize5

Brand Settings4

Bulk Operation Collection3

Bulk Operation Job3

Business Line35

Business Line Hunt Group13

Call Group6

Call Parking Spot6

Calling Plan4

Calling Plan Product9

CDRs3

Cymbus User Product7

Device1

Device (Deprecated)10

Device Inventory Management5

Document Repository2

Dynamic Inventory2

Edge Node11

Emergency Notification5

End User16

Inbound Rate Plan Product2

IVR5

Language Reference1

Local Calling Areas2

M2M Authentication1

Management User12

Media9

Paging Group6

Partition7

Pickup Group6

Port8

Rate Center Inventory8

Reference Resources11

Report33

Security Groups6

Service Activation1

Single Sign On - SSO2

SIP Trunk12

Sip Trunk Caller ID Mapping8

SIP Trunk Group7

Specialty Line6

SSO Authentication4

SSO Configuration16

SSO Exemptions10

Supported Rate Centers1

Telephone Number37

User Groups4

Virtual Fax2

Virtual Fax Line6

Voicemail Box14

Voicemail Message7

Account Device

Device (by mac) Metadata

Use to update device (mac) metadata. This endpoint is used primarily to add <a href="#/~operation/Reference%20Resources/getSideCarTypes">SideCars</a> to your device. MacAddress, partitionId, accountId, deviceTypeId, and id are all immutable fields. Changing the provisionerType is currently not supported. Updating the adminPassword will only have an effect if the partition's Device Configuration setting (DevCon) does not supply an adminPassword. The DevCon settings can only be altered by an Alianza Admin.

put/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/metadata

Request

Base URL
https://api.alianza.com
Auth
API key in header X-AUTH-TOKEN
TypeScript
https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/account/:accountId/device/:macAddress/metadata/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

ID of account

macAddressstring required

partitionIdstring required

ID of partition

Request body

macAddressstring

The 48-bit hexadecimal address assigned to the device by the manufacturer.

partitionIdstring

ID of partition, reference to <a href="#/~schema/Account">account.partitionId</a>

accountIdstring

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

deviceTypeIdstring

The deviceTypeId identifies the equipment and the features that the device supports. Refers to <a href="#/~schema/DeviceTypeX">deviceType.id</a>. See also: <a href="#/~operation/Reference%20Resources/getDeviceTypes">Get All DeviceType</a> and <a href="#/~operation/Reference%20Resources/getDeviceTypeById">GetDeviceType</a>

sideCarTypeIdstring

The sideCarTypeId identifies the equipment and the features of the side car device. Refers to <a href="#/~schema/SideCarTypeX">sideCarType.id</a>. See also: <a href="#/~operation/Reference%20Resources/getSideCarTypes">Get All SideCar types</a> and <a href="#/~operation/Reference%20Resources/getSideCarTypeById">Get SideCarType</a>

numSideCarsinteger

The number of side cars assigned to this device.

adminPasswordstring

If an admin password is supplied here, it will be applied to the device if a partition level setting is not present. The partition level setting can only be modified by an Alianza Admin. The partition level setting (Devcon - short for device configuration) is almost always supplied, making most uses of this field irrelevant. The adminPassword set by Devcon is NOT reported in this field.

provisionerType'ALIANZA' | 'PHONISM'

Indicates what entity is responsible for provisioning the device. ALIANZA - Alianza is responsible for provisioning the device. PHONISM - Phonism, a third party service, is responsible for provisioning the device.

idstring

This field always refers to the macAddress.

Response

Successful operation