com.telesign.VoiceClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of TeleSign-SDK Show documentation

The TeleSign Java SDK is a Java library that provides an interface to TeleSign Web Services. TeleSign Web Services conform to the REST Web Service Design Model. Services are exposed as URI-addressable resources through the set of RESTful procedures in our TeleSign REST API.

The newest version!

package com.telesign;

import java.io.IOException;
import java.net.Proxy;
import java.security.GeneralSecurityException;
import java.util.HashMap;
import java.util.Map;

/**
 * TeleSign's Voice API allows you to easily send voice messages. You can send alerts, reminders, and notifications,
 * or you can send verification messages containing time-based, one-time passcodes (TOTP).
 */
public class VoiceClient extends RestClient {

    private static final String VOICE_RESOURCE = "/v1/voice";
    private static final String VOICE_STATUS_RESOURCE = "/v1/voice/%s";

    public VoiceClient(String customerId, String apiKey) {
        super(customerId, apiKey);
    }

    public VoiceClient(String customerId, String apiKey, String restEndpoint) {
        super(customerId, apiKey, restEndpoint);
    }

    public VoiceClient(String customerId,
                       String apiKey,
                       String restEndpoint,
                       Integer connectTimeout,
                       Integer readTimeout,
                       Integer writeTimeout,
                       Proxy proxy,
                       final String proxyUsername,
                       final String proxyPassword) {
        super(customerId, apiKey, restEndpoint, connectTimeout, readTimeout, writeTimeout, proxy, proxyUsername, proxyPassword);
    }

    /**
     * Send a voice call to the target phone_number.
     * 
     * See https://developer.telesign.com/docs/voice-api for detailed API documentation.
     */
    public TelesignResponse call(String phoneNumber, String message, String messageType, Map params) throws IOException, GeneralSecurityException {

        if (params == null) {
            params = new HashMap<>();
        }

        params.put("phone_number", phoneNumber);
        params.put("message", message);
        params.put("message_type", messageType);

        return this.post(VOICE_RESOURCE, params);
    }

    /**
     * Retrieves the current status of the voice call.
     * 
     * See https://developer.telesign.com/docs/voice-api for detailed API documentation.
     */
    public TelesignResponse status(String referenceId, Map params) throws IOException, GeneralSecurityException {

        return this.get(String.format(VOICE_STATUS_RESOURCE, referenceId), params);
    }
}