SMS Wiki - User contributions [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-10T00:00:17Z

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;
}
}

Java JSON Example

2018-02-09T23:57:27Z

Bzurkovic: Java JSON Example

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;
}
}

Send REST

2018-02-09T23:56:50Z

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]]

----

Carrier codes

2016-02-13T01:22:24Z

Bzurkovic:

Carrier codes are needed when sending MT messages to US or Canadian telecom carriers in conjunction with a Short Code. The list below presents currently recognized codes that your application must pass as a parameter when requesting MT using EnterpriseSMS API:

'''Canada'''

* BELL (includes Solo Mobile) = 302651, 302610
* EASTLINK = 302270
* FIDO = 302370
* ROGERS (includes Chatr)= 302720
* MTS = 302655
* MOBILICITY = 302320
* NB TEL = 302701
* QUEBECTEL = 302657
* VIDEOTRON = 302500
* SASK TEL = 302654
* TELUS (includes KOODO) = 302653
* VIRGIN =302001
* WIND MOBILE =302490

'''USA'''
* AT&T = 310980
* Alaska Wireless = 310190
* ALLTEL = 310500
* CINCINNATI BELL = 310420
* CINGULAR = 310180
* CRICKET = 310016
* DOBSON = 310560
* NEXTEL = 316010
* SPRINT = 316110
* TMOBILE USA = 310660
* TESTING = 310014
* VERIZON = 310012

Note: While all effort is made to keep the list up-to-date, changes in telecom ownership may invalidate this list. Please contact us for latest changes.

----
[[APIs | back]]

Send REST

2015-02-04T20:37:17Z

Bzurkovic: /* Examples */

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; }
}

}

Send REST

2015-02-04T20:35:27Z

Bzurkovic:

'''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''' ==

[[C# Example]] | [[Java Example]] | [[CSharp Example]]

----

2013-10-29T19:47:31Z

Bzurkovic:

<source lang="php">

<?php

// NOTE - THE CODE BELOW IS PROVIDED FOR ILLUSTRATION ONLY

//SOME CHANGES MAY BE NEEDED TO GET IT TO WORK IN YOUR PROGRAM

// plug in the values returned from

// http://api.upsidewireless.com/soap/Authentication.asmx/GetParameters

// please note that in order to use this and other examples and EnterpriseSMS

//API your account must have permissions set to do so.

$token = '----------------------------------------';

$signature = '--------------------------------------';

$api_call_data = array(
'token' => $token,
'signature' => $signature,
'recipient' => '+16043434343',
'message' => 'Hello World',
'encoding' => 'Seven' // Use 'Sixteen' if you are sending in Unicode
);

$post_data = build_post_data($api_call_data );

// Please refer to

// http://api.upsidewireless.com/

// for other sending methods

$url = 'http://api.upsidewireless.com/soap/SMS.asmx/Send_Plain';

$xml = do_post_request($url, $post_data);

// be sure you look at the XML from above to see if there are any errors

// Everything below is just function definitions

function do_post_request($url, $data, $optional_headers = null)
{
$params = array('http' => array('method' => 'POST', 'content' => $data));

if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}

$ctx = stream_context_create($params);

$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problem with $url, $php_errormsg");
}

$response = @stream_get_contents($fp);

if ($response === false) {
throw new Exception("Problem reading data from $url, $php_errormsg");
}
return $response;
}

function build_post_data($data, $prefix=null, $sep="", $key="") {

$ret = array();

foreach((array)$data as $k => $v) {

$k = urlencode($k);

if(is_int($k) && $prefix != null) {
$k = $prefix.$k;
}

if(!empty($key)) {
$k = $key."[".$k."]";
}

if(is_array($v) || is_object($v)) {
array_push($ret, build_post_data($v,"",$sep,$k));
} else {
array_push($ret,$k."=".urlencode($v));
}
}

if(empty($sep)) {
$sep = ini_get("arg_separator.output");
}

return implode($sep, $ret);
}

?>

</source>

----
[[APIs | back]]

PHP Sending SMS

2013-10-29T19:47:00Z

Bzurkovic:

<source lang="php">

<?php

// NOTE - THE CODE BELOW IS PROVIDED FOR ILLUSTRATION ONLY

//SOME CHANGES MAY BE NEEDED TO GET IT TO WORK IN YOUR PROGRAM

// plug in the values returned from

// http://api.upsidewireless.com/soap/Authentication.asmx/GetParameters

// please note that in order to use this and other examples and EnterpriseSMS

//API your account must have permissions set to do so.

$token = '----------------------------------------';

$signature = '--------------------------------------';

$api_call_data = array(
'token' => $token,
'signature' => $signature,
'recipient' => '+16043434343',
'message' => 'Hello World',
'encoding' => 'Seven' // Use 'Sixteen' if you are sending in Unicode
);

$post_data = build_post_data($api_call_data );

// Please refer to

// http://api.upsidewireless.com/

// for other sending methods

$url = ' http://api.upsidewireless.com/soap/SMS.asmx/Send_Plain ';

$xml = do_post_request($url, $post_data);

// be sure you look at the XML from above to see if there are any errors

// Everything below is just function definitions

function do_post_request($url, $data, $optional_headers = null)
{
$params = array('http' => array('method' => 'POST', 'content' => $data));

if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}

$ctx = stream_context_create($params);

$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problem with $url, $php_errormsg");
}

$response = @stream_get_contents($fp);

if ($response === false) {
throw new Exception("Problem reading data from $url, $php_errormsg");
}
return $response;
}

function build_post_data($data, $prefix=null, $sep="", $key="") {

$ret = array();

foreach((array)$data as $k => $v) {

$k = urlencode($k);

if(is_int($k) && $prefix != null) {
$k = $prefix.$k;
}

if(!empty($key)) {
$k = $key."[".$k."]";
}

if(is_array($v) || is_object($v)) {
array_push($ret, build_post_data($v,"",$sep,$k));
} else {
array_push($ret,$k."=".urlencode($v));
}
}

if(empty($sep)) {
$sep = ini_get("arg_separator.output");
}

return implode($sep, $ret);
}

?>

</source>

----
[[APIs | back]]

PHP Sending SMS

2013-10-29T19:46:11Z

Bzurkovic:

Tips SOAP

2013-10-29T03:40:22Z

Bzurkovic:

This page represents a collection of common issues encountered by our users. If the problem you experienced is not listed below please login to your upsidewireless.com account and click on the Contact Us link to describe the problem. We will be quick to assist.

----

1. I coded my application as per examples but I cannot send text messages. Why?

Assuming that your code IS correct, the most common reasons are:
* Account is not configured to allow you to access EnterpriseSMS API. Login to your upsidewireless.com account and click on the Contact Us link to request access.
* Your upsidewireless.com account has 0 credit balance
* You are entering phone number in invalid format (remember country_code areacode localnumber - as in 12124445555 or 4477322222222)
* Encoding is wrong. Make sure that you use either Seven or Sixteen (not 7, sixteen or anything else). In very, VERY, rare situations you would use Eight (binary SMS)

As a general rule, when you make a successful API call the interface will return something similar to:

[[Image:SendPlainResponse.jpg]]

In your validation routine you can easily parse the received XML block and determine where the problem may be.

----

2. I made a successful API call but the message was not delivered. Why?
* Please ensure that the number is typed correctly and in proper format. For example, if you specify number as 6094928888 the message will go to Malaysia. For the message to go to USA you must add country code in front (as in 16094928888)
* It is possible that the delivery of messages failed. Please login to your upsidewireless.com account and click on the Contact Us link to let our network ops team of the issue

----

3. I used to be able to send messages but now I get an error when I try to make API call. Why?
* Your account password has most likely changed. You must update your Token and Signature to reflect this change.

----

4. Occassionally I get exception when calling one of your functions. What should I do?
* Standard practice is to re-try the attempt after a certain period of time. We recommend that in your code is set to re-try after 10-20s at least once, before aborting the attempt. A further improvement to the exception handling of this type is to create a spool into which your application will store any failed messages. A separate thread can then periodically attempt to re-send messages from this spool.

----

5. How to create New Lines in my SMS messages?
* Depending on the programming language you can use \n or %0A character sequences in the text of your messages to force text after the character to appear in a new line. For example:

