Table of Contents

API : Customer Set PBX cluster

Introduction

This request moves a customer's hosted PBX to another PBX cluster.

The request will:

The customer must have the PBX feature enabled and have at least one voice account assigned to a PBX cluster.

Remark: The cluster number is not validated against existing PBX clusters - only the range 1-9 is enforced.

Request

URL https://api.telecomx.dk/customer/CUSTOMER_ID/pbxcluster
Method POST
Access level ADMIN
Param CUSTOMER_ID Id of the customer (24 hex-char string)
Body cluster Number. Id of the PBX cluster to move the customer to (1-9).

Query example

https://api.telecomx.dk/customer/1234567890ABCDEF12345678/pbxcluster

Request body example

{
  "cluster": 2
}

Response

Json object
success Boolean True when the customer was moved.
trunkUpdated Number Number of SIP trunk accounts moved to the new cluster.
mvnoUpdated Number Number of MVNO accounts moved to the new cluster.
sipPhonesUpdated Number Number of PBX SIP phones moved to the new cluster.

Example

{
  "success": true,
  "trunkUpdated": 1,
  "mvnoUpdated": 4,
  "sipPhonesUpdated": 12
}

Errors

Error code Message Description
400 customer Customer does not have PBX feature
400 customer Customer does not have any PBX accounts
403 access_denied Insufficient access level
404 customer Customer not found
422 id Invalid customer id
422 cluster Invalid cluster number, must be an integer between 1 and 9
500 internal_error <Unspecified>