Skip to content

CallsApi.md

Latest commit

 

History

History
1065 lines (767 loc) · 34 KB

CallsApi.md

File metadata and controls

1065 lines (767 loc) · 34 KB

liveagent_api.CallsApi

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

Method HTTP request Description
call_add_message POST /calls/{callId}/messages Adds a message to the call group in corresponfing ticket
call_add_recording POST /calls/{callId}/recordings Adds a recording to the call group in corresponfing ticket
call_answer POST /calls/{callId}/_answer Set call as answered by agent
call_change_channel_status PUT /calls/{callId}/channels/{channelId}/_status Change channel status
call_create POST /calls/{callId} Create new call
call_fetch_ivr POST /calls/{callId}/_fetchIvr Fetches IVR for the call from external URL
call_get_status GET /calls/{callId}/status Return the status of call
call_move_channel POST /calls/{callId}/channels/{channelId}/_move Moves existing channel to target call
call_remove_channel DELETE /calls/{callId}/channels/{channelId} Removes channel from the call
call_reroute POST /calls/{callId}/_reroute Let the call ring to another agent
call_ring POST /calls/{callId}/_ring Let the call ring
call_start POST /call/_start Starts new outcoming / internal call
call_start_canceled POST /call/_startCanceled Callback that starting call canceled
call_start_failed POST /call/_startFailed Callback that starting call failed
call_stop POST /calls/{callId}/_stop Stops the call
call_transfer POST /calls/{callId}/_transfer Transfers call to different department / agent
confirm_ring POST /calls/{callId}/_confirmRing Confirm that call is ringing
get_calls_list GET /calls Gets list of calls
merge POST /calls/{callId}/_merge Merge two calls

call_add_message

OkResponse call_add_message(call_id, body=body)

Adds a message to the call group in corresponfing ticket

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.CallsApi()
call_id = 'call_id_example' # str | 
body = liveagent_api.CallMessage() # CallMessage |  (optional)

try: 
    # Adds a message to the call group in corresponfing ticket
    api_response = api_instance.call_add_message(call_id, body=body)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_add_message: %s\n" % e

Parameters

Name Type Description Notes
call_id str
body CallMessage [optional]

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]

call_add_recording

OkResponse call_add_recording(call_id, file=file)

Adds a recording to the call group in corresponfing ticket

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.CallsApi()
call_id = 'call_id_example' # str | 
file = '/path/to/file.txt' # file |  (optional)

try: 
    # Adds a recording to the call group in corresponfing ticket
    api_response = api_instance.call_add_recording(call_id, file=file)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_add_recording: %s\n" % e

Parameters

Name Type Description Notes
call_id str
file file [optional]

Return type

OkResponse

Authorization

privileges, apikey

HTTP request headers

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

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

call_answer

OkResponse call_answer(call_id, to_number, channel_id=channel_id)

Set call as answered by agent

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.CallsApi()
call_id = 'call_id_example' # str | 
to_number = 'to_number_example' # str | callee number
channel_id = 'channel_id_example' # str | Channel ID (optional)

try: 
    # Set call as answered by agent
    api_response = api_instance.call_answer(call_id, to_number, channel_id=channel_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_answer: %s\n" % e

Parameters

Name Type Description Notes
call_id str
to_number str callee number
channel_id str Channel ID [optional]

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]

call_change_channel_status

OkResponse call_change_channel_status(call_id, channel_id, status)

Change channel status

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.CallsApi()
call_id = 'call_id_example' # str | 
channel_id = 'channel_id_example' # str | 
status = 'status_example' # str | run (\u2018R\u2019 - default), hold (\u2018H\u2019)

try: 
    # Change channel status
    api_response = api_instance.call_change_channel_status(call_id, channel_id, status)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_change_channel_status: %s\n" % e

Parameters

Name Type Description Notes
call_id str
channel_id str
status str run (\u2018R\u2019 - default), hold (\u2018H\u2019)

Return type

OkResponse

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]

call_create

Call call_create(call_id, to_number, from_number, channel_id=channel_id, via_number=via_number, ticket_id=ticket_id, direction=direction)

Create new call