string message = "test message from VS\nAnother line\nThe third line";

----

6. My messages are cut off at 70 characters. Why?
* Characters in SMS messages can be GSM7BIT (ASCII) or UNICODE encoded. UNICODE is used to transmit text that contains non-latin characters, for example Chinese, Japanese, Hebrew, Arabic. As per SMS standard, SMS message that us UNICODE can carry maximum of 70 characters where as GSM7BIT encoded messages can be up to 160 characters long. Use encoding setting Seven to send SMS using GST7BIT encoding or Sixteen to encode your text using UNICODE. If you use Sixteen, your messages can be maximum 70 characters long.

----

7. Can I use IP address of our server in my API call?
* '''NEVER''' use IP address when making calls to our service. IP address can change at any time and if this happens your application will no longer be able to make requests.

----

8. Forwarding to my HTTPS does not work. Why?
* In most cases use of HTTPS protocol requires that we register your certificate with our system. We strongly recommend that you, at least initially, start with non-secure service (HTTP) and once you have completed integration for receiving SMS messages work with our team to install your certificate.

----
9. I make a successful call of Send_Plain but then, on the phone I get message: "Free Msg: Unable to send message to 12125555555. Please try again without a symbol in the text". Why?
* This means that you are trying to send UNICODE encoded messages to a carrier that does not support UNICODE (most US carriers do not support UNICODE). Please use value Seven in the Encoding field when calling Send_Plain or Send_Plain_Dedicated functions.
----
10. After I create a Service Reference to http://api.upsidewireless.com/soap/SMS.asmx in Visual Studio, I do not have the "SMS" object available to be able to create an object. I only have SMSSoapClient. When I instantiate SMSSoapClient sms = new SMSSoapClient(); I get an error. Do I have to configure the endpoint?
* Use SMSSoapClient sms = new SMSSoapClient("SMSSoap");
----
[[APIs | back]]

MOIntro

2013-10-05T16:48:34Z

Bzurkovic:

With our service you can collect incoming SMS messages from your customers and have these messages forwarded directly to your application using a common '''HTTP-POST''' protocol. Here a several examples:

* Voting
* VoIP Call origination
* Customer support
* Sales reporting
* Instant Messaging
* Telemetry and many more

To receive text messages, senders need a number to which they can send them. There are two options for you to receive incoming messages. You can use a
* Shared short or long code or
* Dedicated [[VirtualSMS]] or dedicated short code

Please contact us to discuss which option would work the best in your situation.

Incoming SMS messages are first directed into your account (Inbox). From there, these messages can be collected by your application in two ways: Push and Pull

'''1. Push'''

Messages received in your account are forwarded to you using email or HTTP-POST. This is the preferred method as you get messages immediately after they have been received. For this process to work you need to expose an HTTP-POST listener on your web server and let us know its URL. The downside of this method is in case your URL changes (for example you have dynamic IP address) forwarding to your application will stop as we will unable to locate the URL that was provided - for as long as you do not update the URL with new IP address. Also, this method is sensitive to firewall settings (you will need to expose the web server which may be behind the the firewall - make sure the port is open).
See below links for details on using HTTP-POST:

* [[MO HTTP]]
* [[MO HTTPS]]

PLEASE NOTE - YOUR APPLICATION MUST IMPLEMENT HTTP-POST processing NOT HTTP-GET

''Step-By-Step Process to Get You Going''
* We assume that you already created an account and have sending using API working
* Create HTTP-POST listener in your server. Make sure it is on a publicly accessible web server (i.e. external services can access your application)
* Login to your account and click on the Contact Us link. Paste the URL into the body of your message and request that we configure your account
* Once you receive confirmation of this completion, you will be able to receive messages in your application

'''2. Pull'''

Your application can also collect messages from your online account in periodic intervals. This is preferred if you do not have an application that can be exposed to the Internet or if your IP address changes often so that it is not practical to keep updating your IP/URL settings. The downside is that you need to poll for new messages every so often (no more than 2 minute intervals are allowed), which means that delivery to your application may be slightly delayed.

There are two methods for getting your messages.

Using SOAP method GetNewInboxMessages or using standard POP3 protocol.

