Numbers

Display Number Activation configuration at system level

GET /api/v1/system/services/number_activation/

Retrieve the state of the system Number Activation feature.

Authorization rights: minimum End User.

Example request:

GET /api/v1/system/services/number_activation/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "numberActivationMode": "Off"
}

Response JSON Object:

• numberActivationMode (string) – the state of the Activation Number feature. Value comes from list: [“Off”, “User Activation Enabled”, “Group And User Activation Enabled”]

Status Codes:

• 200 OK – no error

Update Number Activation configuration at system level

PUT /api/v1/system/services/number_activation/

Update the state of the system Number Activation feature.

Authorization rights: minimum System Admin.

Example request:

PUT /api/v1/system/services/number_activation/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "numberActivationMode": "Group And User Activation Enabled"
}

Request JSON Object:

• numberActivationMode (string) – the state of the Activation Number feature. Value comes from list: [“Off”, “User Activation Enabled”, “Group And User Activation Enabled”]

Example response:

HTTP/1.1 200 OK

Status Codes:

• 200 OK – no error

• 400 Bad Request –

  unable to update number activation status, with possible sub-error codes:

  • 18: INVALID_OPERATION, “Number activation cannot be disabled until all phone numbers assigned to users have been activated.”