User Automatic Hold/Retrieve

The Automatic Hold and Retrieve (AHR) service provides an alternate method to hold and retrieve calls without using feature access codes or flash hook.

Only one call can be held on an account with the Automatic Hold and Retrieve feature active.

Retrieve user’s Automatic Hold/Retrieve

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

Retrieve the settings of the Automatic Hold/Retrieve service of the user.

Authorization rights: minimum EndUser.

Example request:

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

Example response:

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

{
     "active": false,
     "recallTimer": 100
}
Response JSON Object:

  • active (boolean) – the status of the service.

  • recallTimer (integer) – automatically retrieve the call after specified seconds.

Status Codes:

Update user’s Automatic Hold/Retrieve

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

Update the settings of the Automatic Hold/Retrieve service of the user.

Authorization rights: minimum EndUser.

Example request:

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

{
     "active": true,
     "recallTimer": 100
}
Request JSON Object:

  • active (boolean) – the status of the service.

  • recallTimer (integer) – automatically retrieve the call after specified seconds.

Example response:

HTTP/1.1 200 OK
Status Codes: