Skip to content

PhonesApi.md

Latest commit

 

History

History
287 lines (208 loc) · 9.71 KB

PhonesApi.md

File metadata and controls

287 lines (208 loc) · 9.71 KB

liveagent_api.PhonesApi

All URIs are relative to http://localhost/api/v3

Method HTTP request Description
create_phone POST /phones Creates external phone
get_phone GET /phones/{phoneId} Gets phone device (use app for LiveAgent Phone app device and web for web device)
get_phones_list GET /phones Gets list of available phone devices.\nSpecial filters (userId - filter phones available for specified user only)\n
remove_phone DELETE /phones/{phoneId} Remove phone
update_phone_params PUT /phones/{phoneId}/_updateParams Update phone paramas

create_phone

PhoneDevice create_phone(number, type=type, name=name)

Creates external phone

Example

import time
import liveagent_api
from liveagent_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: privileges
liveagent_api.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = liveagent_api.PhonesApi()
number = 'number_example' # str | 
type = 'S' # str | S - SIP phone, E - PSTN phone (optional) (default to S)
name = 'name_example' # str |  (optional)

try: 
    # Creates external phone
    api_response = api_instance.create_phone(number, type=type, name=name)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling PhonesApi->create_phone: %s\n" % e

Parameters

Name Type Description Notes
number str
type str S - SIP phone, E - PSTN phone [optional] [default to S]
name str [optional]

Return type

PhoneDevice

Authorization

privileges

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_phone

PhoneDevice get_phone(phone_id)

Gets phone device (use app for LiveAgent Phone app device and web for web device)

Example

import time
import liveagent_api
from liveagent_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: privileges
liveagent_api.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure API key authorization: apikey
liveagent_api.configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# liveagent_api.configuration.api_key_prefix['apikey'] = 'BEARER'

# create an instance of the API class
api_instance = liveagent_api.PhonesApi()
phone_id = 'phone_id_example' # str | 

try: 
    # Gets phone device (use _app_ for LiveAgent Phone app device and _web_ for web device)
    api_response = api_instance.get_phone(phone_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling PhonesApi->get_phone: %s\n" % e

Parameters

Name Type Description Notes
phone_id str

Return type

PhoneDevice

Authorization

privileges, 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_phones_list

list[PhoneDevice] get_phones_list(page=page, per_page=per_page, _from=_from, to=to, sort_dir=sort_dir, sort_field=sort_field, filters=filters)

Gets list of available phone devices.\nSpecial filters (userId - filter phones available for specified user only)\n

Example

import time
import liveagent_api
from liveagent_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: privileges
liveagent_api.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure API key authorization: apikey
liveagent_api.configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# liveagent_api.configuration.api_key_prefix['apikey'] = 'BEARER'

# create an instance of the API class
api_instance = liveagent_api.PhonesApi()
page = 1 # int | Page to display. Not used if _from is defined. (optional) (default to 1)
per_page = 10 # int | Results per page. Used only if _page is used. (optional) (default to 10)
_from = 0 # int | Result set start. Takes precedence over _page. (optional) (default to 0)
to = 0 # int | Result set end. Used only if _from is used. (optional) (default to 0)
sort_dir = 'ASC' # str | Sorting direction ASC or DESC (optional) (default to ASC)
sort_field = 'sort_field_example' # str | Sorting field (optional)
filters = 'filters_example' # str | Filters (json object {column:value, ...}) (optional)

try: 
    # Gets list of available phone devices.\nSpecial filters (userId - filter phones available for specified user only)\n
    api_response = api_instance.get_phones_list(page=page, per_page=per_page, _from=_from, to=to, sort_dir=sort_dir, sort_field=sort_field, filters=filters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling PhonesApi->get_phones_list: %s\n" % e

Parameters

Name Type Description Notes
page int Page to display. Not used if _from is defined. [optional] [default to 1]
per_page int Results per page. Used only if _page is used. [optional] [default to 10]
_from int Result set start. Takes precedence over _page. [optional] [default to 0]
to int Result set end. Used only if _from is used. [optional] [default to 0]
sort_dir str Sorting direction ASC or DESC [optional] [default to ASC]
sort_field str Sorting field [optional]
filters str Filters (json object {column:value, ...}) [optional]

Return type

list[PhoneDevice]

Authorization

privileges, 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]

remove_phone

OkResponse remove_phone(phone_id)

Remove phone

Example

import time
import liveagent_api
from liveagent_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: privileges
liveagent_api.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure API key authorization: apikey
liveagent_api.configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# liveagent_api.configuration.api_key_prefix['apikey'] = 'BEARER'

# create an instance of the API class
api_instance = liveagent_api.PhonesApi()
phone_id = 'phone_id_example' # str | 

try: 
    # Remove phone
    api_response = api_instance.remove_phone(phone_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling PhonesApi->remove_phone: %s\n" % e

Parameters

Name Type Description Notes
phone_id str

Return type

OkResponse

Authorization

privileges, 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]

update_phone_params

OkResponse update_phone_params(phone_id, params)

Update phone paramas

Example

import time
import liveagent_api
from liveagent_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: privileges
liveagent_api.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure API key authorization: apikey
liveagent_api.configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# liveagent_api.configuration.api_key_prefix['apikey'] = 'BEARER'

# create an instance of the API class
api_instance = liveagent_api.PhonesApi()
phone_id = 'phone_id_example' # str | 
params = 'params_example' # str | New params

try: 
    # Update phone paramas
    api_response = api_instance.update_phone_params(phone_id, params)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling PhonesApi->update_phone_params: %s\n" % e

Parameters

Name Type Description Notes
phone_id str
params str New params

Return type

OkResponse

Authorization

privileges, apikey

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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