Hunt Group

General

Create instance

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hunt_groups/

The API is mapped to GroupHuntGroupAddInstanceRequest and GroupHuntGroupModifyActiveInstanceListRequest (to manage the ‘active’ field)

Additional restrictions

Request JSON Object:

• serviceUserId (object) – See serviceUserId from Hunt Group Instance.

• serviceInstanceProfile (object) – See serviceInstanceProfile from Hunt Group Instance.

• policy (string) – See policy from Hunt Group Instance.

• huntAfterNoAnswer (boolean) – See huntAfterNoAnswer from Hunt Group Instance.

• noAnswerNumberOfRings (integer) – See noAnswerNumberOfRings from Hunt Group Instance.

• forwardAfterTimeout (boolean) – See forwardAfterTimeout from Hunt Group Instance.

• forwardTimeoutSeconds (integer) – See forwardTimeoutSeconds from Hunt Group Instance.

• forwardToPhoneNumber (boolean) – See forwardToPhoneNumber from Hunt Group Instance.

• agents (array) – See agents from Hunt Group Instance.

• allowCallWaitingForAgents (boolean) – See allowCallWaitingForAgents from Hunt Group Instance.

• useSystemHuntGroupCLIDSetting (boolean) – See useSystemHuntGroupCLIDSetting from Hunt Group Instance.

• includeHuntGroupNameInCLID (boolean) – See includeHuntGroupNameInCLID from Hunt Group Instance.

• enableNotReachableForwarding (boolean) – See enableNotReachableForwarding from Hunt Group Instance.

• notReachableForwardToPhoneNumber (string) – See notReachableForwardToPhoneNumber from Hunt Group Instance.

• makeBusyWhenNotReachable (boolean) – See makeBusyWhenNotReachable from Hunt Group Instance.

• allowMembersToControlGroupBusy (boolean) – See allowMembersToControlGroupBusy from Hunt Group Instance.

• enableGroupBusy (boolean) – See enableGroupBusy from Hunt Group Instance.

• applyGroupBusyWhenTerminatingToAgent (boolean) – See applyGroupBusyWhenTerminatingToAgent from Hunt Group Instance.

• networkClassOfService (string) – See networkClassOfService from Hunt Group Instance.

• active (boolean) – See active from Hunt Group Instance.

Retrieve list instances

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hunt_groups/

The API is mapped to GroupHuntGroupGetInstanceListRequest

Additional informations

Response JSON Object:

• hunt_groups (array) – The list of hunt groups. See Hunt Group List Item.

Retrieve instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hunt_groups/(string: hunt_group_name)/

The API is mapped to GroupHuntGroupGetInstanceRequest and GroupHuntGroupModifyActiveInstanceListRequest (to manage the ‘active’ field)

Additional informations

Response JSON Object:

• serviceInstanceProfile (object) – See serviceInstanceProfile from Hunt Group Instance.

• policy (string) – See policy from Hunt Group Instance.

• huntAfterNoAnswer (boolean) – See huntAfterNoAnswer from Hunt Group Instance.

• noAnswerNumberOfRings (integer) – See noAnswerNumberOfRings from Hunt Group Instance.

• forwardAfterTimeout (boolean) – See forwardAfterTimeout from Hunt Group Instance.

• forwardTimeoutSeconds (integer) – See forwardTimeoutSeconds from Hunt Group Instance.

• forwardToPhoneNumber (boolean) – See forwardToPhoneNumber from Hunt Group Instance.

• agents (array) – See agents from Hunt Group Instance.

• allowCallWaitingForAgents (boolean) – See allowCallWaitingForAgents from Hunt Group Instance.

• useSystemHuntGroupCLIDSetting (boolean) – See useSystemHuntGroupCLIDSetting from Hunt Group Instance.

• includeHuntGroupNameInCLID (boolean) – See includeHuntGroupNameInCLID from Hunt Group Instance.

• enableNotReachableForwarding (boolean) – See enableNotReachableForwarding from Hunt Group Instance.

• notReachableForwardToPhoneNumber (string) – See notReachableForwardToPhoneNumber from Hunt Group Instance.

• makeBusyWhenNotReachable (boolean) – See makeBusyWhenNotReachable from Hunt Group Instance.

• allowMembersToControlGroupBusy (boolean) – See allowMembersToControlGroupBusy from Hunt Group Instance.

• enableGroupBusy (boolean) – See enableGroupBusy from Hunt Group Instance.

• applyGroupBusyWhenTerminatingToAgent (boolean) – See applyGroupBusyWhenTerminatingToAgent from Hunt Group Instance.

• networkClassOfService (string) – See networkClassOfService from Hunt Group Instance.

• active (boolean) – See active from Hunt Group Instance.

Update instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hunt_groups/(string: hunt_group_name)/

The API is mapped to GroupHuntGroupModifyInstanceRequest and GroupHuntGroupModifyActiveInstanceListRequest (to manage the ‘active’ field)

Additional restrictions

Request JSON Object:

• serviceInstanceProfile (object) – See serviceInstanceProfile from Hunt Group Instance.

• policy (string) – See policy from Hunt Group Instance.

• huntAfterNoAnswer (boolean) – See huntAfterNoAnswer from Hunt Group Instance.

• noAnswerNumberOfRings (integer) – See noAnswerNumberOfRings from Hunt Group Instance.

• forwardAfterTimeout (boolean) – See forwardAfterTimeout from Hunt Group Instance.

• forwardTimeoutSeconds (integer) – See forwardTimeoutSeconds from Hunt Group Instance.

• forwardToPhoneNumber (boolean) – See forwardToPhoneNumber from Hunt Group Instance.

• agents (array) – See agents from Hunt Group Instance.

• allowCallWaitingForAgents (boolean) – See allowCallWaitingForAgents from Hunt Group Instance.

• useSystemHuntGroupCLIDSetting (boolean) – See useSystemHuntGroupCLIDSetting from Hunt Group Instance.

• includeHuntGroupNameInCLID (boolean) – See includeHuntGroupNameInCLID from Hunt Group Instance.

• enableNotReachableForwarding (boolean) – See enableNotReachableForwarding from Hunt Group Instance.

• notReachableForwardToPhoneNumber (string) – See notReachableForwardToPhoneNumber from Hunt Group Instance.

• makeBusyWhenNotReachable (boolean) – See makeBusyWhenNotReachable from Hunt Group Instance.

• allowMembersToControlGroupBusy (boolean) – See allowMembersToControlGroupBusy from Hunt Group Instance.

• enableGroupBusy (boolean) – See enableGroupBusy from Hunt Group Instance.

• applyGroupBusyWhenTerminatingToAgent (boolean) – See applyGroupBusyWhenTerminatingToAgent from Hunt Group Instance.

• networkClassOfService (string) – See networkClassOfService from Hunt Group Instance.

• active (boolean) – See active from Hunt Group Instance.

Delete instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hunt_groups/(string: hunt_group_name)/

The API is mapped to GroupHuntGroupDeleteInstanceRequest

Available Agent List

Retrieve list instances

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hunt_groups/users/available/

The API is mapped to GroupHuntGroupGetAvailableUserListRequest