com.nexmo.client.conversion

Class ConversionClient

java.lang.Object

com.nexmo.client.AbstractClient

com.nexmo.client.conversion.ConversionClient

public class ConversionClient
extends AbstractClient

A client for talking to the Nexmo Conversion API. The standard way to obtain an instance of this class is to use NexmoClient.getConversionClient().

Allows you to tell Nexmo about the reliability of your 2FA communications.

More information on method parameters can be found at Nexmo website: https://developer.nexmo.com/messaging/conversion-api/overview

Field Summary

Fields inherited from class com.nexmo.client.AbstractClient

httpWrapper

Constructor Summary

Constructors

Constructor and Description
ConversionClient(HttpWrapper httpWrapper)

Method Summary

Modifier and Type	Method and Description
void	submitConversion(ConversionRequest.Type type, java.lang.String messageId, boolean delivered, java.util.Date timestamp) Submit a request to the Conversion API indicating whether or not a message was delivered.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConversionClient

public ConversionClient(HttpWrapper httpWrapper)

Method Detail

submitConversion

public void submitConversion(ConversionRequest.Type type,
                             java.lang.String messageId,
                             boolean delivered,
                             java.util.Date timestamp)
                      throws NexmoResponseParseException,
                             NexmoClientException

Submit a request to the Conversion API indicating whether or not a message was delivered.

Parameters:

type - The ConversionRequest.Type type of com.nexmo.client.conversion.

messageId - The id of the message that was sent.

delivered - A boolean indicating whether or not it was delivered.

timestamp - A timestamp of when it was known to be delivered.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

NexmoResponseParseException - if the response from the API could not be parsed.