View Source PlacetelAPI.Api.CTI (placetel_api v2.0.0)
API calls for all endpoints tagged CTI
.
Link to this section Summary
Functions
Get config params Get config params
Answer This method allows device to answer a ringing call with given call_id.
Blind transfer This method allows to do a blind tranfser on the call specified by the call_id.
Complete conference This method allows to complete conference on the call specified by the call_id.
Complete transfer This method allows to initiate the tranfser on the call specified by the call_id.
Decline This method allows device to Decline the call specified by the call_id.
Dial This method initiates a new call.
Dial digit This method initiates a new call.
Hangup This method allows device to end the call specified by the call_id.
Hold This method allows device to hold the call specified by the call_id.
Resume This method allows device to resume the call specified by the call_id.
Send DTMF Digits This method allows to sendDTMFDigits on a current active call.
Start conference This method allows to initiate conference on the call specified by the call_id.
Start transfer This method allows to initiate the tranfser on the call specified by the call_id.
Set config params Set config params
Link to this section Functions
@spec get_cti_mac(Tesla.Env.client(), [String.t()], integer(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Get config params Get config params
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverparams
([String.t]):mac
(integer()):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec post_cti_mac_answer( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacAnswer.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Answer This method allows device to answer a ringing call with given call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_answer
(PostCtiMacAnswer):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_blind_transfer(connection, mac, cti_mac_blind_transfer, opts \\ [])
View Source@spec post_cti_mac_blind_transfer( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacBlindTransfer.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Blind transfer This method allows to do a blind tranfser on the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_blind_transfer
(PostCtiMacBlindTransfer):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_complete_conference(connection, mac, cti_mac_complete_conference, opts \\ [])
View Source@spec post_cti_mac_complete_conference( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacCompleteConference.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Complete conference This method allows to complete conference on the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_complete_conference
(PostCtiMacCompleteConference):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_complete_transfer(connection, mac, cti_mac_complete_transfer, opts \\ [])
View Source@spec post_cti_mac_complete_transfer( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacCompleteTransfer.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Complete transfer This method allows to initiate the tranfser on the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_complete_transfer
(PostCtiMacCompleteTransfer):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_decline(connection, mac, cti_mac_decline, opts \\ [])
View Source@spec post_cti_mac_decline( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacDecline.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Decline This method allows device to Decline the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_decline
(PostCtiMacDecline):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec post_cti_mac_dial( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacDial.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Dial This method initiates a new call.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_dial
(PostCtiMacDial):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_dial_digit(connection, mac, cti_mac_dial_digit, opts \\ [])
View Source@spec post_cti_mac_dial_digit( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacDialDigit.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Dial digit This method initiates a new call.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_dial_digit
(PostCtiMacDialDigit):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec post_cti_mac_hangup( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacHangup.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Hangup This method allows device to end the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_hangup
(PostCtiMacHangup):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec post_cti_mac_hold( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacHold.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Hold This method allows device to hold the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_hold
(PostCtiMacHold):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec post_cti_mac_resume( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacResume.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Resume This method allows device to resume the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_resume
(PostCtiMacResume):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_send_dtmf_digits(connection, mac, cti_mac_send_dtmf_digits, opts \\ [])
View Source@spec post_cti_mac_send_dtmf_digits( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacSendDtmfDigits.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Send DTMF Digits This method allows to sendDTMFDigits on a current active call.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_send_dtmf_digits
(PostCtiMacSendDtmfDigits):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_start_conference(connection, mac, cti_mac_start_conference, opts \\ [])
View Source@spec post_cti_mac_start_conference( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacStartConference.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Start conference This method allows to initiate conference on the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_start_conference
(PostCtiMacStartConference):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
post_cti_mac_start_transfer(connection, mac, cti_mac_start_transfer, opts \\ [])
View Source@spec post_cti_mac_start_transfer( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostCtiMacStartTransfer.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Start transfer This method allows to initiate the tranfser on the call specified by the call_id.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti_mac_start_transfer
(PostCtiMacStartTransfer):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec put_cti_mac( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutCti.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Set config params Set config params
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servermac
(integer()):cti
(PutCti):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure