net.nurigo.java_sdk.api.SenderID Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaSDK Show documentation
Coolsms Java SDK using Rest API.
There is a newer version: 2.2
package net.nurigo.java_sdk.api;

import java.util.HashMap;

import net.nurigo.java_sdk.Coolsms;
import net.nurigo.java_sdk.exceptions.CoolsmsException;
import net.nurigo.java_sdk.exceptions.CoolsmsSDKException;

import org.json.simple.JSONObject;

/**
 * @class SenderID
 * @brief management sender id, using Rest API
 */
public class SenderID extends Coolsms {
  /**
   * @brief constructor
   * @throws CoolsmsException
   */
  public SenderID(String apiKey, String apiSecret) throws CoolsmsException {
    super(apiKey, apiSecret);

    // set API and version
    setApiConfig("senderid", "1.1");
  }

  /**
   * @brief sender id registration request ( HTTP Method POST )
   * @param hashmap params {
   * @param string phone [required]
   * @param string site_user [optional] }
   * @return JSONObject
   * @throws CoolsmsException
   */
  public JSONObject register(HashMap params) throws CoolsmsException {
    if (!checkString(params.get("phone")))
      throw new CoolsmsSDKException("phone number is required", 202);

    return sendPostRequest("register", params);
  }

  /**
   * @brief verify sender id ( HTTP Method POST )
   * @param string handleKey [required]
   * @return None
   * @throws CoolsmsException
   */
  public JSONObject verify(String handleKey) throws CoolsmsException {
    if (!checkString(handleKey))
      throw new CoolsmsSDKException("handle_key is required", 202);

    HashMap params = new HashMap();
    params.put("handle_key", handleKey);

    return sendPostRequest("verify", params);
  }

  /**
   * @brief delete sender id ( HTTP Method POST )
   * @param string handleKey [required]
   * @return None
   * @throws CoolsmsException
   */
  public JSONObject delete(String handleKey) throws CoolsmsException {
    if (!checkString(handleKey))
      throw new CoolsmsSDKException("handle_key is required", 202);

    HashMap params = new HashMap();
    params.put("handle_key", handleKey);

    return sendPostRequest("delete", params);
  }

  /**
   * @brief get sender id list ( HTTP Method GET )
   * @param hashmap params {
   * @param string site_user [optional]
   * @return JSONObject
   * @throws CoolsmsException
   */
  public JSONObject getSenderidList(HashMap params) throws CoolsmsException {
    return sendGetRequest("list", params);
  }

  /**
   * @brief set default sender id ( HTTP Method POST )
   * @param hashmap params {
   * @param string handle_key [required]
   * @param string site_user [optional] }
   * @return None
   * @throws CoolsmsException
   */
  public JSONObject setDefault(HashMap params) throws CoolsmsException {
    if (!checkString(params.get("handle_key")))
      throw new CoolsmsSDKException("handle_key is required", 202);

    return sendPostRequest("set_default", params);
  }

  /**
   * @brief get default sender id ( HTTP Method GET )
   * @param hashmap params {
   * @param string site_user [optional]
   * @return JSONObject
   * @throws CoolsmsException
   */
  public JSONObject getDefault(HashMap params) throws CoolsmsException {
    return sendGetRequest("get_default", params);
  }
}