voxbone

v0.3.0

voxbone v0.3.0 Voxbone.Api.Configuration

API calls for all endpoints tagged Configuration.

Link to this section Summary

Functions

apply_configuration(connection, body, opts \\ [])

The applyConfiguration method is used to configure one or multiple DIDs with certain settings. The possible settings that can be configured for each DID are described below in the list of input parameters. Note: if you get an error message for one DID, then you should consider that none of the DIDs in your request will get the requested configuration and you should resubmit the request with the necessary changes

apply_did_configuration(connection, body, opts \\ [])

The applyDIDConfiguration method is used to configure a single DID with certain settings. This is the only method to apply voxOutInternational configuration changes

create_sms_link_group(connection, opts \\ [])

Allows you to create an SMS link group. An SMS link group is an entity that contains one or several links. For SMS traffic coming from Voxbone to one of your DIDs, you need to link the DID to the link group so that the traffic can be routed to the appropriate destination. If several links are contained in the link group, the traffic will be load balanced according to the weight parameter defined in the links definition

delete_capacity_group(connection, capacity_group_id, opts \\ [])

Allows you to remove one of your capacity groups

delete_fax_uri(connection, fax_uri_id, opts \\ [])

Allows you to remove one of your Fax URIs

delete_sms_link(connection, sms_link_id, opts \\ [])

Allows you to delete an SMS link

delete_sms_link_group(connection, sms_link_group_id, opts \\ [])

Allows you to delete an SMS link group

delete_voice_uri(connection, voice_uri_id, opts \\ [])

Allows you to remove one of your voice URIs

get_capacity_group(connection, capacity_group_id, opts \\ [])

Allows you to get the capacity group for the given ID

get_fax_uri(connection, fax_uri_id, opts \\ [])

Allows you to get the Fax URI for the specified ID

get_sms_link(connection, sms_link_id, opts \\ [])

Allows you to retrieve the SMS Link for the specified ID

get_sms_link_groups(connection, opts \\ [])

Allows you to retrieve the list of your SMS link groups

get_voice_uri(connection, voice_uri_id, opts \\ [])

Allows you to retrieve the Voice URI for the specified ID

list_capacity_group(connection, page_number, page_size, opts \\ [])

Allows you to get the list of your capacity groups

list_fax_uri(connection, page_number, page_size, opts \\ [])

Allows you to get the list of your Fax URIs and their details

list_pop(connection, opts \\ [])

Allows you to get the list of Voxbone’s POPs (Points Of Presence) and their corresponding IP addresses

list_sms_link(connection, opts \\ [])

Allows you to retrieve the list of your SMS Links

list_voice_uri(connection, page_number, page_size, opts \\ [])

Allows you to get the list of your Voice URIs and their details

save_capacity_group(connection, body, opts \\ [])

Allows you to either create a new capacity group or update an existing one. If an existing capacityGroupId is passed in the request, then an update will be performed. If no capacityGroupId is passed, then a new capacity group is created

save_fax_uri(connection, body, opts \\ [])

Allows you to either create a new Fax URI or update an existing one. If an existing faxUriId is passed in the request, then an update will be performed. If no faxUriId is passed, then a new Fax URI is created

save_sms_link(connection, opts \\ [])

Allows you to create an SMS Link. An SMS link is an entity that defines the direction of the SMS connection, the protocol type, and the connection details

save_voice_uri(connection, body, opts \\ [])

Allows you to either create a new Voice URI or update an existing one. If an existing voiceUriId is passed in the request, then an update will be performed. If no voiceUriId is passed, then a new Voice URI is created

update_capacity_group(connection, capacity_group_id, opts \\ [])

Allows you to update a capacity group

update_fax_uri(connection, fax_uri_id, opts \\ [])

Allows you to update an existing Fax URI

update_sms_link(connection, sms_link_id, opts \\ [])

Allows you to update an existing SMS Link

update_voice_uri(connection, voice_uri_id, opts \\ [])

Allows you to update an existing Voice URI

Link to this section Functions

Link to this function apply_configuration(connection, body, opts \\ []) 
apply_configuration(
  Tesla.Env.client(),
  Voxbone.Model.DidConfigurationRequest.t(),
  keyword()
) :: {:ok, Voxbone.Model.DidConfigurationResponse.t()} | {:error, Tesla.Env.t()}

