Call Forwarding Selective

Display user’s call forwarding selective

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

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

Example request:

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

Example response:

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

{
     "active": false,
     "playRingReminder": true,
     "defaultForwardToPhoneNumber": "test@sip.netaxis.be",
     "criteria": [
          {
               "name": "test",
               "active": true,
               "callsFrom": "All calls",
               "forwardToNumberSelection": "Forward To Default Number",
               "forwardTo": "test@sip.netaxis.be",
               "fromDnCriteria": {
                    "includeAnonymousCallers": false,
                    "selection": "Any",
                    "phoneNumbers": [],
                    "includeUnavailableCallers": false
               }
          }
     ]
}
Response JSON Object:

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

  • playRingReminder (boolean) – if set, the service plays a ring reminder when it forwards a call.

  • defaultForwardToPhoneNumber (string) – the default forwarding number or SIP-URI address.

  • criteria (array) – a list of criteria objects as defined as Criteria in List attributes with the additional attributes defined in Criteria attributes for Call Forwarding Selective.

Status Codes:

Update a user’s call forwarding selective

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

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

Example request:

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

{
     "active": true,
     "defaultForwardToPhoneNumber": "+3225126777",
     "playRingReminder": false,
     "criteria": [
          {
               "name": "test1",
               "active": true
          },
          {
               "name": "test2",
               "delete": true
          },
          {
               "name": "test3",
               "forwardToNumberSelection": "Forward To Specified Number",
               "forwardToPhoneNumber": "test@sip.netaxis.be"
          }
     ]
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:

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

  • defaultForwardToPhoneNumber (string) – the default forwarding number or SIP-URI address.

  • playRingReminder (boolean) – the service plays a ring reminder when it forwards a call.

  • criteria (array) – a list of criteria objects as defined as Criteria attributes.

Status Codes:

Display user’s call forwarding selective criteria

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

Retrieve the settings of the specified Call Forwarding Selective’s criterion.

Example request:

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

Example response:

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

{
     "name": "test",
     "active": true,
     "timeSchedule": {
          "level": "User",
          "name": "Every Friday",
     },
     "holidaySchedule": {
          "level": "User",
          "name": "Every Easter",
     },
     "forwardToNumberSelection": "Forward To Specified Number",
     "forwardToPhoneNumber": "test@sip.netaxis.be",
     "fromDnCriteria": {
          "selection": "Any",
          "includeAnonymousCallers": false,
          "includeUnavailableCallers": true,
          "phoneNumbers": [
               "+3225126777"
          ]
     }
}
Response JSON Object:
Status Codes:

Create a user’s call forwarding selective criteria

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/call_forwarding_selective/criteria/

Create a new criterion for the Call Forwarding Selective.

Example request:

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

{
     "name": "test",
     "active": true,
     "timeSchedule": {
          "level": "User",
          "name": "Every Friday",
     },
     "holidaySchedule": {
          "level": "User",
          "name": "Every Easter",
     },
     "forwardToNumberSelection": "Forward To Specified Number",
     "forwardToPhoneNumber": "test@sip.netaxis.be",
     "fromDnCriteria": {
          "selection": "Any",
          "includeAnonymousCallers": false,
          "includeUnavailableCallers": true,
          "phoneNumbers": [
               "+3225126777"
          ]
     }
}
Request JSON Object:

Example response:

HTTP/1.1 201 OK
Response JSON Object:

or (when SELECT_CF_AUTO_CONFIGURE configuration setting and returnGlobalSettings request parameter are true):

Response JSON Object:

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

  • playRingReminder (boolean) – if set, the service plays a ring reminder when it forwards a call.

  • defaultForwardToPhoneNumber (string) – the default forwarding number or SIP-URI address.

  • criteria (array) – a list of criteria objects as defined as Criteria attributes.

Status Codes:

Configuration Information for Call Forwarding Selective Criterium Assignment

The APIO behaviour is controlled by the following settings:

"SELECT_CF_AUTO_CONFIGURE": false

With following parameters:

  • SELECT_CF_AUTO_CONFIGURE: If true, APIO will automatically activate call forwarding on default forwarding number (or on the one provided along with the criterium if no default call forwarding forward number set) when the first criterium is added. Default value is False.

Update a user’s call forwarding selective criteria

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

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

Example request:

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

{
     "name": "test",
     "newName": "test_new",
     "active": true,
     "timeSchedule": {
          "level": "User",
          "name": "Every Friday",
     },
     "holidaySchedule": {
          "level": "User",
          "name": "Every Easter",
     },
     "fromDnCriteria": {
          "selection": "Any"
          "includeAnonymousCallers": false,
          "includeUnavailableCallers": true,
          "phoneNumbers": [
               "+3225126777"
          ]
     }
}
Request JSON Object:

Example response:

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

Delete a user’s call forwarding selective criteria

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

Delete the settings of the Call Forwarding Selective service of the user.

Example request:

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

{
     "name": "test"
}

Example response:

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