*[[MO POP3 |POP3 ]]
*[[MO_SOAP |SOAP]]

----
[[APIs | back]]

Tips SOAP

2013-09-06T21:33:35Z

Bzurkovic:

This page represents a collection of common issues encountered by our users. If the problem you experienced is not listed below please login to your upsidewireless.com account and click on the Contact Us link to describe the problem. We will be quick to assist.

----

1. I coded my application as per examples but I cannot send text messages. Why?

Assuming that your code IS correct, the most common reasons are:
* Account is not configured to allow you to access EnterpriseSMS API. Login to your upsidewireless.com account and click on the Contact Us link to request access.
* Your upsidewireless.com account has 0 credit balance
* You are entering phone number in invalid format (remember country_code areacode localnumber - as in 12124445555 or 4477322222222)
* Encoding is wrong. Make sure that you use either Seven or Sixteen (not 7, sixteen or anything else). In very, VERY, rare situations you would use Eight (binary SMS)

As a general rule, when you make a successful API call the interface will return something similar to:

[[Image:SendPlainResponse.jpg]]

In your validation routine you can easily parse the received XML block and determine where the problem may be.

----

2. I made a successful API call but the message was not delivered. Why?
* Please ensure that the number is typed correctly and in proper format. For example, if you specify number as 6094928888 the message will go to Malaysia. For the message to go to USA you must add country code in front (as in 16094928888)
* It is possible that the delivery of messages failed. Please login to your upsidewireless.com account and click on the Contact Us link to let our network ops team of the issue

----

3. I used to be able to send messages but now I get an error when I try to make API call. Why?
* Your account password has most likely changed. You must update your Token and Signature to reflect this change.

----

4. Occassionally I get exception when calling one of your functions. What should I do?
* Standard practice is to re-try the attempt after a certain period of time. We recommend that in your code is set to re-try after 10-20s at least once, before aborting the attempt. A further improvement to the exception handling of this type is to create a spool into which your application will store any failed messages. A separate thread can then periodically attempt to re-send messages from this spool.

----

5. How to create New Lines in my SMS messages?
* Depending on the programming language you can use \n or %0A character sequences in the text of your messages to force text after the character to appear in a new line. For example:

string message = "test message from VS\nAnother line\nThe third line";

----

6. My messages are cut off at 70 characters. Why?
* Characters in SMS messages can be GSM7BIT (ASCII) or UNICODE encoded. UNICODE is used to transmit text that contains non-latin characters, for example Chinese, Japanese, Hebrew, Arabic. As per SMS standard, SMS message that us UNICODE can carry maximum of 70 characters where as GSM7BIT encoded messages can be up to 160 characters long. Use encoding setting Seven to send SMS using GST7BIT encoding or Sixteen to encode your text using UNICODE. If you use Sixteen, your messages can be maximum 70 characters long.

----

7. Can I use IP address of our server in my API call?
* '''NEVER''' use IP address when making calls to our service. IP address can change at any time and if this happens your application will no longer be able to make requests.

----
8. I make a successful call of Send_Plain but then, on the phone I get message: "Free Msg: Unable to send message to 12125555555. Please try again without a symbol in the text". Why?
* This means that you are trying to send UNICODE encoded messages to a carrier that does not support UNICODE (most US carriers do not support UNICODE). Please use value Seven in the Encoding field when calling Send_Plain or Send_Plain_Dedicated functions.
----
9. After I create a Service Reference to http://api.upsidewireless.com/soap/SMS.asmx in Visual Studio, I do not have the "SMS" object available to be able to create an object. I only have SMSSoapClient. When I instantiate SMSSoapClient sms = new SMSSoapClient(); I get an error. Do I have to configure the endpoint?
* Use SMSSoapClient sms = new SMSSoapClient("SMSSoap");
----
[[APIs | back]]

Error codes for Send Plain ServiceGroup

2013-07-12T18:45:09Z

Bzurkovic: New page: Send_Plain_ServiceGroup is API function that allows you to send a message to a group of recipients - a group is defined in your account and can contain any number of recipients. Use this f...

