Account

Checks your current credit balance. No further parameters are required. Your credit balance will be returned in the content of the page.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
Parameters
Response
Url:

                                
Api response:

                                
Retrieve the data from a report. The report, in CSV format, will be returned in the content of the page.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
ReportType string Yes The Type of report. Options are: Outbox (From and To dates are ignored for this report), Messages, Usage, Inbound messages
From string Yes The start date for the report (YYYYMMDDHHMMSS)
To string Yes The end date for the report (YYYYMMDDHHMMSS)
Parameters
Response
Url:

                                
Api response:

                                

Message

Sends a message. The message ID or error code will be returned in the content of the Page. If multiple numbers are submitted, then multiple IDs / error codes will be returned, separated by commas
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
DestinationAddress string No The Destination Address(es) to send the message to. If you wish to send to multiple numbers, they should be separated by a comma. When submitting multiple numbers, you should use the POST method rather than the GET method.To send to a list, set the DestinationAddress parameter to “List” and add a new parameter “ListName” with the name of the list to send to.For a group set the DestinationAddress parameter to “Group” and add a new parameter “GroupName” with the name of the group to send to.If the send is successful, the API will return 1. If not, a negative error code will be returned.Note that these sends may occur in the background if the group/list contains more than 200 entries.
ListName string No See DestinationAddress.
GroupName string No See DestinationAddress.
SourceAddress string No The Source Address for the message. If this is alphanumeric, it must be 11 or less characters. All GSM characters are valid, however operators and handsets may support restricted character sets. We recommend you stick to A-Z, a-z, 0-9 and space.
Body string Yes The Message Body (max 459 characters).
ScheduleDate string No The date that the message should be sent (YYYYMMDDHHMMSS).
SourceTON string No The Type Of Number for the source address (1 for international, 5 for alphanumeric).
ValidityPeriod string Yes The period in seconds that the message will be tried for (maximum 86400 = 24 hours). Once this expires, the message will no longer be attempted to be delivered.
GetAllMessageIDs integer Yes If the message is longer than 160 characters, the system by default will return only the first ID for each message. Set this parameter to 1 to return all the Ids for each part of each message.
GetBGSendID string Yes If you send to a distlist and set this parameter to 1 the BGSendID for the dist list will be returned. For future proofing, this could be a comma separated list of values, should the send be split into multiple sends.
Parameters
Response
Url:

                                
Api response:

                                
Checks your current credit balance. No further parameters are required. Your credit balance will be returned in the content of the page.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
MessageID integer Yes The Message ID of the message that you wish to query. This is the ID returned by the Send action and can also be found in a message report.
Parameters
Response
Url:

                                
Api response:

                                
Returns a JSON array of MessageID/Number/Status objects (e.g. [{“MessageID”:”3509592″,”Destination”:”447777777777″,”Status”:”Sent”},{“MessageID”:”3509593″,”Destination”:”447777777778″,”Status”:”Sent”}] or a json error array as follows: {“error”:”-521″,”message”:”Unknown Background SendID”}

Possible errors:
-521 : Unknown Background Send ID
-522 : Background Send Not Finished
-523 : No messages were found

This function will be unable to access messages that have been archived.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
BGSendID integer Yes ID of the send you want to retrieve messages for.
Parameters
Response
Url:

                                
Api response:

                                

Users

Only possible if you are an admin user, this will create a child user. If successful, ‘1’ will be returned in the content of the page. If unsuccessful, the first line of the page will be the error code and the following lines will contain text information about the nature of the error(s).
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
ChildUsername string Yes The username of the user you wish to create.
ChildPassword string Yes The password for the user.
AccessLevel string Yes What access level the user should have (Normal or Admin).
FirstName string Yes The first name of the user.
LastName string Yes The last name of the user.
Email string Yes The email address of the user.
Telephone string No The telephone number of the user.
Credits integer Yes How many credits the user should start with (these will be deducted from your account).
CreditReminder integer No When to send the user a low credit warning email (number of credits left to trigger the email).
Alert string No After how many days of inactivity should an inactivity alert be sent.
Parameters
Response
Url:

                                
Api response:

                                
Transfer credits to/from a child user. If successful, ‘1’ will be returned in the content of the page.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
ChildUsername string Yes The username of the user that you wish to transfer credits to/from. The user must belong to you.
Quantity integer Yes The amount of credits to transfer. If the number is positive, credits will be transferred to that user. If the number is negative, they will be transferred from that user to you.
Parameters
Response
Url:

                                
Api response:

                                

Contacts

This allows you to import contacts into your address book.

For each line in the ContactsCSV parameter, a corresponding line will be returned in the content of the page in the format:
[line] : [result]

Where result is one of:
  • Success
  • Duplicate Name
  • Duplicate Number
  • Partial
  • Failed

If there are any Partial or Failed lines, then there will be a blank line, followed by text with details of all the errors below. Partial will usually mean that the contact was added, but could not be put in the group.

Example:
ContactsCSV Parameter contains:
Contact 1,447777777771,noone@anywhere.com,group1
Contact 2,447777777772,
Contact 3,447777777773,,group1,group2,group3
Contact 4,447777777774,noone@anywhere.com,group3
Contact 5,mynumber,noone@anywhere.com,group3

Gives the reponse:
1 : Success
2 : Success
3 : Success
4 : Failed
5 : Failed

Errors:
4 : No name
5 : Invalid number (mynumber)
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
ContactsCSV string Yes A comma separated list of contacts to add, one per line formatted as follows: name,number,email,group1,group2,group3.
IgnoreDupes integer No If set to 1, the system will allow duplicate contacts (name or number) to be created. By default the system will not allow duplicate names or numbers in contacts.
OverwriteDupes integer No Is set to 1, then any duplicate number will be overwritten. If a duplicate name exists, but with a different number, the original contact will not be overwritten, instead a new contact will be created.
Parameters
Response
Url:

                                
Api response:

                                
Deletes all contacts in this account. No further parameters are required. 1 will be returned if the deletion was successful, the relevant error code will be returned if an error occurred.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
Parameters
Response
Url:

                                
Api response:

                                

Groups

Deletes all groups. No further parameters are required. 1 will be returned if the deletion was successful, the relevant error code will be returned if an error occurred.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
Parameters
Response
Url:

                                
Api response:

                                
Remove all contacts from the specified group.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
Group string Yes Group name.
Parameters
Response
Url:

                                
Api response:

                                
Delete the specified group.
Parameters
Name Type Required Description
Token string Yes Your token (found in your settings within NetMessenger)
Action string Yes The action that you would like to perform.
Group string Yes Group name.
Parameters
Response
Url:

                                
Api response: