View Source PlacetelAPI.Api.Provisionings (placetel_api v2.0.0)
API calls for all endpoints tagged Provisionings
.
Link to this section Summary
Functions
Delete a phone provisionings Delete a phone provisioning
Delete a phone provisionings custom configuration key Delete a phone provisioning custom configuration key
Get all phone provisionings Provides a full list of all registered provisioned phones
Retrieve a phone provisionings Fetches a phone provisioning by its ID
Retrieve a phone provisionings custom configurations Fetches a phone provisionings custom configurations by its ID
Creates a phone provisionings Creates a phone provisioning
Trigger reconfiguration of a phone This sends a SIP command to the user on line 1 to fetch configuration changes.
Update a phone provisionings Updates a phone provisioning
Update or create a phone provisionings custom configuration key Updates or creates a phone provisioning custom configuration key
Link to this section Functions
@spec delete_provisionings_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete a phone provisionings Delete a phone provisioning
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDopts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
delete_provisionings_id_custom_configurations_custom_configuration_id(connection, id, custom_configuration_id, opts \\ [])
View Source@spec delete_provisionings_id_custom_configurations_custom_configuration_id( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete a phone provisionings custom configuration key Delete a phone provisioning custom configuration key
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDcustom_configuration_id
(integer()): Custom configuration IDopts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec get_provisionings( Tesla.Env.client(), keyword() ) :: {:ok, [PlacetelAPI.Model.Provisioning.t()]} | {:error, Tesla.Env.t()}
Get all phone provisionings Provides a full list of all registered provisioned phones
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters:search
(String.t)::page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%Provisioning{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_provisionings_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.Provisioning.t()} | {:error, Tesla.Env.t()}
Retrieve a phone provisionings Fetches a phone provisioning by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Provisioning.t}
on success{:error, Tesla.Env.t}
on failure
get_provisionings_id_custom_configurations(connection, id, opts \\ [])
View Source@spec get_provisionings_id_custom_configurations( Tesla.Env.client(), integer(), keyword() ) :: {:ok, PlacetelAPI.Model.CustomConfiguration.t()} | {:error, Tesla.Env.t()}
Retrieve a phone provisionings custom configurations Fetches a phone provisionings custom configurations by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.CustomConfiguration.t}
on success{:error, Tesla.Env.t}
on failure
@spec post_provisionings( Tesla.Env.client(), PlacetelAPI.Model.PostProvisionings.t(), keyword() ) :: {:ok, PlacetelAPI.Model.Provisioning.t()} | {:error, Tesla.Env.t()}
Creates a phone provisionings Creates a phone provisioning
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverprovisionings
(PostProvisionings):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Provisioning.t}
on success{:error, Tesla.Env.t}
on failure
@spec post_provisionings_id_reconfigure(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.Provisioning.t()} | {:error, Tesla.Env.t()}
Trigger reconfiguration of a phone This sends a SIP command to the user on line 1 to fetch configuration changes.
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Provisioning.t}
on success{:error, Tesla.Env.t}
on failure
@spec put_provisionings_id( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutProvisionings.t(), keyword() ) :: {:ok, PlacetelAPI.Model.Provisioning.t()} | {:error, Tesla.Env.t()}
Update a phone provisionings Updates a phone provisioning
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDprovisionings
(PutProvisionings):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Provisioning.t}
on success{:error, Tesla.Env.t}
on failure
put_provisionings_id_custom_configurations(connection, id, provisionings_id_custom_configurations, opts \\ [])
View Source@spec put_provisionings_id_custom_configurations( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutProvisioningsIdCustomConfigurations.t(), keyword() ) :: {:ok, PlacetelAPI.Model.Provisioning.t()} | {:error, Tesla.Env.t()}
Update or create a phone provisionings custom configuration key Updates or creates a phone provisioning custom configuration key
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): IDprovisionings_id_custom_configurations
(PutProvisioningsIdCustomConfigurations):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Provisioning.t}
on success{:error, Tesla.Env.t}
on failure