Send_Plain_ServiceGroup is API function that allows you to send a message to a group of recipients - a group is defined in your account and can contain any number of recipients. Use this function only if you have a dedicated VirtualSMS or use a short code for campaign management. This page describes error statuses which Send_Plain_ServiceGroup can generate.

You can send messages to the entire group (all) for the specified service or only to a sub-set of the subscribers. In the first case, leave value for Group empty. If you specify a group name, the group must belong to the same service. In this case, the message will be sent to the members of the stated group.

'''Send successful - the message was sent to the group of recipients'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendServiceGroupResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>true</isOk>
</SMSSendServiceGroupResult>

'''''Failed sending'''''

'''Incorrect Service name'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendServiceGroupResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<errorMessages>No such service</errorMessages>
</SMSSendServiceGroupResult>

'''Incorrect group name'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendServiceGroupResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<errorMessages>No such group</errorMessages>
</SMSSendServiceGroupResult>

'''Not enough credits'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendServiceGroupResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<errorMessages>Not enough credits to send SMS to all members of the group. Please top-up your account and re-try</errorMessages>
</SMSSendServiceGroupResult>

Error codes for Send Plain Group

2013-07-12T18:39:08Z

Bzurkovic:

Error codes for Send Plain Group

2013-07-12T18:38:06Z

Bzurkovic:

Error codes for Send Plain Group

2013-07-12T17:32:29Z

Bzurkovic:

Send_Plain_Group is API function that allows you to send a message to a group of recipients - a group is defined in your account and can contain any number of recipients. This page describes error statuses which Send_Plain_Group can generate

'''Send successful - all messages were sent'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>true</isOk>
<successCount>3</successCount>
<failedCount>0</failedCount>
</SMSSendMultipleResult>

'''''Failed sending or partial fail'''''

'''No recipients - no message will be sent'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<successCount>0</successCount>
<failedCount>0</failedCount>
<errorMessages>No recipients</errorMessages>
</SMSSendMultipleResult>

'''Excess maximum recipients - no message will be sent'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<successCount>0</successCount>
<failedCount>26</failedCount>
<errorMessages>Excess maximum recipients (25)</errorMessages>
<errorNumbers>17788580767,16046668888,17788456789, 456789, 123456, 65743211, ...</errorNumbers>
</SMSSendMultipleResult>

'''Partial Success - some messages will not be sent (in the below example 2)'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<successCount>3</successCount>
<failedCount>2</failedCount>
<errorMessages>recipient length invalid,recipient length invalid</errorMessages>
<errorNumbers>456789,123456</errorNumbers>
</SMSSendMultipleResult>

Error codes for Send Plain Group

2013-07-12T17:31:42Z

Bzurkovic: New page: Send_Plain_Group is API function that allows you to send 25 messages to a group of recipients - a group is defined in your account. This page describes error statuses which Send_Plain_Grou...

Send_Plain_Group is API function that allows you to send 25 messages to a group of recipients - a group is defined in your account. This page describes error statuses which Send_Plain_Group can generate

'''Send successful - all messages were sent'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>true</isOk>
<successCount>3</successCount>
<failedCount>0</failedCount>
</SMSSendMultipleResult>

'''''Failed sending or partial fail'''''

'''No recipients - no message will be sent'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<successCount>0</successCount>
<failedCount>0</failedCount>
<errorMessages>No recipients</errorMessages>
</SMSSendMultipleResult>

