🚗GET - User Call Forwarding Selective Criterias

my_api.get.user_call_forwarding_selective_criterias()

Retrieves the Forwarding Selective status for a specified User, alongside the criteria's assigned.

Parameters

  • user_id (str): Target User ID

Returns

  • Dict: Forwarding enabled status and the Forwarding criteria's names and settings.

How To Use:

from odins_spear import api

my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
my_api.authenticate()

my_api.get.user_call_forwarding_selective_criterias{
    "userId"
}

Example Data Returned (Formatted)

[
  {
    "isActive": true,
    "criteriaName": "selective1",
    "timeSchedule": "Every Day All Day",
    "blacklisted": false,
    "holidaySchedule": "None",
    "forwardTo": 5131234321,
    "callsToType": null,
    "callsToNumber": null,
    "callsToExtension": null,
    "callsFrom": [
      "All calls"
    ]
  },
  {
    "isActive": false,
    "criteriaName": "selective2",
    "timeSchedule": "test",
    "blacklisted": false,
    "holidaySchedule": "None",
    "forwardTo": 5131234321,
    "callsToType": null,
    "callsToNumber": null,
    "callsToExtension": null,
    "callsFrom": [
      "Any private number",
      "Any unavailable number"
    ]
  }
]

Last updated