The applyConfiguration method is used to configure one or multiple DIDs with certain settings. The possible settings that can be configured for each DID are described below in the list of input parameters. Note: if you get an error message for one DID, then you should consider that none of the DIDs in your request will get the requested configuration and you should resubmit the request with the necessary changes.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • body (DidConfigurationRequest):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.DidConfigurationResponse{}} on success {:error, info} on failure

Link to this function apply_did_configuration(connection, body, opts \\ []) 
apply_did_configuration(
  Tesla.Env.client(),
  Voxbone.Model.SingleDidConfigurationRequest.t(),
  keyword()
) ::
  {:ok, Voxbone.Model.SingleDidConfigurationResponse.t()}
  | {:error, Tesla.Env.t()}

The applyDIDConfiguration method is used to configure a single DID with certain settings. This is the only method to apply voxOutInternational configuration changes.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • body (SingleDidConfigurationRequest):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.SingleDidConfigurationResponse{}} on success {:error, info} on failure

Link to this function delete_capacity_group(connection, capacity_group_id, opts \\ []) 
delete_capacity_group(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.DeleteCapacityGroupResponse.t()} | {:error, Tesla.Env.t()}

Allows you to remove one of your capacity groups.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • capacity_group_id (integer()): The ID of one of your existing capacity groups which should be removed.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.DeleteCapacityGroupResponse{}} on success {:error, info} on failure

Link to this function delete_fax_uri(connection, fax_uri_id, opts \\ []) 
delete_fax_uri(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.DeleteFaxUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to remove one of your Fax URIs.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • fax_uri_id (integer()): Indicates the ID of one of your existing Fax URIs which should be removed.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.DeleteFaxUriResponse{}} on success {:error, info} on failure

Link to this function delete_sms_link(connection, sms_link_id, opts \\ []) 
delete_sms_link(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.DeleteSmsLinkResponse.t()} | {:error, Tesla.Env.t()}

Allows you to delete an SMS link.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • sms_link_id (integer()): The ID of the SMS link that you wish to delete. Note that this operation can impact your service, make sure no DID will be impacted by this operation.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.DeleteSmsLinkResponse{}} on success {:error, info} on failure

Link to this function delete_voice_uri(connection, voice_uri_id, opts \\ []) 
delete_voice_uri(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.DeleteVoiceUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to remove one of your voice URIs.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • voice_uri_id (integer()): Indicates the ID of one of your existing voice URIs which should be removed.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.DeleteVoiceUriResponse{}} on success {:error, info} on failure

Link to this function get_capacity_group(connection, capacity_group_id, opts \\ []) 
get_capacity_group(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListCapacityGroupResponse.t()} | {:error, Tesla.Env.t()}

Allows you to get the capacity group for the given ID

Parameters

  • connection (Voxbone.Connection): Connection to server
  • capacity_group_id (integer()): The ID of one of your existing capacity groups.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.ListCapacityGroupResponse{}} on success {:error, info} on failure

Link to this function get_fax_uri(connection, fax_uri_id, opts \\ []) 
get_fax_uri(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListFaxUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to get the Fax URI for the specified ID.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • fax_uri_id (integer()): The identifier of the fax uri.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.ListFaxUriResponse{}} on success {:error, info} on failure

Link to this function get_sms_link(connection, sms_link_id, opts \\ []) 
get_sms_link(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListSmsLinkResponse.t()} | {:error, Tesla.Env.t()}

Allows you to retrieve the SMS Link for the specified ID.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • sms_link_id (integer()): The identifier of the SMS Link
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.ListSmsLinkResponse{}} on success {:error, info} on failure

Link to this function get_voice_uri(connection, voice_uri_id, opts \\ []) 
get_voice_uri(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListVoiceUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to retrieve the Voice URI for the specified ID.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • voice_uri_id (integer()): The identifier of the Voice URI.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.ListVoiceUriResponse{}} on success {:error, info} on failure

