Skip to content

Latest commit

 

History

History
302 lines (218 loc) · 10 KB

DevicesApi.md

File metadata and controls

302 lines (218 loc) · 10 KB

swagger_client.DevicesApi

All URIs are relative to https://api.phone.com/v4

Method HTTP request Description
create_account_device POST /accounts/{account_id}/devices Register a generic VoIP device.
delete_account_device DELETE /accounts/{account_id}/devices/{device_id} Delete a VoIP device.
get_account_device GET /accounts/{account_id}/devices/{device_id} Show details of an individual VoIP device.
list_account_devices GET /accounts/{account_id}/devices Get a list of VoIP devices associated with your account.
replace_account_device PUT /accounts/{account_id}/devices/{device_id} Update the details of an individual VoIP device.

create_account_device

DeviceFull create_account_device(account_id, data=data)

Register a generic VoIP device.

Register a generic VoIP device. See Devices for more detail.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
account_id = 56 # int | Account ID
data = swagger_client.CreateDeviceParams() # CreateDeviceParams | Device data (optional)

try: 
    # Register a generic VoIP device.
    api_response = api_instance.create_account_device(account_id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->create_account_device: %s\n" % e)

Parameters

Name Type Description Notes
account_id int Account ID
data CreateDeviceParams Device data [optional]

Return type

DeviceFull

Authorization

apiKey

HTTP request headers

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

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

delete_account_device

DeleteEntry delete_account_device(account_id, device_id)

Delete a VoIP device.

Delete a VoIP device. See Devices for more detail.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
account_id = 56 # int | Account ID
device_id = 56 # int | Device ID

try: 
    # Delete a VoIP device.
    api_response = api_instance.delete_account_device(account_id, device_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->delete_account_device: %s\n" % e)

Parameters

Name Type Description Notes
account_id int Account ID
device_id int Device ID

Return type

DeleteEntry

Authorization

apiKey

HTTP request headers

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

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

get_account_device

DeviceFull get_account_device(account_id, device_id)

Show details of an individual VoIP device.

Show details of an individual VoIP device. See Devices for more detail.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
account_id = 56 # int | Account ID
device_id = 56 # int | Device ID

try: 
    # Show details of an individual VoIP device.
    api_response = api_instance.get_account_device(account_id, device_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->get_account_device: %s\n" % e)

Parameters

Name Type Description Notes
account_id int Account ID
device_id int Device ID

Return type

DeviceFull

Authorization

apiKey

HTTP request headers

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

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

list_account_devices

ListDevices list_account_devices(account_id, filters_id=filters_id, filters_name=filters_name, sort_id=sort_id, sort_name=sort_name, limit=limit, offset=offset, fields=fields)

Get a list of VoIP devices associated with your account.

Get a list of VoIP devices associated with your account. See Devices for more detail.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
account_id = 56 # int | Account ID
filters_id = ['filters_id_example'] # list[str] | ID filter (optional)
filters_name = ['filters_name_example'] # list[str] | Name filter (optional)
sort_id = 'sort_id_example' # str | ID sorting (optional)
sort_name = 'sort_name_example' # str | Name sorting (optional)
limit = 56 # int | Max results (optional)
offset = 56 # int | Results to skip (optional)
fields = 'fields_example' # str | Field set (optional)

try: 
    # Get a list of VoIP devices associated with your account.
    api_response = api_instance.list_account_devices(account_id, filters_id=filters_id, filters_name=filters_name, sort_id=sort_id, sort_name=sort_name, limit=limit, offset=offset, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->list_account_devices: %s\n" % e)

Parameters

Name Type Description Notes
account_id int Account ID
filters_id list[str] ID filter [optional]
filters_name list[str] Name filter [optional]
sort_id str ID sorting [optional]
sort_name str Name sorting [optional]
limit int Max results [optional]
offset int Results to skip [optional]
fields str Field set [optional]

Return type

ListDevices

Authorization

apiKey

HTTP request headers

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

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

replace_account_device

DeviceFull replace_account_device(account_id, device_id, data=data)

Update the details of an individual VoIP device.

Update the details of an individual VoIP device. See Devices for more detail.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
account_id = 56 # int | Account ID
device_id = 56 # int | Device ID
data = swagger_client.CreateDeviceParams() # CreateDeviceParams | Device data (optional)

try: 
    # Update the details of an individual VoIP device.
    api_response = api_instance.replace_account_device(account_id, device_id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->replace_account_device: %s\n" % e)

Parameters

Name Type Description Notes
account_id int Account ID
device_id int Device ID
data CreateDeviceParams Device data [optional]

Return type

DeviceFull

Authorization

apiKey

HTTP request headers

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

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