📜Service Provider Trunking Capacity

my_api.scripter.service_provider_trunking_capacity()

Returns a JSON breakdown of the Trunking Call Capacity of a Service Provider/ Enterprise (SP/ENT). This will show the totals at each level from SP/ ENT to Group to Trunk Groups located in Groups. At each level Max Active Calls and Bursting Max Active calls are detailed and then differences at calculated.

This does not return data on Enterprise Trunks.

The script makes use of the following methods:

api.get.service_provider_trunk_group_call_capacity()
api.get.groups()
api.get.group_trunk_groups_call_capacity()
api.get.group_trunk_groups()
api.get.group_trunk_group()

Parameters

• service_provider_id (str): Target Service Provider ID/ Enterprise ID that you would like the Trunk Call Capacity breakdown.

Return

• JSON: JSON data of Trunking Call Capacity details of SP/ ENT, Groups, and Trunk Groups.

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.scripter.service_provider_trunking_capacity("ServiceProviderID")

Example Returned Data of SIP Passwords (Formatted)

{
  "serviceProviderId": "ServiceProviderID",
  "maxActiveCalls": 226,
  "burstingMaxActiveCalls": 18,
  "groupsCallCapacityTotal": 114,
  "groupsBurstingCallCapacityTotal": 36,
  "groups": [
    {
      "groupId": "GroupIDA",
      "groupName": "Group A",
      "maxActiveCalls": 13,
      "burstingMaxAvailableActiveCalls": 5,
      "burstingMaxActiveCalls": 2,
      "trunkGroups": [
        {
          "name": "Trunk 1",
          "maxActiveCalls": 1,
          "burstingMaxActiveCalls": 0
        },
        {
          "name": "Trunk 2",
          "maxActiveCalls": 1,
          "burstingMaxActiveCalls": 0
        },
        {
          "name": "Trunk 3",
          "maxActiveCalls": 2,
          "burstingMaxActiveCalls": 0
        }
      ],
      "trunkGroupsCallCapacityTotal": 4,
      "trunkGroupsBurstingCallCapacityTotal": 0,
      "callCapacityDifference": 9,
      "burstingCallCapacityDifference": 0
    },
    {
      "groupId": "GroupIDB",
      "groupName": "Group B",
      "maxActiveCalls": 36,
      "burstingMaxAvailableActiveCalls": 5,
      "burstingMaxActiveCalls": 2,
      "trunkGroups": [
        {
          "name": "Trunk 1",
          "maxActiveCalls": 1,
          "burstingMaxActiveCalls": 0
        },
        {
          "name": "Trunk 2",
          "maxActiveCalls": 1,
          "burstingMaxActiveCalls": 0
        },
        {
          "name": "Trunk 3",
          "maxActiveCalls": 9,
          "burstingMaxActiveCalls": 0
        }
      ],
      "trunkGroupsCallCapacityTotal": 11,
      "trunkGroupsBurstingCallCapacityTotal": 0,
      "callCapacityDifference": 25,
      "burstingCallCapacityDifference": 0
    }
  "callCapacityDifference": 112,
  "burstingCallCapacityDifference": -18