Skip to content

Latest commit

 

History

History
698 lines (464 loc) · 20.7 KB

RealTimeMonitoringVoiceApi.md

File metadata and controls

698 lines (464 loc) · 20.7 KB

openapi_client.RealTimeMonitoringVoiceApi

All URIs are relative to /dataservice

Method HTTP request Description
get_controller_t1e1_info_current15_min_stats GET /device/voicet1e1controllerinfo/current15minstats
get_controller_t1e1_info_total_stats GET /device/voicet1e1controllerinfo/totalstats
get_dsp_active GET /device/voice/dspActive
get_dsp_farm_profiles GET /device/voice/profiles
get_phone_info GET /device/voice/phoneInfo
get_sccp_ccm_groups GET /device/voice/sccpCcmGroups
get_sccp_connections GET /device/voice/sccpConnections
get_t1e1_isdn_status GET /device/voiceisdninfo/isdnstatus
get_voice_calls GET /device/voice/voiceCalls
get_voip_calls GET /device/voice/voipCalls

get_controller_t1e1_info_current15_min_stats

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_controller_t1e1_info_current15_min_stats(device_id)

Retrieve T1E1 controller last 15 min stats from device (Real Time)

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_controller_t1e1_info_current15_min_stats(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_controller_t1e1_info_current15_min_stats: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_controller_t1e1_info_total_stats

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_controller_t1e1_info_total_stats(device_id)

Retrieve T1E1 controller total stats from device (Real Time)

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_controller_t1e1_info_total_stats(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_controller_t1e1_info_total_stats: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_dsp_active

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dsp_active(device_id)

Get DSPFarm Active DSP info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_dsp_active(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_dsp_active: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_dsp_farm_profiles

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_dsp_farm_profiles(device_id)

Get DSPFarm Profiles info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_dsp_farm_profiles(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_dsp_farm_profiles: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_phone_info

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_phone_info(device_id)

Get phone registration info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_phone_info(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_phone_info: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sccp_ccm_groups

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sccp_ccm_groups(device_id)

Get DSPFarm SCCP CCM Groups info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_sccp_ccm_groups(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_sccp_ccm_groups: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sccp_connections

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_sccp_connections(device_id)

Get DSPFarm SCCP Connections info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_sccp_connections(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_sccp_connections: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_t1e1_isdn_status

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_t1e1_isdn_status(device_id)

Retrieve Voice ISDN Status from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_t1e1_isdn_status(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_t1e1_isdn_status: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_voice_calls

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_voice_calls(device_id)

Get voice call info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_voice_calls(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_voice_calls: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_voip_calls

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_voip_calls(device_id)

Get VOIP call info from device

Example

import time
import openapi_client
from openapi_client.api import real_time_monitoring_voice_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = real_time_monitoring_voice_api.RealTimeMonitoringVoiceApi(api_client)
    device_id = "deviceId_example" # str | Device Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_voip_calls(device_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling RealTimeMonitoringVoiceApi->get_voip_calls: %s\n" % e)

Parameters

Name Type Description Notes
device_id str Device Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]