🤝GET - Group Information

my_api.get.group()

Returns the specificied Group's settings and information

Parameters

• service_provider_id (str): Target Service Provider ID

• group_id (str): Target Group ID

Returns

• Dict: Returns information about the specified group, such as the DID, userCount and Domain.

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.group{
     "serviceProviderId",
     "groupId"
}

Example Data Returned (Formatted)

{
  "defaultDomain": "domain.com",
  "userLimit": 25,
  "userCount": 8,
  "groupName": "grp.test",
  "callingLineIdName": "test solutions",
  "callingLineIdPhoneNumber": "[phone]",
  "callingLineIdDisplayPhoneNumber": 2345678900,
  "timeZone": "America/New_York",
  "timeZoneDisplayName": "(GMT-05:00) (US) Eastern Time",
  "locationDialingCode": 234,
  "contact": {
    "contactName": "test name",
    "contactNumber": "513-123-1234",
    "contactEmail": "[e-mail]"
  },
  "serviceProviderId": "ent.test",
  "groupId": "grp.test"
}