GET - User Call Forwarding Selective

Retrieves the Forwarding Selective status for a specified User, alongside the criteria

Parameters

  • user_id (str): Target User ID

Returns

  • Dict: Forwarding enabled status and the Forwarding criteria

How To Use:

my_api.call_forwarding_selective.get_user_call_forwarding_selective{
    "userId"
}

Example Data Returned (Formatted)

{
  "isActive": true,
  "defaultForwardToPhoneNumber": 5131234321,
  "playRingReminder": true,
  "userId": "4001@domain.com",
  "criteria": [
    {
      "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

Was this helpful?