'''Excess maximum recipients - no message will be sent'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<successCount>0</successCount>
<failedCount>26</failedCount>
<errorMessages>Excess maximum recipients (25)</errorMessages>
<errorNumbers>17788580767,16046668888,17788456789, 456789, 123456, 65743211, ...</errorNumbers>
</SMSSendMultipleResult>

'''Partial Success - some messages will not be sent (in the below example 2)'''
----
<?xml version="1.0" encoding="utf-8" ?>
- <SMSSendMultipleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">
<isOk>false</isOk>
<successCount>3</successCount>
<failedCount>2</failedCount>
<errorMessages>recipient length invalid,recipient length invalid</errorMessages>
<errorNumbers>456789,123456</errorNumbers>
</SMSSendMultipleResult>

Salesforce

2013-03-08T16:11:26Z

Bzurkovic: typo corrected

With our service you can connect your SalesForce.com account to send text messages to one or more contacts. [http://api.upsidewireless.com/samples/salesforce/salesforce.zip The sample code] is provided for your convenience. Feel free to use it and improve for your purposes.

'''Instructions'''

1. This source code pack contains:

a) upsideWirelessSMSAPI.cls
- Stubs generated by Salesforce wsdl2apex for the SOAP service

b) SMSAPI.cls
- Connector class using upsideWirelessSMSAPI to send SMS messages to one or more Salesforce contact

2. Should the API definition change and you have to regenerate the Apex stub classes, keep in mind that Salesforce wsdl2apex only supports wsdl with 1 porttype and 1 binding. Since SOAP service is used in this implementation, the wsdl needs to be trimmed down to remove porttype and binding other than 'SMSSoap'.

3. Classes and methods in upsideWirelessSMSAPI corresponding to those parts of the API that are not used in this implementation are commented out.

4. There are 2 versions of send SMS method in SMSAPI:

a) public Boolean sendSMS(Contact recipient, String message)
- a simpler version that sends SMS to a single contact and returns a boolean to indicate success or failure

b) public Set<Id> sendSMSMultiple(List<Contact> recipients, String message)
- sends SMS to multiple contacts and returns a set of contactIds to whom the send was successful

5. Limitations on number of recipients

a) The web services API supports up to 25 recipients. Your Salesforce app should limit the list of contacts
passed into sendSMSMultiple() to 25 or fewer contacts. Or split long list of contacts into sublists
of no more than 25 and call sendSMSMultiple() multiple times.

b) Salesforce has a governor limit of 10 web services call in an apex request. So you can make at most 10 calls
to sendSMSMultiple() in apex for a maximum of 250 recipients.

6. International phone number

a) To send to international mobile phone numbers outside the US, the reformatPhone() method needs to be modified to prepend the appropriate country codes.

----
[[APIs | back]]

PHP Sending SMS

2012-12-11T22:58:01Z

Bzurkovic:

<source lang="php">

<?php

// NOTE - THE CODE BELOW IS PROVIDED FOR ILLUSTRATION ONLY

//SOME CHANGES MAY BE NEEDED TO GET IT TO WORK IN YOUR PROGRAM

// plug in the values returned from

// http://api.upsidewireless.com/soap/Authentication.asmx?op=GetParameters

// please note that in order to use this and other examples and EnterpriseSMS

//API your account must have permissions set to do so.

$token = '----------------------------------------';

$signature = '--------------------------------------';

$api_call_data = array(
'token' => $token,
'signature' => $signature,
'recipient' => '+16043434343',
'message' => 'Hello World',
'encoding' => 'Seven' // Use 'Sixteen' if you are sending in Unicode
);

$post_data = build_post_data($api_call_data );

// Please refer to

// http://api.upsidewireless.com/

// for other sending methods

$url = 'http://api.upsidewireless.com/soap/SMS.asmx?op=Send_Plain';

$xml = do_post_request($url, $post_data);

// be sure you look at the XML from above to see if there are any errors

// Everything below is just function definitions

function do_post_request($url, $data, $optional_headers = null)
{
$params = array('http' => array('method' => 'POST', 'content' => $data));

if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}

$ctx = stream_context_create($params);

$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problem with $url, $php_errormsg");
}

$response = @stream_get_contents($fp);

if ($response === false) {
throw new Exception("Problem reading data from $url, $php_errormsg");
}
return $response;
}

function build_post_data($data, $prefix=null, $sep="", $key="") {

$ret = array();

foreach((array)$data as $k => $v) {

$k = urlencode($k);

if(is_int($k) && $prefix != null) {
$k = $prefix.$k;
}

if(!empty($key)) {
$k = $key."[".$k."]";
}

if(is_array($v) || is_object($v)) {
array_push($ret, build_post_data($v,"",$sep,$k));
} else {
array_push($ret,$k."=".urlencode($v));
}
}

if(empty($sep)) {
$sep = ini_get("arg_separator.output");
}

return implode($sep, $ret);
}

?>

</source>

----
[[APIs | back]]