Creates new call (ingoing / outcoming / internal). Does not initiate the outgoing call

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.CallsApi()
call_id = 'call_id_example' # str | 
to_number = 'to_number_example' # str | callee number
from_number = 'from_number_example' # str | caller number
channel_id = 'channel_id_example' # str | Channel ID (optional)
via_number = 'via_number_example' # str | trunk number via which call was made / received (optional)
ticket_id = 'ticket_id_example' # str | ticket id or code (optional)
direction = 'in' # str | incoming call ('in' - default), outgoing call ('out'), internal call('int'), auto decide direction of call based on to_number ('auto') (optional) (default to in)

try: 
    # Create new call
    api_response = api_instance.call_create(call_id, to_number, from_number, channel_id=channel_id, via_number=via_number, ticket_id=ticket_id, direction=direction)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_create: %s\n" % e

Parameters

Name Type Description Notes
call_id str
to_number str callee number
from_number str caller number
channel_id str Channel ID [optional]
via_number str trunk number via which call was made / received [optional]
ticket_id str ticket id or code [optional]
direction str incoming call ('in' - default), outgoing call ('out'), internal call('int'), auto decide direction of call based on to_number ('auto') [optional] [default to in]

Return type

Call

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]

call_fetch_ivr

list[Ivr] call_fetch_ivr(call_id, fetch)

Fetches IVR for the call from external URL

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.CallsApi()
call_id = 'call_id_example' # str | 
fetch = liveagent_api.IvrFetch() # IvrFetch | 

try: 
    # Fetches IVR for the call from external URL
    api_response = api_instance.call_fetch_ivr(call_id, fetch)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_fetch_ivr: %s\n" % e

Parameters

Name Type Description Notes
call_id str
fetch IvrFetch

Return type

list[Ivr]

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]

call_get_status

CallStatus call_get_status(call_id)

Return the status of call

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.CallsApi()
call_id = 'call_id_example' # str | 

try: 
    # Return the status of call
    api_response = api_instance.call_get_status(call_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_get_status: %s\n" % e

Parameters

Name Type Description Notes
call_id str

Return type

CallStatus

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]

call_move_channel

OkResponse call_move_channel(call_id, channel_id, to_call_id)

Moves existing channel to target call

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.CallsApi()
call_id = 'call_id_example' # str | 
channel_id = 'channel_id_example' # str | 
to_call_id = 'to_call_id_example' # str | Target call

try: 
    # Moves existing channel to target call
    api_response = api_instance.call_move_channel(call_id, channel_id, to_call_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_move_channel: %s\n" % e

Parameters

Name Type Description Notes
call_id str
channel_id str
to_call_id str Target call

Return type

OkResponse

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]

call_remove_channel

OkResponse call_remove_channel(call_id, channel_id)

Removes channel from the call

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.CallsApi()
call_id = 'call_id_example' # str | 
channel_id = 'channel_id_example' # str | 

try: 
    # Removes channel from the call
    api_response = api_instance.call_remove_channel(call_id, channel_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_remove_channel: %s\n" % e

Parameters

Name Type Description Notes
call_id str
channel_id str

Return type

OkResponse

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]

call_reroute

CallStatus call_reroute(call_id, reason=reason)

Let the call ring to another agent

Lets the call ring to an another agent if available

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.CallsApi()
call_id = 'call_id_example' # str | 
reason = 'reason_example' # str | T - timeout, D - decline, DNR - device not registered (optional)

try: 
    # Let the call ring to another agent
    api_response = api_instance.call_reroute(call_id, reason=reason)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_reroute: %s\n" % e

Parameters

Name Type Description Notes
call_id str
reason str T - timeout, D - decline, DNR - device not registered [optional]

Return type

CallStatus

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]

call_ring

CallStatus call_ring(call_id, department_id=department_id, to_number=to_number)

Let the call ring

Lets the call ring to an agent or adds it to queue if all agents are busy

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.CallsApi()
call_id = 'call_id_example' # str | 
department_id = 'department_id_example' # str | Department ID (optional)
to_number = 'to_number_example' # str | callee number (optional)

try: 
    # Let the call ring
    api_response = api_instance.call_ring(call_id, department_id=department_id, to_number=to_number)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_ring: %s\n" % e

Parameters

Name Type Description Notes
call_id str
department_id str Department ID [optional]
to_number str callee number [optional]

Return type

CallStatus

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]

call_start

OkResponse call_start(to_number, from_number, via_number, ticket_id)

Starts new outcoming / internal call

