Alternate Numbers Services¶

Display user’s Alternate Numbers¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_numbers/¶

Retrieve the settings of the Alternate Numbers service of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_numbers/ HTTP/1.1
Host: example.com

Example response:

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

{
     "distinctiveRing": true,
     "alternateNumbers": [
          {
               "id": "3",
               "phoneNumber": "+3225126778",
               "extension": "7778",
               "ringPattern": "Short-Long-Short"
          }
     ]
}

Response JSON Object:

distinctiveRing (boolean) – determines if the ring should be differnet when the calls are to alternate phone numbers.
alternateNumbers (array) – a list of alternate numbers as defined as Alternate Numbers attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update a user’s Alternate Numbers¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_numbers/¶

Update the settings of the Alternate Numbers service of the user.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_numbers/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "distinctiveRing": true,
     "alternateNumbers": [
          {
               "id": "7",
               "phoneNumber": "+3225126777",
               "extension": "7777",
               "ringPattern": "Long-Long"
          },
          {
               "id": "3",
               "delete": true
          }
     ]
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

distinctiveRing (boolean) – determines if the ring should be different when the calls are to alternate phone numbers.
alternateNumbers (array) – a list of alternate numbers as defined as Alternate Numbers attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Display user’s single Alternate Number¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_numbers/(string: instance_name)/¶

Retrieve the settings of a single Alternate Number of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_numbers/3/ HTTP/1.1
Host: example.com

Example response:

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

{
   "id": "3",
   "phoneNumber": "+3225126778",
   "extension": "7778",
   "ringPattern": "Short-Long-Short"
}

Response JSON Object:

id (string) – the ID as defined as Alternate Numbers attributes.
phoneNuber (string) – the phoneNumber as defined as Alternate Numbers attributes.
extension (string) – the extension as defined as Alternate Numbers attributes.
ringPattern (string) – the ringPattern as defined as Alternate Numbers attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Create user’s single Alternate Number¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_numbers/¶

Create a new Alternate Number for the user. Will find the first free ID, if no more space will throw an exception.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_numbers/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "phoneNumber": "+3225126780",
   "extension": "7123",
   "ringPattern": "Short-Long-Short"
}

Example response:

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

{
   "id": "3",
   "phoneNumber": "+3225126780",
   "extension": "7123",
   "ringPattern": "Short-Long-Short"
}

Request JSON Object:

phoneNuber (string) – the phoneNumber as defined as Alternate Numbers attributes.
extension (string) – the extension as defined as Alternate Numbers attributes.
ringPattern (string) – the ringPattern as defined as Alternate Numbers attributes.

Response:

Similar to GET list method response. Should be the instance!

Status Codes:

200 OK – no error
400 Bad Request – no more room for new alternate numbers
404 Not Found – the service is not assigned to the user

Update a user’s single Alternate Number¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_numbers/(string: instance_name)/¶

Update the settings of a single Alternate Number of the user.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_numbers/3/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "phoneNumber": "+3225126777",
   "extension": "7777",
   "ringPattern": "Long-Long"
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

phoneNuber (string) – the phoneNumber as defined as Alternate Numbers attributes.
extension (string) – the extension as defined as Alternate Numbers attributes.
ringPattern (string) – the ringPattern as defined as Alternate Numbers attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Disassign a user’s single Alternate Number¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_numbers/(string: instance_name)/¶

Disassign the settings of a single Alternate Number of the user.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_numbers/3/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the deletion

Alternate Numbers attributes¶

Name	Type	Methods		Description
Name	Type	GET	PUT	Description
id	String	A	R	The ID of the entry
phoneNumber	String	A	R	The user’s phone number (if configured, empty or absent otherwise) (see Phone Number)
extension	String	A	O	The user extension. (see Extension)
ringPattern	String	A	O	The ring pattern for each phone number
delete	Boolean	F	O	If set it will delete the entry