View Source PlacetelAPI.Api.CallCenter (placetel_api v2.0.1)
API calls for all endpoints tagged CallCenter
.
Link to this section Summary
Functions
Fetch all call center agents Provides a list of all call center agents
Fetch all call center calls Provides a list of all call center calls
Fetch all call center queues Provides a list of all call center queues
Create an agent Create a new agent
Create a queue Create a queue
Update an agent Update an agent by its ID
Update a queue Update a queue
Link to this section Functions
@spec get_call_center_agents( Tesla.Env.client(), keyword() ) :: {:ok, [PlacetelAPI.Model.CallCenterAgent.t()]} | {:error, Tesla.Env.t()}
Fetch all call center agents Provides a list of all call center agents
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters:page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%CallCenterAgent{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_call_center_calls(Tesla.Env.client(), Date.t(), keyword()) :: {:ok, [PlacetelAPI.Model.CallCenterCall.t()]} | {:error, Tesla.Env.t()}
Fetch all call center calls Provides a list of all call center calls
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverdate
(Date.t): YYYY-MM-DDopts
(keyword): Optional parameters:page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%CallCenterCall{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_call_center_queues( Tesla.Env.client(), keyword() ) :: {:ok, [PlacetelAPI.Model.CallCenterQueue.t()]} | {:error, Tesla.Env.t()}
Fetch all call center queues Provides a list of all call center queues
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters:page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%CallCenterQueue{}, ...]}
on success{:error, Tesla.Env.t}
on failure
post_call_center_agents(connection, call_center_agents, opts \\ [])
View Source@spec post_call_center_agents( Tesla.Env.client(), PlacetelAPI.Model.PostCallCenterAgents.t(), keyword() ) :: {:ok, PlacetelAPI.Model.CallCenterAgent.t()} | {:error, Tesla.Env.t()}
Create an agent Create a new agent
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servercall_center_agents
(PostCallCenterAgents):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.CallCenterAgent.t}
on success{:error, Tesla.Env.t}
on failure
post_call_center_queues(connection, call_center_queues, opts \\ [])
View Source@spec post_call_center_queues( Tesla.Env.client(), PlacetelAPI.Model.PostCallCenterQueues.t(), keyword() ) :: {:ok, PlacetelAPI.Model.CallCenterQueue.t()} | {:error, Tesla.Env.t()}
Create a queue Create a queue
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to servercall_center_queues
(PostCallCenterQueues):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.CallCenterQueue.t}
on success{:error, Tesla.Env.t}
on failure
put_call_center_agents_id(connection, id, call_center_agents, opts \\ [])
View Source@spec put_call_center_agents_id( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutCallCenterAgents.t(), keyword() ) :: {:ok, PlacetelAPI.Model.CallCenterAgent.t()} | {:error, Tesla.Env.t()}
Update an agent Update an agent by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDcall_center_agents
(PutCallCenterAgents):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.CallCenterAgent.t}
on success{:error, Tesla.Env.t}
on failure
put_call_center_queues_id(connection, id, call_center_queues, opts \\ [])
View Source@spec put_call_center_queues_id( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutCallCenterQueues.t(), keyword() ) :: {:ok, PlacetelAPI.Model.CallCenterQueue.t()} | {:error, Tesla.Env.t()}
Update a queue Update a queue
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Queue IDcall_center_queues
(PutCallCenterQueues):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.CallCenterQueue.t}
on success{:error, Tesla.Env.t}
on failure