/
WebServices API

WebServices API

The Web Services

This document describes the Web Services API to the SMS Gateway. The API provides access to:

  • sending of SMS to one or more phones;
  • query status of sent SMS; and
  • receiving of SMS messages.

The reader is assumed to be familiar with web services and how to interface with them. Some code examples are provided

The following is a summary list of Web Services that is provided by MessageCore.

method

parameters

return

send

(String username, String password, String[] recipients, String text);

String documentId

query

(String username, String password, String documentId);

SubmitStatus[]

sendDocument

(Document document);

String documentId

receive

(String username, String password, Option[] criteria);

Message[]

receiveUnpolled

(String username, String password, criteria);

Message[]

sendSingle

(String username, String password, String recipient, String text);

String documentId

sendSingle2

(String username, String password, String recipient, String text, String encoding, String replyto, String sender);

Array of - String recipient, int statusCode, String documentId