System Requirements Deleting Collected Messages Sample Interactive SMS API Codes

Message Collection Error Codes

General

Mobildev Interactive API is developed for software developers who wish to develop two way SMS application in their solutions that will enable them to access Mobildev SMS Gateway via XML technology. Two way SMS applications are namely, Message Collection, Polling Systems, Customer Relations Management and etc.

Software developers who can prepare an XML statement using the information provided in this document will be able to submit this request to http://api.smcollector.com/xmlapi.aspx (will be referred to as Gateway). Once the XML statement is sent, it will be processed by XML Parser. If any error is found within the XML statement or within the parameter nodes; a predefined error code will be returned to the sender over HTTP. If there are no errors, an appropriate return statement will be prepared and sent back to the sender over HTTP. Predefined error codes will be explained in detail within the document.

In order to become an Interactive SMS user;

• You must have a robust internet connection,
• You must have 11-digit long format number with Interactive feature and 4-digit short format number selection. The 4-digit short format number must also be defined in your Bulk Messaging account. 

For detailed information, please CLICK HERE

System Requirements

Following is the minimum system requirements list in order to use Mobildev XML API solution:

• Windows 98 SE, ME, 2000, XP, UNIX, Linux or MacOS
• Internet Explorer 6 SP1 (for Windows platform)

Message Collection

When the below XML statement is submitted to the Gateway with the information required in the parameter nodes, collected messages for the specified account will be received as the return value:
<SMCollectorMain>
<UserName>username</UserName>
<PassWord>password</PassWord>
<Action>0</Action>
<List>ALL</List>
</SMCollectorMain>
In the above XML statement:

Username: refers to user name associated with your Mobildev SMS account.
Password: refers to password for your SMS user name.
Action: refers to the function for which the XML statement was sent for.
List: refers to the option –read, unread, all- you prefer as the return value for collected messages.

Notice: List parameter node can be assigned the following 3 values: REC READ for retrieving read messages, REC UNREAD for retrieving unread messages, ALL for retrieving all of the messages.

Sample XML Statement For Collecting All The Messages Sent

<SMCollectorMain>
<UserName>demo</UserName>
<PassWord>demo</PassWord>
<Action>0</Action>
<List>ALL</List>
</SMCollectorMain>

When you submit the above XML statement to the Gateway as an XMLHTTP request, you will receive the below return values:

1. If the operation is successful and if messages are received for the number associated with the user account:

<resultset>
<row>
<id></id>
<msgdate></msgdate>
<msgbody></msgbody>
<gsmno></gsmno>
<status></status>
</row>
<row>
<id></id>
<msgdate></msgdate>
<msgbody></msgbody>
<gsmno></gsmno>
<status></status>
</row>
</resultset>

If there are no messages for the interactive number associated with the user account:
ok 08

If an error occurred: Please consider checking the Error Codes Section of this document.

Deleting Collected Messages

When the below XML statement is submitted to the Gateway with the information required in the parameter nodes, messages with the message sending codes (MsgID) specified in the IDList parameter node will be deleted from the specified Interactive SMS user account:
<SMCollectorMain>
<UserName>your-username</UserName>
<PassWord>your-password</PassWord>
<Action>1</Action>
<IDList>MsgID</IDList>
</SMCollectorMain>
In the above XML statement:

Username: refers to user name associated with your Mobildev SMS account.
Password: refers to password for your SMS user name.
Action: refers to the function for which the XML statement was sent for.
IDList: IDList parameter node refers to the message code information (MsgID) that belongs to the messages you want to delete from the Interactive SMS user account.

Notice: If you want to delete multiple messages at the same time, you will need to input the message codes (MsgID) to the IDList parameter node by using commas. Example: 1234,5687,3215

XML Statement Necessary For Deleting Messages
<SMCollectorMain>
<UserName>demo</UserName>
<PassWord>demo</PassWord>
<Action>1</Action>
<IDList>1234,5687,3215</IDList>
</SMCollectorMain>
When you send the above XML statement to the Gateway, you will receive the below return values:

1. If successful: “ok”
2. If an error occurred, please consider checking the Error Code Section of this document.

Notice: You may use your Mobildev Bulk SMS account for replying to the messages sent to your Interactive number. You may visit SMS API page for integration support. In automated replies, messages will be sent using the first alphanumeric defined in your Mobildev Bulk SMS account.

Error Codes

Error Code	Description
err 00	Unidentified error
err 01	Incorrect user name or password
err 02	Missing information input
err 03	Unidentified Action Information
err 04	No incoming XML
err 04	Incorrect XML received

Sample Interactive SMS API Codes

	VB Project		Delphi Project
	C# Project