Package io.github.signalwirecommunity.repository

Class SipRepository

java.lang.Object

io.github.signalwirecommunity.repository.SipRepository

public class SipRepository
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SipRepository(java.lang.String projectId, java.lang.String apiToken, java.lang.String spaceName)

Method Summary

Modifier and Type	Method	Description
SipResponse.Sip	create(java.lang.String username, java.lang.String password, java.lang.String caller_id, java.lang.String send_as, java.util.List<java.lang.String> ciphers, java.util.List<java.lang.String> codecs, java.lang.String encryption)	To create a new SIP Endpoint, you send a POST request to the SIP Endpoint resource.
SuccessResponse	delete(java.lang.String id)	Permanently deletes a SIP Endpoint.
SipResponse.Sip	get(java.lang.String id)	Retrieves the details of a SIP Endpoint that has been previously created.
SipResponse	list()	Returns a list of your SIP Endpoints.
SipResponse.Sip	update(java.lang.String id, java.lang.String username, java.lang.String password, java.lang.String caller_id, java.lang.String send_as, java.util.List<java.lang.String> ciphers, java.util.List<java.lang.String> codecs, java.lang.String encryption)	Updates the specific SIP Endpoint by setting the values of any parameters passed in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SipRepository

public SipRepository(java.lang.String projectId,
                     java.lang.String apiToken,
                     java.lang.String spaceName)

Method Detail

list

public SipResponse list()

Returns a list of your SIP Endpoints. The endpoints are returned sorted by creation date, with the most recent endpoints appearing first. The list is filterable by sending in any of the following parameters.

Returns:

SipResponse

create

public SipResponse.Sip create(java.lang.String username,
                              java.lang.String password,
                              java.lang.String caller_id,
                              java.lang.String send_as,
                              java.util.List<java.lang.String> ciphers,
                              java.util.List<java.lang.String> codecs,
                              java.lang.String encryption)
                       throws SignalWireException

To create a new SIP Endpoint, you send a POST request to the SIP Endpoint resource.

Parameters:

username - Username of the SIP endpoint

password - password of the SIP profile

caller_id - caller id of the SIP profile

send_as - Value to send as

ciphers - list of ciphers while creating the SIP

codecs - list of codecs needed while creating the SIP

encryption - Encryption of your

Returns:

Sip

Throws:

SignalWireException

get

public SipResponse.Sip get(java.lang.String id)

Retrieves the details of a SIP Endpoint that has been previously created. Use the unique ID that was returned from your previous request to identify the specific SIP Endpoint.

Parameters:

id - unique ID of the SIP

Returns:

Sip

update

public SipResponse.Sip update(java.lang.String id,
                              java.lang.String username,
                              java.lang.String password,
                              java.lang.String caller_id,
                              java.lang.String send_as,
                              java.util.List<java.lang.String> ciphers,
                              java.util.List<java.lang.String> codecs,
                              java.lang.String encryption)
                       throws SignalWireException

Updates the specific SIP Endpoint by setting the values of any parameters passed in. Any parameters not provided will be unchanged.

Parameters:

id - unique id of the SIP endpoint

username - Username of the SIP endpoint

password - password of the SIP profile

caller_id - caller id of the SIP profile

send_as - Value to send as

ciphers - list of ciphers while creating the SIP

codecs - list of codecs needed while creating the SIP

encryption - Encryption of your

Returns:

Sip

Throws:

SignalWireException

delete

public SuccessResponse delete(java.lang.String id)

Permanently deletes a SIP Endpoint. It cannot be undone. Will reject any audio or video from currently registered devices and deregister any connections.

Parameters:

id - unique id of the SIP

Returns:

SuccessResponse