Call Forwarding Services

Display user’s call forwarding always

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

Retrieve the settings of the Call Forwarding Always service of the user.

Example request:

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

Example response:

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

{
   "active": true,
   "destination": "*55"
   "ringSplashActive": true
}
Response JSON Object:
Status Codes:

Update a user’s call forwarding always

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

Update the settings of the Call Forwarding Always service of the user.

Example request:

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

{
   "active": true,
   "destination": "*55"
   "ringSplashActive": true
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:
Status Codes:

Display user’s call forwarding busy

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

Retrieve the settings of the Call Forwarding Busy service of the user.

Example request:

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

Example response:

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

{
   "active": true,
   "destination": "*55"
}
Response JSON Object:
Status Codes:

Update a user’s call forwarding busy

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

Update the settings of the Call Forwarding Busy service of the user.

Example request:

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

{
   "active": true,
   "destination": "*55"
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:
Status Codes:

Display user’s call forwarding no answer

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

Retrieve the settings of the Call Forwarding No Answer service of the user.

Example request:

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

Example response:

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

{
   "active": true,
   "destination": "*55"
   "numberOfRings": 3
}
Response JSON Object:
Status Codes:

Update a user’s call forwarding no answer

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

Update the settings of the Call Forwarding No Answer service of the user.

Example request:

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

{
   "active": true,
   "destination": "*55"
   "numberOfRings": 5
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:
Status Codes:

Display user’s call forwarding not reachable

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

Retrieve the settings of the Call Forwarding Not Reachable service of the user.

Example request:

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

Example response:

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

{
   "active": true,
   "destination": "*55"
}
Response JSON Object:
Status Codes:

Update a user’s call forwarding not reachable

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

Update the settings of the Call Forwarding Not Reachable service of the user.

Example request:

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

{
   "active": true,
   "destination": "*55"
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:
Status Codes: