SMS Wiki - New pages [en]

CSharp JSON Example

2018-02-10T00:01:39Z

Bzurkovic: Created page with "Below is sample code for C#. You are welcome to cut+paste this sample into your application, however, keep in mind that depending on your environment, some changes may be requ..."

Below is sample code for C#. You are welcome to cut+paste this sample into your application, however, keep in mind that depending on your environment, some changes may be required.

Note: In order to run this sample, you need to reference System.Web.Extensions
<source lang="csharp">
using System;
using System.Collections.Generic;
using System.Text;
using System.Net;
using System.IO;
using System.Web.Script.Serialization;
using System.Xml;
using System.Xml.Serialization;

namespace TestUpsideRESTAPIJSON
{
class Program
{
const string APIEndPoint = "https://secureapi.upsidewireless.com"; // or "http://api.upsidewireless.com"
const string APICredential_Token = "xxxxxxxx-8e4b-405b-998c-a580bf593b76";
const string APICredential_Signature = "xxxxxxxxfyqQx95Gxxxxxxxx";

private static readonly string SMSMessageUrl = string.Format("{0}/RESTv1/{1}/Message", APIEndPoint, APICredential_Token);

static void Main(string[] args)
{
bool acceptJSON = false;

Console.WriteLine("SMS Message URL: " + SMSMessageUrl + "\n");

var request = WebRequest.Create(SMSMessageUrl) as HttpWebRequest;
request.Method = "POST";
request.ContentType = "application/json";
request.Accept = acceptJSON ? "application/json" : "application/xml";
request.UserAgent = "UpsideCSharpAgent";
// use default timeout
//request.Timeout = 100 * 1000; // in miliseconds
//request.ReadWriteTimeout = 300 * 1000; // in miliseconds

string type = "sms"; // see type list on wiki
string message = "test sms message";
string recipient = "16047891236"; // number in E.164 format
string encoding = "7"; // 7, 8 or 16

var jsonObject = "{signature:\"" + APICredential_Signature + "\"";
jsonObject += ",type:\"" + type + "\"";
jsonObject += ",message:\"" + message + "\"";
jsonObject += ",recipient:\"" + recipient + "\"";
jsonObject += ",encoding:\"" + encoding + "\"}";

Console.WriteLine("Post Data: " + jsonObject + "\n");
var data = Encoding.UTF8.GetBytes(jsonObject);
request.ContentLength = data.Length;

try
{
using (var stream = request.GetRequestStream())
{
stream.Write(data, 0, data.Length);

HttpWebResponse response;
try
{
response = request.GetResponse() as HttpWebResponse;
}
catch (WebException ex)
{
response = ex.Response as HttpWebResponse;
}

var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();

Console.WriteLine("HTTP Response: " + responseString + "\n");
RestResponse restResponse = null;
if (acceptJSON)
{
JavaScriptSerializer JSS = new JavaScriptSerializer();
restResponse = JSS.Deserialize<RestResponse>(responseString);
}
else
{
var sreader = new StringReader(responseString);
var xmlreader = new XmlTextReader(sreader);
XmlSerializer serializer = new XmlSerializer(typeof(RestResponse));
restResponse = serializer.Deserialize(xmlreader) as RestResponse;
}

if (restResponse != null)
{
Console.WriteLine("Rest Response - HasException: " + restResponse.HasException);
Console.WriteLine("Rest Response - Token: " + restResponse.Token);
if (restResponse.HasException)
{
Console.WriteLine("Rest Response - RestException.ErrorCode: " + restResponse.RestException.ErrorCode);
Console.WriteLine("Rest Response - RestException.Message: " + restResponse.RestException.Message);
if (restResponse.RestException.Status != null)
Console.WriteLine("Rest Response - RestException.Status: " + restResponse.RestException.Status);
}
else
{
Console.WriteLine("Rest Response - SMSMessage.Status: " + restResponse.SMSMessage.Status);
Console.WriteLine("Rest Response - SMSMessage.Recipient: " + restResponse.SMSMessage.Recipient);
Console.WriteLine("Rest Response - SMSMessage.Body: " + restResponse.SMSMessage.Body);
Console.WriteLine("Rest Response - SMSMessage.Type: " + restResponse.SMSMessage.Type);
Console.WriteLine("Rest Response - SMSMessage.TrackingId: " + restResponse.SMSMessage.TrackingId);
if (restResponse.SMSMessage.Status == "REJECTED")
Console.WriteLine("Rest Response - SMSMessage.RejectReason: " + restResponse.SMSMessage.RejectReason);
}
}
else
{
Console.WriteLine("Can't get rest response object");
}
}
}
catch (Exception e)
{
Console.WriteLine("Error in calling REST API - " + e.Message);
}

Console.ReadKey();
}

}

public class RestResponse
{
public bool HasException { get; set; }
public string Token { get; set; }

public SMSMessage SMSMessage { get; set; }

public RestException RestException { get; set; }
}

public class SMSMessage
{
public string Status { get; set; }

public string Recipient { get; set; }
public string Body { get; set; }
public string Type { get; set; }
public string TrackingId { get; set; }
public string RejectReason { get; set; }
}

public class RestException
{
public int ErrorCode { get; set; }
public string Message { get; set; }

public string Status { get; set; }
}

}

Java JSON Example

2018-02-09T23:57:27Z

Bzurkovic:

Below is sample code for Java programmers. You are welcome to cut+paste this sample into your application, however, keep in mind that depending on your environment, some changes may be required.

Note: In order to run this sample, you need include MOXy library, as well as JAXB if no built-in JAXB in your JDK

<source lang="java">

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.StringReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.transform.stream.StreamSource;

import org.eclipse.persistence.jaxb.JAXBContextProperties;
import org.eclipse.persistence.jaxb.xmlmodel.ObjectFactory;

public class TestUpsideRESTAPIJSON {

public static final String APIEndPoint = "https://secureapi.upsidewireless.com"; // or "http://api.upsidewireless.com"
public static final String APICredential_Token ="xxxxxxxx-8e4b-405b-998c-a580bf593b76";
public static final String APICredential_Signature = "xxxxxxxxfyqQx95Gxxxxxxxx";

private static String SMSMsgUrl = String.format("%s/RESTv1/%s/Message", APIEndPoint, APICredential_Token);

public static void main(String[] argv) throws Exception {
HttpURLConnection connection = null;
boolean acceptJSON = true;

System.out.println("SMS Message URL: " + SMSMsgUrl);

try {
URL smsMessageUrl = new URL(SMSMsgUrl);
connection = (HttpURLConnection)smsMessageUrl.openConnection();

connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", acceptJSON ? "application/json" : "application/xml");
connection.setRequestProperty("User-Agent", "UpsideJavaAgent");
connection.setConnectTimeout(100 * 1000); // 100 seconds
connection.setReadTimeout(300 * 1000); // 300 seconds
connection.setDoOutput(true);

String type = "sms"; // see type list on wiki
String message = "test sms message";
String recipient = "16047891236"; // number in E.164 format
String encoding = "7"; // 7, 8 or 16

String jsonObject = "{signature:\"" + APICredential_Signature + "\"";
jsonObject += ",type:\"" + type + "\"";
jsonObject += ",message:\"" + message + "\"";
jsonObject += ",recipient:\"" + recipient + "\"";
jsonObject += ",encoding:\"" + encoding + "\"}";

PrintWriter pw = new PrintWriter(connection.getOutputStream());
pw.println(jsonObject);
pw.close();

InputStream input = null;
try {
input = connection.getInputStream();
} catch (Exception e) {
input = connection.getErrorStream();
}
StringBuffer sbResponse = new StringBuffer(1024);
BufferedReader reader = new BufferedReader(new InputStreamReader(input));
String inputLine = null;
while ((inputLine = reader.readLine()) != null) {
sbResponse.append(inputLine);
}
reader.close();

String responseString = sbResponse.toString();
System.out.println("REST Response: " + responseString);

RestResponse restResponse = null;
if (acceptJSON) {
Map<String, Object> properties = new HashMap<String, Object>(2);
properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);
JAXBContext jaxbContext = JAXBContext.newInstance(new Class[] {RestResponse.class, ObjectFactory.class}, properties);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
StringReader sr = new StringReader(responseString);
StreamSource json = new StreamSource(sr);
restResponse = unmarshaller.unmarshal(json, RestResponse.class).getValue();

// or use your favourite method to parse JSON object
} else {
JAXBContext jaxbContext = JAXBContext.newInstance(RestResponse.class);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
StringReader sr = new StringReader(responseString);
restResponse = (RestResponse) unmarshaller.unmarshal(sr);

// or use your favourite method to parse XML object
}

if (restResponse != null)
{
System.out.println("Rest Response - HasException: " + restResponse.isHasException());
System.out.println("Rest Response - Token: " + restResponse.getToken());
if (restResponse.isHasException())
{
System.out.println("Rest Response - RestException.ErrorCode: " + restResponse.getRestException().getErrorCode());
System.out.println("Rest Response - RestException.Message: " + restResponse.getRestException().getMessage());
if (restResponse.getRestException().getStatus() != null)
System.out.println("Rest Response - RestException.Status: " + restResponse.getRestException().getStatus());
}
else
{
System.out.println("Rest Response - SMSMessage.Status: " + restResponse.getSMSMessage().getStatus());
System.out.println("Rest Response - SMSMessage.Recipient: " + restResponse.getSMSMessage().getRecipient());
System.out.println("Rest Response - SMSMessage.Body: " + restResponse.getSMSMessage().getBody());
System.out.println("Rest Response - SMSMessage.Type: " + restResponse.getSMSMessage().getType());
System.out.println("Rest Response - SMSMessage.TrackingId: " + restResponse.getSMSMessage().getTrackingId());
if ("REJECTED".equals(restResponse.getSMSMessage().getStatus()))
System.out.println("Rest Response - SMSMessage.RejectReason: " + restResponse.getSMSMessage().getRejectReason());
}
}
else
{
System.out.println("Can't get rest response object");
}

} catch (Exception e) {
System.out.println("Error in calling API - " + e.getMessage());
e.printStackTrace();
} finally {
if (connection != null) {
connection.disconnect();
}
}
}
}

@XmlRootElement(name="RestResponse")
@XmlAccessorType(XmlAccessType.FIELD)
class RestResponse
{
@XmlElement(name = "HasException")
private boolean HasException;
@XmlElement(name = "Token")
private String Token;

@XmlElement(name = "SMSMessage")
private SMSMessage SMSMessage;
@XmlElement(name = "RestException")
private RestException RestException;

public boolean isHasException() {
return HasException;
}

public void setHasException(boolean hasException) {
HasException = hasException;
}

public String getToken() {
return Token;
}

public void setToken(String token) {
Token = token;
}

public SMSMessage getSMSMessage() {
return SMSMessage;
}

public void setSMSMessage(SMSMessage sMSMessage) {
SMSMessage = sMSMessage;
}

public RestException getRestException() {
return RestException;
}

public void setRestException(RestException restException) {
RestException = restException;
}
}

@XmlAccessorType(XmlAccessType.FIELD)
class SMSMessage
{
@XmlElement(name = "Status")
private String Status;
@XmlElement(name = "Recipient")
private String Recipient;
@XmlElement(name = "Body")
private String Body;
@XmlElement(name = "Type")
private String Type;
@XmlElement(name = "TrackingId")
private String TrackingId;
@XmlElement(name = "RejectReason")
private String RejectReason;

public String getStatus() {
return Status;
}

public void setStatus(String status) {
Status = status;
}

public String getRecipient() {
return Recipient;
}

public void setRecipient(String recipient) {
Recipient = recipient;
}

public String getBody() {
return Body;
}

public void setBody(String body) {
Body = body;
}

public String getType() {
return Type;
}

public void setType(String type) {
Type = type;
}

public String getTrackingId() {
return TrackingId;
}

public void setTrackingId(String trackingId) {
TrackingId = trackingId;
}

public String getRejectReason() {
return RejectReason;
}

public void setRejectReason(String rejectReason) {
RejectReason = rejectReason;
}

}

@XmlAccessorType(XmlAccessType.FIELD)
class RestException
{
@XmlElement(name = "ErrorCode")
private int ErrorCode;
@XmlElement(name = "Message")
private String Message;
@XmlElement(name = "Status")
private String Status;

public int getErrorCode() {
return ErrorCode;
}

public void setErrorCode(int errorCode) {
ErrorCode = errorCode;
}

public String getMessage() {
return Message;
}

public void setMessage(String message) {
Message = message;
}

public String getStatus() {
return Status;
}

public void setStatus(String status) {
Status = status;
}
}

CSharp Example

2015-02-04T20:35:53Z

Below is sample code for C#. You are welcome to cut+paste this sample into your application, however, keep in mind that depending on your environment, some changes may be required.

Note: In order to run this sample, you need to reference System.Web.Extensions
<source lang="csharp">

using System;
using System.Collections.Generic;
using System.Text;
using System.Net;
using System.IO;
using System.Web.Script.Serialization;
using System.Xml;
using System.Xml.Serialization;

namespace TestUpsideRESTAPI
{
class Program
{
const string APIEndPoint = "https://secureapi.upsidewireless.com"; // or "http://api.upsidewireless.com"
const string APICredential_Token = "xxxxxxxx-8e4b-405b-998c-a580bf593b76";
const string APICredential_Signature = "xxxxxxxxfyqQx95Gxxxxxxxx";

private static readonly string SMSMessageUrl = string.Format("{0}/RESTv1/{1}/Message", APIEndPoint, APICredential_Token);

static void Main(string[] args)
{
bool acceptJSON = false;

Console.WriteLine("SMS Message URL: " + SMSMessageUrl + "\n");

var request = WebRequest.Create(SMSMessageUrl) as HttpWebRequest;
request.Method = "POST";
request.ContentType = "application/x-www-form-urlencoded";
request.Accept = acceptJSON ? "application/json" : "application/xml";
request.UserAgent = "UpsideCSharpAgent";
// use default timeout
//request.Timeout = 100 * 1000; // in miliseconds
//request.ReadWriteTimeout = 300 * 1000; // in miliseconds

var smsPostData = "signature={0}";
smsPostData += "&type={1}";
smsPostData += "&message={2}";
smsPostData += "&recipient={3}";
smsPostData += "&encoding={4}";

string type = "sms"; // see type list on wiki
string message = "test sms message";
string recipient = "16047891236"; // number in E.164 format
string encoding = "7"; // 7, 8 or 16

smsPostData = string.Format(smsPostData, APICredential_Signature, type, message, recipient, encoding);
Console.WriteLine("Post Data: " + smsPostData + "\n");
var data = Encoding.UTF8.GetBytes(smsPostData);
request.ContentLength = data.Length;

try
{
using (var stream = request.GetRequestStream())
{
stream.Write(data, 0, data.Length);

HttpWebResponse response;
try
{
response = request.GetResponse() as HttpWebResponse;
}
catch (WebException ex)
{
response = ex.Response as HttpWebResponse;
}

var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();

Console.WriteLine("HTTP Response: " + responseString + "\n");
RestResponse restResponse = null;
if (acceptJSON)
{
JavaScriptSerializer JSS = new JavaScriptSerializer();
restResponse = JSS.Deserialize<RestResponse>(responseString);
}
else
{
var sreader = new StringReader(responseString);
var xmlreader = new XmlTextReader(sreader);
XmlSerializer serializer = new XmlSerializer(typeof(RestResponse));
restResponse = serializer.Deserialize(xmlreader) as RestResponse;
}

if (restResponse != null)
{
Console.WriteLine("Rest Response - HasException: " + restResponse.HasException);
Console.WriteLine("Rest Response - Token: " + restResponse.Token);
if (restResponse.HasException)
{
Console.WriteLine("Rest Response - RestException.ErrorCode: " + restResponse.RestException.ErrorCode);
Console.WriteLine("Rest Response - RestException.Message: " + restResponse.RestException.Message);
if (restResponse.RestException.Status != null)
Console.WriteLine("Rest Response - RestException.Status: " + restResponse.RestException.Status);
}
else
{
Console.WriteLine("Rest Response - SMSMessage.Status: " + restResponse.SMSMessage.Status);
Console.WriteLine("Rest Response - SMSMessage.Recipient: " + restResponse.SMSMessage.Recipient);
Console.WriteLine("Rest Response - SMSMessage.Body: " + restResponse.SMSMessage.Body);
Console.WriteLine("Rest Response - SMSMessage.Type: " + restResponse.SMSMessage.Type);
Console.WriteLine("Rest Response - SMSMessage.TrackingId: " + restResponse.SMSMessage.TrackingId);
if (restResponse.SMSMessage.Status == "REJECTED")
Console.WriteLine("Rest Response - SMSMessage.RejectReason: " + restResponse.SMSMessage.RejectReason);
}
}
else
{
Console.WriteLine("Can't get rest response object");
}
}
}
catch (Exception e)
{
Console.WriteLine("Error in calling REST API - " + e.Message);
}

Console.ReadKey();
}

}

public class RestResponse
{
public bool HasException { get; set; }
public string Token { get; set; }

public SMSMessage SMSMessage { get; set; }

public RestException RestException { get; set; }
}

public class SMSMessage
{
public string Status { get; set; }

public string Recipient { get; set; }
public string Body { get; set; }
public string Type { get; set; }
public string TrackingId { get; set; }
public string RejectReason { get; set; }
}

public class RestException
{
public int ErrorCode { get; set; }
public string Message { get; set; }

public string Status { get; set; }
}

}

Java Example

2015-02-03T01:01:48Z

Bzurkovic:

Below is sample code for Java programmers. You are welcome to cut+paste this sample into your application, however, keep in mind that depending on your environment, some changes may be required.

Note: In order to run this sample, you need include MOXy library, as well as JAXB if no built-in JAXB in your JDK

<source lang="java">
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.StringReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.transform.stream.StreamSource;
import org.eclipse.persistence.jaxb.JAXBContextProperties;
import org.eclipse.persistence.jaxb.xmlmodel.ObjectFactory;

public class TestUpsideRESTAPI {

public static final String APIEndPoint = "https://secureapi.upsidewireless.com"; // or "http://api.upsidewireless.com"
public static final String APICredential_Token ="xxxxxxxx-8e4b-405b-998c-a580bf593b76";
public static final String APICredential_Signature = "xxxxxxxxfyqQx95Gxxxxxxxx";

private static String SMSMessageUrl = String.format("%s/RESTv1/%s/Message", APIEndPoint, APICredential_Token);

public static void main(String[] argv) throws Exception {
HttpURLConnection connection = null;
boolean acceptJSON = false;

System.out.println("SMS Message URL: " + SMSMessageUrl + "\n");

try {
URL smsMessageUrl = new URL(SMSMessageUrl);
connection = (HttpURLConnection)smsMessageUrl.openConnection();

connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
connection.setRequestProperty("Accept", acceptJSON ? "application/json" : "application/xml");
connection.setRequestProperty("User-Agent", "UpsideJavaAgent");
connection.setConnectTimeout(100 * 1000); // 100 seconds
connection.setReadTimeout(300 * 1000); // 300 seconds
connection.setDoOutput(true);

String smsPostData = "signature=%s";
smsPostData += "&type=%s";
smsPostData += "&message=%s";
smsPostData += "&recipient=%s";
smsPostData += "&encoding=%s";

String type = "sms"; // see type list on wiki
String message = "test sms message";
String recipient = "16047891236"; // number in E.164 format
String encoding = "7"; // 7, 8 or 16

message = URLEncoder.encode(message, "UTF-8");
smsPostData = String.format(smsPostData, APICredential_Signature, type, message, recipient, encoding);
System.out.println("Post Data: " + smsPostData + "\n");

PrintWriter pw = new PrintWriter(connection.getOutputStream());
pw.println(smsPostData);
pw.close();

InputStream input = null;
try {
input = connection.getInputStream();
} catch (Exception e) {
input = connection.getErrorStream();
}
StringBuffer sbResponse = new StringBuffer(1024);
BufferedReader reader = new BufferedReader(new InputStreamReader(input));
String inputLine = null;
while ((inputLine = reader.readLine()) != null) {
sbResponse.append(inputLine);
}
reader.close();

String responseString = sbResponse.toString();
System.out.println("HTTP Response: " + responseString + "\n");

RestResponse restResponse = null;
if (acceptJSON) {
Map<String, Object> properties = new HashMap<String, Object>(2);
properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);
JAXBContext jaxbContext = JAXBContext.newInstance(new Class[] {RestResponse.class, ObjectFactory.class}, properties);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
StringReader sr = new StringReader(responseString);
StreamSource json = new StreamSource(sr);
restResponse = unmarshaller.unmarshal(json, RestResponse.class).getValue();

// or use your favourite method to parse JSON object
} else {
JAXBContext jaxbContext = JAXBContext.newInstance(RestResponse.class);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
StringReader sr = new StringReader(responseString);
restResponse = (RestResponse) unmarshaller.unmarshal(sr);

// or use your favourite method to parse XML object
}

if (restResponse != null)
{
System.out.println("Rest Response - HasException: " + restResponse.isHasException());
System.out.println("Rest Response - Token: " + restResponse.getToken());
if (restResponse.isHasException())
{
System.out.println("Rest Response - RestException.ErrorCode: " + restResponse.getRestException().getErrorCode());
System.out.println("Rest Response - RestException.Message: " + restResponse.getRestException().getMessage());
if (restResponse.getRestException().getStatus() != null)
System.out.println("Rest Response - RestException.Status: " + restResponse.getRestException().getStatus());
}
else
{
System.out.println("Rest Response - SMSMessage.Status: " + restResponse.getSMSMessage().getStatus());
System.out.println("Rest Response - SMSMessage.Recipient: " + restResponse.getSMSMessage().getRecipient());
System.out.println("Rest Response - SMSMessage.Body: " + restResponse.getSMSMessage().getBody());
System.out.println("Rest Response - SMSMessage.Type: " + restResponse.getSMSMessage().getType());
System.out.println("Rest Response - SMSMessage.TrackingId: " + restResponse.getSMSMessage().getTrackingId());
if ("REJECTED".equals(restResponse.getSMSMessage().getStatus()))
System.out.println("Rest Response - SMSMessage.RejectReason: " + restResponse.getSMSMessage().getRejectReason());
}
}
else
{
System.out.println("Can't get rest response object");
}

} catch (Exception e) {
System.out.println("Error in calling REST API - " + e.getMessage());
e.printStackTrace();
} finally {
if (connection != null) {
connection.disconnect();
}
}
}
}

@XmlRootElement(name="RestResponse")
@XmlAccessorType(XmlAccessType.FIELD)
class RestResponse
{
@XmlElement(name = "HasException")
private boolean HasException;
@XmlElement(name = "Token")
private String Token;

@XmlElement(name = "SMSMessage")
private SMSMessage SMSMessage;
@XmlElement(name = "RestException")
private RestException RestException;

public boolean isHasException() {
return HasException;
}

public void setHasException(boolean hasException) {
HasException = hasException;
}

public String getToken() {
return Token;
}

public void setToken(String token) {
Token = token;
}

public SMSMessage getSMSMessage() {
return SMSMessage;
}

public void setSMSMessage(SMSMessage sMSMessage) {
SMSMessage = sMSMessage;
}

public RestException getRestException() {
return RestException;
}

public void setRestException(RestException restException) {
RestException = restException;
}
}

@XmlAccessorType(XmlAccessType.FIELD)
class SMSMessage
{
@XmlElement(name = "Status")
private String Status;
@XmlElement(name = "Recipient")
private String Recipient;
@XmlElement(name = "Body")
private String Body;
@XmlElement(name = "Type")
private String Type;
@XmlElement(name = "TrackingId")
private String TrackingId;
@XmlElement(name = "RejectReason")
private String RejectReason;

public String getStatus() {
return Status;
}

public void setStatus(String status) {
Status = status;
}

public String getRecipient() {
return Recipient;
}

public void setRecipient(String recipient) {
Recipient = recipient;
}

public String getBody() {
return Body;
}

public void setBody(String body) {
Body = body;
}

public String getType() {
return Type;
}

public void setType(String type) {
Type = type;
}

public String getTrackingId() {
return TrackingId;
}

public void setTrackingId(String trackingId) {
TrackingId = trackingId;
}

public String getRejectReason() {
return RejectReason;
}

public void setRejectReason(String rejectReason) {
RejectReason = rejectReason;
}

}

@XmlAccessorType(XmlAccessType.FIELD)
class RestException
{
@XmlElement(name = "ErrorCode")
private int ErrorCode;
@XmlElement(name = "Message")
private String Message;
@XmlElement(name = "Status")
private String Status;

public int getErrorCode() {
return ErrorCode;
}

public void setErrorCode(int errorCode) {
ErrorCode = errorCode;
}

public String getMessage() {
return Message;
}

public void setMessage(String message) {
Message = message;
}

public String getStatus() {
return Status;
}

public void setStatus(String status) {
Status = status;
}
}

Send REST

2015-02-03T00:55:43Z

Bzurkovic: /* Examples */

'''Upsidewireless REST API '''

There are two endpoints of Upsidewireless REST API, [https://secureapi.upsidewireless.com https://secureapi.upsidewireless.com] and [http://api.upsidewireless.com http://api.upsidewireless.com]. If you care about more security than performance, you should use the secure endpoint. However, in this case you will need to install certificate for secure, authenticated communication. We recommend you select the secure option.

In order to use Upsidewireless REST API, you need have an account that has API permissions and get your API credential (token and signature) on your account page. Token is similar to username and signature is similar to password. They are needed in every single call to REST API.

There are two kinds of response of each API call, JSON or XML. You can either use HTTP header ("Accept") or a special HTTP parameter ("responsetype") to specify what kind of response you want. If you want using HTTP header, set either "application/json" or "application/xml" in Accept header. If you want using HTTP parameter, set either "JSON" or "XML" to responsetype parameter. If no response type specified, default response will always be in XML format. Use HTTP header is a highly recommended way to do so.

'''1. SMS Message API'''

'''API URI: /RESTv1/{token}/Message'''

'''Support method: HTTP POST '''

The following parameters are all '''required''' in your POST to send the message:

{|
|'''Parameter'''||'''Description'''
|-
|signature||One of the API credential, similar to a password. It can be found in your account page.
|-
|type||The message type. Different type requires a different set of additional parameters.
|-
|message||The text of the message you want to send. For some types, this message must be pre-encoded
|-
|}
According to different type, a different set of additional parameters is required

'''Additional parameters for type: "sms_test''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|}
'''Additional parameter for type: "sms''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|}
'''Additional parameters for type: "mms''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|mediaUrl||The URL of the media you wish to send out with the message. gif , png and jpeg content is currently supported. The media size limit is 5MB. If you wish to send more than one image in the message, please provide multiple URLs separated by comma in this parameter.
|-
|}

'''Additional parameter for type: "sms_port''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|port||Port number – valid value is > 0 and < 65535, parameter message must be pre-encoded.
|-
|}

'''Additional parameters for type: "sms_multi''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212. This parameter can include multiple phone numbers, separated by comma.
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|}

'''Additional parameters for type: "sms_group''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|groupName||The name of contact group in your account
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|}

'''Additional parameters for type: "sms_service_group''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|serviceName||The name of your PSMS service
|-
|groupName||The contact group name of your PSMS service
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|}

'''Additional parameters for type: "sms_dedicated''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|carrierCode||The carrier code that recipient phone number belongs to. This parameter is mandatory if dedicated number is a short code.
|-
|dedicatedNumber||The dedicated number which will deliver the message. It could be a long code or a short code.
|-
|tariff||The amount that recipient number to be charged
|-
|}

'''Additional parameters for type: "sms_dedicated_port''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|port||Port number – valid value is > 0 and < 65535, parameter message must be pre-encoded.
|-
|carrierCode||The carrier code that recipient phone number belongs to. This parameter is mandatory if dedicated number is a short code.
|-
|dedicatedNumber||The dedicated number which will deliver the message. It could be a long code or a short code.
|-
|tariff||The amount that recipient number to be charged
|-
|}

'''Additional parameters for type: "sms_defer''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|encoding||Message encoding - 7 for GSM 7bit, 8 for Raw 8bit and 16 for Unicode
|-
|DelayHours||The hours to delay.
|-
|DelayMinutes||The minutes to delay
|-
|label||The label of this delayed event
|-
|}

'''Additional parameters for type: "sms_flash''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|||The parameter message must be pre-encoded.
|-
|}

'''Additional parameters for type: "sms_wappush''''''"'''
{|
|'''Parameter'''||'''Description'''
|-
|recipient||The phone number to receive message, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|url||The pre-encoded URL
|-
|}

If no exception in API call, the following response (XML format) will be returned:

<RestResponse>
:<HasException>false</HasException>
:<Token>xxxxxxxx-8e4b-405b-998c-a580bf593b76</Token>
:< SMSMessage>
::<Status>QUEUED or REJECTED</Status>
::< Body>sms message</ Body>
::< Recipient>16047891236</ Recipient>
::<Type>sms</Type>
::<TrackingId>MTID256749777469712848</TrackingId>
::<RejectReason> </RejectReason>
:</ SMSMessage>
</RestResponse>

In SMSMessage, TrackingId and RejectReason are optional. If Status is "QUEUED", for non-multiple recipient type, a unique TrackingId is returned for future query. If Status is "REJECTED", RejectReason includes the reject reason. If type is sms_test, the successful status is "PASSED", not "QUEUED".

Or in JSON format''' '''

{
"HasException": false,
"Token": "xxxxxxxx-8e4b-405b-998c-a580bf593b76",
"SMSMessage": {
"Status": "QUEUED" or "REJECTED",
"Body": "sms message",
"Recipient": "16047891236",
"Type": "sms",
"TrackingId": "MTID256749777469712848",
"RejectReason": "Failure message"
}
}

'''2. SMS Contact API'''

'''API URI: /RESTv1/{token}/Contact'''

'''Support method: HTTP POST '''

The following parameters are '''required''' in your POST to add contact:

{|
|'''Parameter'''||'''Description'''
|-
|signature||One of the API credential, similar to a password. It can be found in your account page.
|-
|mobile||The mobile number to be added as an SMS contact, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212. If mobile number already exists, existing record will be updated.
|-
|}

The following parameters are optional:
{|
|'''Parameter'''||'''Description'''
|-
|type||The mobile type, such as Android, iPhone.
|-
|email||The email of this SMS contact.
|-
|firstname||The given name of this SMS contact
|-
|lastname||The surname of this SMS contact
|-
|address||The living or working address of this SMS contact
|-
|city||The living or working city of this SMS contact
|-
|zipcode||The zipcode of this SMS contact
|-
|landline||The landline of this SMS contact
|-
|title||The title of this SMS contact
|-
|role||The role of this SMS contact
|-
|organization||The organization this SMS contact belongs to
|-
|}

If no exception in API call, the following response (XML format) will be returned:

<RestResponse>
:<HasException>false</HasException>
:<Token>xxxxxxxx-8e4b-405b-998c-a580bf593b76</Token>
:<SMSContact>
::<success>true or false</success>
::<number>16047891236</number>
::<message>Success or failure message</message>
:</SMSContact>
</RestResponse>

Or in JSON format''' '''
{
"HasException": false,
"Token": "xxxxxxxx-8e4b-405b-998c-a580bf593b76",
" SMSContact ": {
"success": true or false,
"number": "16047891236",
"message": "Success or failure message."
}
}

'''3. Number Validation API'''

'''API URI: /RESTv1/{token}/''' '''NumberValidation'''

'''Support method: HTTP POST '''

The following parameters are '''required''' in your POST to do number validation:

{|
|'''Parameter'''||'''Description'''
|-
|signature||One of the API credential, similar to a password. It can be found in your account page.
|-
|type||The validation type. There are three possible types. 1 – "quick" and it will cost 0.1 credits; 2 – "route" and it will cost 0.25 credits; 3 – "hlr" and it will cost 0.5 credits.
|-
|number||The phone number to be validated, in [http://en.wikipedia.org/wiki/E.164 E.164] format, for example 16045551212.
|-
|}

If no exception in API call, the following response (XML format) will be returned:

<RestResponse>

:<HasException>false</HasException>

:<Token>xxxxxxxx-8e4b-405b-998c-a580bf593b76</Token>

:<NumberValidation>

::<success>true or false</success>

::<number>16047891236</number>

::<message>Success or failure message</message>

::<country>Canada</country>

::<network>British Columbia</network>

::<HLRLookupResultObject>

:::<status>OK</status>

:::<number>16047891236</number>

:::<MCC>302</MCC>

:::<MNC>370</MNC>

:::<operatorName>Microcell</operatorName>

:::<operatorCountry>Canada</operatorCountry>

:::<message></message>

::</HLRLookupResultObject>

:</NumberValidation>

</RestResponse>

In NumberValidation, country, network and HLRLookupResultObject are optional, depends on the query type. If type is "quick", only country returned; if type is "route", country and network returned; if type is "hlr", only HLRLookupResultObject returned.

Or in JSON format

{
"HasException": false,
"Token": "xxxxxxxx-8e4b-405b-998c-a580bf593b76",
"NumberValidation": {
"success": true or false,
"number": "16047891236",
"message": "Success or failure message.",
"country": "Canada",
"network": "British Columbia"
"HLRLookupResultObject": {
"status": "OK",
"number": "16047891236",
"MCC": "302",
"MNC": "370",
"operatorName": "Microcell",
"operatorCountry": "Canada",
"message": ""
}
}
}

The entire HLRLookupResultObject is as following:

<HLRLookupResultObject>
:<status></status>
:<number></number>
:<MCC></MCC>
:<MNC></MNC>
:<operatorName></operatorName>
:<operatorCountry></operatorCountry>
:<IMSI></IMSI>
:<MSC></MSC>
:<mscOperator></mscOperator>
:<mscMCC></mscMCC>
:<mscMNC></mscMNC>
:<mscCountry></mscCountry>
:<mscLocation></mscLocation>
:<message></message>
</HLRLookupResultObject>

Only status, number and message are mandatory, others are optional.

'''REST API Exception'''

If there is any exception in REST API call, the HasException flag will be set to true and the following response (XML format) will be returned:

<RestResponse>
:<HasException>true</HasException>
:<Token>xxxxxxxx-8e4b-405b-998c-a580bf593b76</Token>
:<RestException>
::<ErrorCode>101</ErrorCode>
::<Message>Unauthorized</Message>
::<Status>401</Status>
:</RestException>
</RestResponse>

Or in JSON format''' '''

{
"HasException": true,
"Token": "xxxxxxxx-8e4b-405b-998c-a580bf593b76",
"RestException": {
"ErrorCode": "101",
"Message": "Unauthorized",
"Status": "401"
}
}

The Status is HTTP status code and it is optional.

'''ErrorCode and corresponding message:'''

{|
|'''ErrorCode'''||'''Message'''||'''Comments'''
|-
|100||Unsupported method||Wrong HTTP method
|-
|101||Unauthorized||API credential is wrong
|-
|102||No permission||API credential passed, but no permission
|-
|103||Runtime error||Runtime error during API call
|-
|||||
|-
|200||Zero balance||No credits to send a message
|-
|201||Invalid country||Can’t figure out a country with the recipient number
|-
|202||Invalid carrier code||The carrier code is incorrect
|-
|203||Number blocked||The recipient number is blocked by our system
|-
|204||Too many messages||Message is too long
|-
|205||Empty message||Empty message
|-
|206||No time for defer||The delay parameter is wrong
|-
|207||Unknown type||Unknown message type
|-
|208||Unimplemented type||The message type not implemented yet
|-
|||||
|-
|300||Mobile phone number is invalid||Invalid mobile number
|-
|301||Credit is not enough to perform validation. Please purchase more and try again||
|-
|}

----
== '''Examples''' ==

[[Java Example]] | [[CSharp Example]] | [[Java JSON Example]] | [[CSharp JSON Example]]

----