com.nexmo.client.voice.endpoints

Class CallsEndpoint

java.lang.Object

com.nexmo.client.voice.endpoints.CallsEndpoint

public class CallsEndpoint
extends java.lang.Object

Allows actions to be taken on /calls/* endpoints.

Note: This is an internal object. All functionality is provided publicly by the VoiceClient class.

Constructor Summary

Constructors

Constructor and Description
CallsEndpoint(HttpWrapper httpWrapper) Constructor.

Method Summary

Modifier and Type	Method and Description
CallInfoPage	get(CallsFilter filter) List previous and ongoing calls which match the provided filter.
CallInfo	get(java.lang.String uuid) Get details of a single call, identified by uuid.
CallEvent	post(Call callRequest) Start a call configured by the provided Call object.
ModifyCallResponse	put(java.lang.String uuid, java.lang.String action) Modify an ongoing call.

Methods inherited from class java.lang.Object

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

Constructor Detail

CallsEndpoint

public CallsEndpoint(HttpWrapper httpWrapper)

Constructor.

Parameters:

httpWrapper - (required) shared HTTP wrapper object used for making REST calls.

Method Detail

post

public CallEvent post(Call callRequest)
               throws java.io.IOException,
                      NexmoClientException

Start a call configured by the provided Call object.

Requires a JWTAuthMethod to be provided to the NexmoClient which constructs

Parameters:

callRequest - A Call object configuring the call to be created

Returns:

A CallEvent describing the call that was initiated.

Throws:

java.io.IOException - if an error occurs communicating with the Nexmo API

NexmoClientException - if an error occurs constructing the Nexmo API request or response

get

public CallInfoPage get(CallsFilter filter)
                 throws java.io.IOException,
                        NexmoClientException

List previous and ongoing calls which match the provided filter.

Parameters:

filter - A CallsFilter describing the calls to be searched, or null for all calls.

Returns:

A CallInfoPage containing a single page of CallInfo results

Throws:

java.io.IOException - if an error occurs communicating with the Nexmo API

NexmoClientException - if an error occurs constructing the Nexmo API request or response

get

public CallInfo get(java.lang.String uuid)
             throws java.io.IOException,
                    NexmoClientException

Get details of a single call, identified by uuid.

Parameters:

uuid - The uuid of the CallInfo object to be retrieved

Returns:

A CallInfo object describing the state of the call that was made or is in progress

Throws:

java.io.IOException - if an error occurs communicating with the Nexmo API

NexmoClientException - if an error occurs constructing the Nexmo API request or response

put

public ModifyCallResponse put(java.lang.String uuid,
                              java.lang.String action)
                       throws java.io.IOException,
                              NexmoClientException

Modify an ongoing call.

Currently this method only supports the "hangup" action.

Parameters:

uuid - The uuid of the CallInfo object to be modified

action - The word "hangup"

Returns:

A ModifyCallResponse object describing the state of the call that was modified

Throws:

java.io.IOException - if an error occurs communicating with the Nexmo API

NexmoClientException - if an error occurs constructing the Nexmo API request or response