Link to this function list_capacity_group(connection, page_number, page_size, opts \\ []) 
list_capacity_group(Tesla.Env.client(), integer(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListCapacityGroupResponse.t()} | {:error, Tesla.Env.t()}

Allows you to get the list of your capacity groups.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • page_number (integer()): The page number, starting at 0.
  • page_size (integer()): The page size (max number of entities that are displayed in the response).

  • opts (KeywordList): [optional] Optional parameters

    • :capacity_group_id (integer()): The identifier of the capacity group to search for.
    • :description (String.t): The description of the capacity group.
    • :e164 (String.t): The e164 bound to the capacity group.

Returns

{:ok, %Voxbone.Model.ListCapacityGroupResponse{}} on success {:error, info} on failure

Link to this function list_fax_uri(connection, page_number, page_size, opts \\ []) 
list_fax_uri(Tesla.Env.client(), integer(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListFaxUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to get the list of your Fax URIs and their details.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • page_number (integer()): The page number, starting at 0.
  • page_size (integer()): The page size (max number of entities that are displayed in the response).

  • opts (KeywordList): [optional] Optional parameters

    • :fax_uri_id (integer()): The identifier of the fax uri.
    • :delivery_method (String.t): This is the delivery method on which you want to filter your list of Fax URIs. The possible values are SMTP and HTTP_POST.
    • :fax_file_format (String.t): This is the file format on which you want to filter your list of Fax URIs. The possible values are Tiff and Pdf.
    • :uri (String.t): This is the URI on which you want to filter your list of Fax URIs.
    • :csid (String.t): This to filter in/out the Fax URIs for which CSID (Called subscriber identification) is enabled.

Returns

{:ok, %Voxbone.Model.ListFaxUriResponse{}} on success {:error, info} on failure

Link to this function list_pop(connection, opts \\ []) 
list_pop(Tesla.Env.client(), keyword()) ::
  {:ok, Voxbone.Model.ListPopResponse.t()} | {:error, Tesla.Env.t()}

Allows you to get the list of Voxbone’s POPs (Points Of Presence) and their corresponding IP addresses.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.ListPopResponse{}} on success {:error, info} on failure

Link to this function list_sms_link(connection, opts \\ []) 
list_sms_link(Tesla.Env.client(), keyword()) ::
  {:ok, Voxbone.Model.ListSmsLinkResponse.t()} | {:error, Tesla.Env.t()}

Allows you to retrieve the list of your SMS Links.

Parameters

  • connection (Voxbone.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :sms_link_id (integer()): The identifier of the sms link.
    • :group_id (integer()): This can be used to filter based on the SMS link group and get the list of your SMS links within that SMS link group.
    • :type (String.t): This can be used to filter based on the type (protocol) of SMS links: REST_JSON, SMPP_SMSC, SMPP_ESME, SOAP, SIP, SMTP.
    • :direction (String.t): This can be used to filter your SMS links based on their direction: FROM_VOXBONE, TO_VOXBONE or BIDIRECTIONAL.

Returns

{:ok, %Voxbone.Model.ListSmsLinkResponse{}} on success {:error, info} on failure

Link to this function list_voice_uri(connection, page_number, page_size, opts \\ []) 
list_voice_uri(Tesla.Env.client(), integer(), integer(), keyword()) ::
  {:ok, Voxbone.Model.ListVoiceUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to get the list of your Voice URIs and their details.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • page_number (integer()): The page number, starting at 0.
  • page_size (integer()): The page size (max number of entities that are displayed in the response).

  • opts (KeywordList): [optional] Optional parameters

    • :voice_uri_id (integer()): The identifier of the voice uri.
    • :backup_uri_id (integer()): The identifier of the voice uri acting as backup.
    • :voice_uri_protocol (String.t): The protocol to use with this voice uri. The only protocol currently supported for voice is SIP.
    • :uri (String.t): The actual uri where the call will be delivered.
    • :description (String.t): A human-readable description of this uri.

Returns

{:ok, %Voxbone.Model.ListVoiceUriResponse{}} on success {:error, info} on failure

Link to this function save_capacity_group(connection, body, opts \\ []) 
save_capacity_group(
  Tesla.Env.client(),
  Voxbone.Model.SaveCapacityGroupRequest.t(),
  keyword()
) ::
  {:ok, Voxbone.Model.SaveCapacityGroupResponse.t()} | {:error, Tesla.Env.t()}

Allows you to either create a new capacity group or update an existing one. If an existing capacityGroupId is passed in the request, then an update will be performed. If no capacityGroupId is passed, then a new capacity group is created.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • body (SaveCapacityGroupRequest):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.SaveCapacityGroupResponse{}} on success {:error, info} on failure

Link to this function save_fax_uri(connection, body, opts \\ []) 
save_fax_uri(Tesla.Env.client(), Voxbone.Model.SaveFaxUriRequest.t(), keyword()) ::
  {:ok, Voxbone.Model.SaveFaxUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to either create a new Fax URI or update an existing one. If an existing faxUriId is passed in the request, then an update will be performed. If no faxUriId is passed, then a new Fax URI is created.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • body (SaveFaxUriRequest):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.SaveFaxUriResponse{}} on success {:error, info} on failure

Link to this function save_sms_link(connection, opts \\ []) 
save_sms_link(Tesla.Env.client(), keyword()) ::
  {:ok, Voxbone.Model.SaveSmsLinkResponse.t()} | {:error, Tesla.Env.t()}

Allows you to create an SMS Link. An SMS link is an entity that defines the direction of the SMS connection, the protocol type, and the connection details.

Parameters

  • connection (Voxbone.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :body (SaveSmsLinkRequest):

Returns

{:ok, %Voxbone.Model.SaveSmsLinkResponse{}} on success {:error, info} on failure

Link to this function save_voice_uri(connection, body, opts \\ []) 
save_voice_uri(
  Tesla.Env.client(),
  Voxbone.Model.SaveVoiceUriRequest.t(),
  keyword()
) :: {:ok, Voxbone.Model.SaveVoiceUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to either create a new Voice URI or update an existing one. If an existing voiceUriId is passed in the request, then an update will be performed. If no voiceUriId is passed, then a new Voice URI is created.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • body (SaveVoiceUriRequest):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Voxbone.Model.SaveVoiceUriResponse{}} on success {:error, info} on failure

Link to this function update_capacity_group(connection, capacity_group_id, opts \\ []) 
update_capacity_group(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.SaveCapacityGroupResponse.t()} | {:error, Tesla.Env.t()}

Allows you to update a capacity group.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • capacity_group_id (integer()): The ID of one of your existing capacity groups.

  • opts (KeywordList): [optional] Optional parameters

    • :body (SaveCapacityGroupRequest):

Returns

{:ok, %Voxbone.Model.SaveCapacityGroupResponse{}} on success {:error, info} on failure

Link to this function update_fax_uri(connection, fax_uri_id, opts \\ []) 
update_fax_uri(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.SaveFaxUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to update an existing Fax URI.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • fax_uri_id (integer()): The identifier of the fax uri.

  • opts (KeywordList): [optional] Optional parameters

    • :body (SaveFaxUriRequest):

Returns

{:ok, %Voxbone.Model.SaveFaxUriResponse{}} on success {:error, info} on failure

Link to this function update_sms_link(connection, sms_link_id, opts \\ []) 
update_sms_link(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.SaveSmsLinkResponse.t()} | {:error, Tesla.Env.t()}

Allows you to update an existing SMS Link.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • sms_link_id (integer()): The identifier of the existing SMS Link

  • opts (KeywordList): [optional] Optional parameters

    • :body (SaveSmsLinkRequest):

Returns

{:ok, %Voxbone.Model.SaveSmsLinkResponse{}} on success {:error, info} on failure

Link to this function update_voice_uri(connection, voice_uri_id, opts \\ []) 
update_voice_uri(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Voxbone.Model.SaveVoiceUriResponse.t()} | {:error, Tesla.Env.t()}

Allows you to update an existing Voice URI.

Parameters

  • connection (Voxbone.Connection): Connection to server
  • voice_uri_id (integer()): The identifier of the voice uri.

  • opts (KeywordList): [optional] Optional parameters

    • :body (SaveVoiceUriRequest):

Returns

{:ok, %Voxbone.Model.SaveVoiceUriResponse{}} on success {:error, info} on failure