Starts new call by ringing agent device and the dialing customer after agent has picked up his phone\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'

# create an instance of the API class
api_instance = liveagent_api.CallsApi()
to_number = 'to_number_example' # str | callee number
from_number = 'from_number_example' # str | caller number
via_number = 'via_number_example' # str | trunk number via which call was made
ticket_id = 'ticket_id_example' # str | ticket id or code

try: 
    # Starts new outcoming / internal call
    api_response = api_instance.call_start(to_number, from_number, via_number, ticket_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_start: %s\n" % e

Parameters

Name Type Description Notes
to_number str callee number
from_number str caller number
via_number str trunk number via which call was made
ticket_id str ticket id or code

Return type

OkResponse

Authorization

privileges

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]

call_start_canceled

OkResponse call_start_canceled(call_id)

Callback that starting call canceled

Callback is delivered only of HW phones

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.CallsApi()
call_id = 'call_id_example' # str | Call ID

try: 
    # Callback that starting call canceled
    api_response = api_instance.call_start_canceled(call_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_start_canceled: %s\n" % e

Parameters

Name Type Description Notes
call_id str Call ID

Return type

OkResponse

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]

call_start_failed

OkResponse call_start_failed(call_id)

Callback that starting call failed

Callback is delivered only of HW phones

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.CallsApi()
call_id = 'call_id_example' # str | Call ID

try: 
    # Callback that starting call failed
    api_response = api_instance.call_start_failed(call_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_start_failed: %s\n" % e

Parameters

Name Type Description Notes
call_id str Call ID

Return type

OkResponse

Authorization

privileges

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]

call_stop

OkResponse call_stop(call_id, from_number=from_number)

Stops the call

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.CallsApi()
call_id = 'call_id_example' # str | 
from_number = 'from_number_example' # str | from number (optional)

try: 
    # Stops the call
    api_response = api_instance.call_stop(call_id, from_number=from_number)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_stop: %s\n" % e

Parameters

Name Type Description Notes
call_id str
from_number str from number [optional]

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]

call_transfer

CallTransferResult call_transfer(call_id, to=to)

Transfers call to different department / agent

Transfer can be called on incoming calls before they start ringing to agents

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.CallsApi()
call_id = 'call_id_example' # str | 
to = 'to_example' # str | Department ID or extension (optional)

try: 
    # Transfers call to different department / agent
    api_response = api_instance.call_transfer(call_id, to=to)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->call_transfer: %s\n" % e

Parameters

Name Type Description Notes
call_id str
to str Department ID or extension [optional]

Return type

CallTransferResult

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]

confirm_ring

OkResponse confirm_ring(call_id, to_number=to_number, channel_id=channel_id)

Confirm that call is ringing

Confirms that the call is ringing to an agent

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.CallsApi()
call_id = 'call_id_example' # str | 
to_number = 'to_number_example' # str | callee number (optional)
channel_id = 'channel_id_example' # str | Channel ID (optional)

try: 
    # Confirm that call is ringing
    api_response = api_instance.confirm_ring(call_id, to_number=to_number, channel_id=channel_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->confirm_ring: %s\n" % e

Parameters

Name Type Description Notes
call_id str
to_number str callee number [optional]
channel_id str Channel ID [optional]

Return type

OkResponse

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_calls_list

list[CallListItem] get_calls_list(page=page, per_page=per_page, _from=_from, to=to, sort_dir=sort_dir, sort_field=sort_field, filters=filters)

Gets list of calls

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.CallsApi()
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 calls
    api_response = api_instance.get_calls_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 CallsApi->get_calls_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[CallListItem]

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]

merge

OkResponse merge(call_id, sec_call_id, agent_id=agent_id)

Merge two calls

Merge secondary call into main call

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.CallsApi()
call_id = 'call_id_example' # str | 
sec_call_id = 'sec_call_id_example' # str | Secondary call ID
agent_id = 'agent_id_example' # str | Agent ID for removing from the call (optional)

try: 
    # Merge two calls
    api_response = api_instance.merge(call_id, sec_call_id, agent_id=agent_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->merge: %s\n" % e

Parameters

Name Type Description Notes
call_id str
sec_call_id str Secondary call ID
agent_id str Agent ID for removing from the call [optional]

Return type

OkResponse

Authorization

privileges

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]