View Source PlacetelAPI.Api.SipUsers (placetel_api v2.0.1)
API calls for all endpoints tagged SipUsers
.
Link to this section Summary
Functions
Delete a sip user Delete a sip user by its ID
Delete short code Delete sip user short code
Fetch all sip users Fetch a list of all sip users
Fetch a sip user Fetch a sip users by its ID
Short codes List sip user short codes
Create a sip user Create a new sip user
Create short code Create sip user short code
Update a sip user Update a sip user by its ID
Link to this section Functions
@spec delete_sip_users_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}
Delete a sip user Delete a sip user by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.SipUser.t}
on success{:error, Tesla.Env.t}
on failure
delete_sip_users_id_short_codes_code_id(connection, id, code_id, opts \\ [])
View Source@spec delete_sip_users_id_short_codes_code_id( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, PlacetelAPI.Model.ShortCode.t()} | {:error, Tesla.Env.t()}
Delete short code Delete sip user short code
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDcode_id
(integer()): Short code IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.ShortCode.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_sip_users( Tesla.Env.client(), keyword() ) :: {:ok, [PlacetelAPI.Model.SipUser.t()]} | {:error, Tesla.Env.t()}
Fetch all sip users Fetch a list of all sip users
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters:"filter[did]"
(integer())::"filter[username]"
(String.t)::"filter[name]"
(String.t)::"filter[description]"
(String.t)::page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%SipUser{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_sip_users_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}
Fetch a sip user Fetch a sip users by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.SipUser.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_sip_users_id_short_codes(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.ShortCode.t()} | {:error, Tesla.Env.t()}
Short codes List sip user short codes
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.ShortCode.t}
on success{:error, Tesla.Env.t}
on failure
@spec post_sip_users( Tesla.Env.client(), PlacetelAPI.Model.PostSipUsers.t(), keyword() ) :: {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}
Create a sip user Create a new sip user
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serversip_users
(PostSipUsers):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.SipUser.t}
on success{:error, Tesla.Env.t}
on failure
post_sip_users_id_short_codes(connection, id, sip_users_id_short_codes, opts \\ [])
View Source@spec post_sip_users_id_short_codes( Tesla.Env.client(), integer(), PlacetelAPI.Model.PostSipUsersIdShortCodes.t(), keyword() ) :: {:ok, PlacetelAPI.Model.ShortCode.t()} | {:error, Tesla.Env.t()}
Create short code Create sip user short code
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDsip_users_id_short_codes
(PostSipUsersIdShortCodes):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.ShortCode.t}
on success{:error, Tesla.Env.t}
on failure
@spec put_sip_users_id( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutSipUsers.t(), keyword() ) :: {:ok, PlacetelAPI.Model.SipUser.t()} | {:error, Tesla.Env.t()}
Update a sip user Update a sip user by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Sip user IDsip_users
(PutSipUsers):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.SipUser.t}
on success{:error, Tesla.Env.t}
on failure