A Quick Start Guide to the C# wrapper library

Transcription

1 A Quick Start Guide to the C# wrapper library Integrating the Text Marketer API with your code Integration Guide Version 2.1 July Version 2.1 Text Marketer Ltd Page 1 of 30

2 Contents Document Change Log... 3 Introduction... 4 Quick Start... 4 Basics including the wrapper library... 6 Basics testing with the sandbox... 6 What is a sent message?... 7 Handling errors... 8 General error codes... 8 Wrapper Functions... 9 addgroup addnumberstogroup createsubaccount getcredits getdeliveryreport getdeliveryreports getgroup getgroups getkeyword getlasterrors isloginvalid sendsms Supported Characters deletesms transfercreditstoaccount transfercreditstouser Version 2.1 Text Marketer Ltd Page 2 of 30

3 Document Change Log Date Version Detail 15 July Added delete SMS fuction 06 February Document rewrite and renamed from 'A Quick Guide to the C# SMS REST Client' 19 April Updates for client version February First publication Terms of use Our example code and wrappers are provided for your convenience as an illustration of how you might integrate with our systems and is not certified for production environments. You are responsible for testing and QA. Version 2.1 Text Marketer Ltd Page 3 of 30

4 Introduction Our API wrappers offer you simplicity with the greatest flexibility. This document describes the C# wrapper library, which makes it really easy to use our most feature-rich API in your C# code through simple function calls. Quick Start To send an SMS with our C# wrapper, download and unzip the wrapper from then copy the RestClient.cs or the DLL RestClient.dll into your project folder. You must use the RestClient assembly in your C# code e.g: using RestAPI; Now put the following code somewhere in a C# file and execute it to send an SMS don't forget to substitute your own API username and password and a real mobile number to send to! using System; using RestAPI; using System.Collections; namespace ExampleRestAPI { class Example { static void Main(string[] args) { RestClient.ENV_PRODUCTION); RestClient tmclient; tmclient = new RestClient("myAPIusername", "myapipassword", try { Hashtable result = tmclient.sendsms("my message", " ", "Sender", 72, "", "", null); Console.WriteLine("Used {0} Credits, ID:{1}, Status: {2}", result["credits_used"], result["message_id"], result["status"]); de.value); } } } catch (RestClientException e) { } Console.WriteLine(e.Message); foreach (DictionaryEntry de in tmclient.getlasterrors()) Console.WriteLine(); Console.WriteLine("Error {0}: {1}", de.key, Console.Write("Press ENTER to continue"); Console.ReadLine(); } For more details about the additional arguments the sendsms function can take, and other important considerations of sending messages, see page 24. In a real situation you must decide how to deal with any errors, we also recommend Version 2.1 Text Marketer Ltd Page 4 of 30

5 logging all errors. See the Handling errors section below for more details. NOTE you can find your API username and password (which may be different to your web interface username/password) via your account: If you don't have an account, you get one for free at Version 2.1 Text Marketer Ltd Page 5 of 30

6 Basics including the wrapper library As described in the Quick Start above, you need a copy of the C# wrapper RestClient.cs or the DLL RestClient.dll, available from You should place the file in your class path or in the folder where you are executing the code. You must use the RestClient assembly in your C# code: using RestAPI; References needed by C# RestClient library: Microsoft.CSharp System System.Core System.Data System.Data.SetExtensions System.Web System.Xml System.Xml.Linq Basics testing with the sandbox A sandbox system is available for testing. The sandbox will not modify your account in any way, but in almost all other respects it will respond normally to your requests. In other words if you use the sandbox to get the number of credits on your account, it will provide the correct number. However if you use it to transfer credits between accounts, it will simulate a successful transfer (assuming you have enough credits on the account, and provide valid target account details, etc.) but it will not actually modify the number of credits on either account. Similarly, the sandbox system will not actually send SMS messages and will not deduct credits for simulated sends. To use the sandbox simply specify ENV_SANDBOX instead of ENV_PRODUCTION when you create the wrapper object: RestClient tmclient; tmclient = new RestClient("myAPIusername", "myapipassword", RestClient.ENV_SANDBOX); NOTE the values returned when using the sandbox may differ slightly from the values returned when using the production system. Version 2.1 Text Marketer Ltd Page 6 of 30

7 What is a sent message? There is a difference between a successfully sent message, and a successful delivery. Successfully sending a message using the sendsms function only means that the number and message appear to be in the correct format and that the message was queued for sending this does not mean that the destination number exists, or that the message was received by the recipient. A delivery report which you can retrieve through the getdeliveryreport function confirms to you what has actually happened to the message. This may change over time, e.g. a delivery report may show a 'PENDING' status for a message 10 minutes after the message was sent, but may show a 'DELIVERED' status after an hour. The status of messages can change for up to 72 hours after the message was sent. Therefore you may prefer to wait for 72 hours after sending an SMS before trying to retrieve its delivery report. NOTE Very occasionally there is no delivery report status for a given message at all. This can be due to a failure at the operator end because of exceptionally high load or other problems. Version 2.1 Text Marketer Ltd Page 7 of 30

8 Handling errors It is always possible for your request to return an error. If an error occurs, e.g. if your API username/password is incorrect, our wrapper will throw a C# exception. If you're not familiar with handling exceptions in C#, it basically means you need to put the wrapper function calls in a try-catch block as shown in the code example from the Quick Start section: try { Hashtable result; result = tmclient.sendsms("my message", " ", "Sender", 72, "", "", null); } catch(restclientexception e) { } Hashtable errors = tmclient.getlasterrors(); You must decide how to handle errors according to the logic of your particular application. For example, if you're building a web interface to send text messages, and a send fails, you may wish to show a visual alert to the user. Note that more than one error can be reported at once. Therefore although a single C# exception (the first of the errors) is thrown, the complete set of errors encountered is available in a Hashtable of key-value pairs. The key of each pair is the error code and the value is a detailed description of the error. This is why the Quick Start example displays the errors using the following code: foreach (DictionaryEntry de in tmclient.getlasterrors()) Console.WriteLine("Error {0}: {1}", de.key, de.value); General error codes There are some error codes that have the same meaning for all function calls. These are: Error Code Meaning 400 Bad request. There was a problem with your request data, see the error message for details. 403 Incorrect username/password, or you do not have sufficient rights to access the specified function. 404 The specified resource could not be found, for example when you try to retrieve details of a non-existant send group, or a delivery report search which returns no results. 405 The function call was invalid. This error should not occur when using the wrapper library. 500 An unexpected error occurred. 501 The method requested has not been implemented. This error should not occur when using the wrapper library. 503 Service Unavailable. The Web Service is not currently available to serve your request. Errors that are specific to each function call are given in the details of each function below. Version 2.1 Text Marketer Ltd Page 8 of 30

9 Wrapper Functions Below is a list of all the functions currently available in the latest version of the C# wrapper library. addgroup Create a new 'send' group Page 10 addnumberstogroup Add new numbers to a 'send' group Page 11 createsubaccount Create a new account that is a sub-account of your main account Page 12 getcredits Get the number of credits available in your account Page 14 getdeliveryreport Get the contents of one/several delivery report(s) Page 15 getdeliveryreports Get a list of the available delivery reports Page 18 getgroup Get the numbers present in a send/merge group Page 19 getgroups Get a list of the available 'send' and 'merge' groups Page 20 getkeywordavailability Get the availability of a keyword for use on our short code number Page 21 getlasterrors Get the errors returned from the last call to the API Page 22 isloginvalid Check the username/password credentials used are valid Page 23 sendsms Send an SMS to a given recipient Page 24 deletesms Delete a previously scheduled SMS Page 28 transfercreditstoaccount Transfer credits to a specified account number Page 29 transfercreditstouser Transfer credits to a specified account username Page 30 The details of these functions are outlined below. All function call examples should be placed in a C# try-catch block, as described in Handling errors above. Each example assumes you have already instanciated the wrapper object and assigned it to the variable tmclient as seen in Quick Start: RestClient tmclient; tmclient = new RestClient("myAPIusername", "myapipassword", RestClient.ENV_SANDBOX); Version 2.1 Text Marketer Ltd Page 9 of 30

10 addgroup Create a new 'send' group. Example if(tmclient.addgroup("my Group")) Console.WriteLine("'My Group' added with success."); Arguments String group: the name of the group to be created. Up to 25 alpha-numeric characters, and '-' are allowed. The name cannot consist of only digits. Returns A true boolean if the group is added with succes Specific error codes Code Meaning 0 DEPRECATED. 1 A group with that name already exists (group names are not case-sensitive). 2 The group name is invalid. Only up to 25 alpha-numeric characters, and '-' are allowed. The name cannot consist of only digits, at least one alpha character or '-' must be present. NOTE error code 404 is reported if the group does not exist; error code 400 is reported if the group name was not specified. See General error codes on page 8 for more details. Version 2.1 Text Marketer Ltd Page 10 of 30

11 addnumberstogroup Add a number/numbers to a 'send' group (excluding 'merge' groups). Example int numadded = tmclient.addnumberstogroup("my Group", " , "); Console.WriteLine("Added {0} numbers to My Group", result); Arguments String groupname: String numbersarray: Name ID of the group to add the numbers to. The MSISDN (mobile number) you wish to add. If you want to add more than one number use a comma-delimited list. Returns An integer with the total of added numbers to the selected group Specific error codes Code Meaning 0 The group ID or name was not specified or was invalid. 1 DEPRECATED. 2 No numbers were supplied for adding to the group. 3 A number was not of a valid format. 4 This service will not add to a merge group. Merge groups are not handled by this function. NOTE error code 404 is reported if the group does not exist. See General error codes on page 8 for more details. Version 2.1 Text Marketer Ltd Page 11 of 30

12 createsubaccount Create a new account, linked to your main account (requires additional permissions on your account, please contact Text Marketer to apply). Example Hashtable account; account = tmclient.createsubaccount("my Client", " ", "notifications@myclient.com", "newusername", "newpassword", "PROMOCODE", true); Console.WriteLine("Account ID: {0}", result["account_id"]); Arguments String companyname: the company name for the new account. Between 3 and 40 characters, inclusive. No special restrictions. String notificationmobile: String notification (optional*) a mobile number to which notifications and alerts are sent. Must be a valid UK mobile number. *Required if $notification is not set. (optional*) an address to which notifications and alerts are sent. *Required if $notificationmobile is not set. String username: (optional) the username you wish to set on the new account - the API username will be the same. Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters allowed. If this is not set, one will be set for you. String password: (optional) the password you wish to set on the new account - the API password will be the same. Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters allowed. If this is not set, one will be set for you. String promocode: boolean overriderates: (optional) a promotional code entitling the new account to extra credits. if set to true, use the credits rates set on your main account (the account used to access the API), rather than the Text Marketer defaults. Returns A Hashtable<String, String> with 10 keys: 'api_password', 'api_username', 'company_name', 'create_date', 'credits', 'password' and 'username', 'notification_ ', 'notification_mobile', 'account_id' Version 2.1 Text Marketer Ltd Page 12 of 30

13 Hashtable key api_password api_username company_name create_date credit password username notification_ notification_mobile account_id Value String. The new account API password String. The new account API username String. The new account company name String. The creation date of the account in ISO 8601 format Integer. The number of credits on the new acccount. String. The new account web interface password. String. The new account web interface username. String. The new account address used for notifications. String. The new account UK mobile number used for notifications. String. The ID of the account used for identification in other functions. Specific error codes Code Meaning 0 Either the address or mobile number must be supplied. 1 The company name must be supplied. 2 The address you specified is invalid. 3 The mobile number you specified is not a valid UK mobile number. 4 A value you tried to set is either too long or too short. See specific error text. 5 A value you tried to set does not match the required pattern. See specific error text. 6 A parameter was missing (see specific error text). 7 The username you specified is already in use. Please choose another. 8 You have reached your limit for the number of accounts you can create. Please contact Text Marketer to increase this. Version 2.1 Text Marketer Ltd Page 13 of 30

14 getcredits Get the number of credits currently available on the account. Example int credits = tmclient.getcredits(); Console.WriteLine("Account have " + credits + " credits."); Arguments None. Returns A positive/zero integer indicating the number of credits on your account Specific error codes None. Version 2.1 Text Marketer Ltd Page 14 of 30

15 getdeliveryreport Retrieve an individual delivery report (or combined reports), which shows the current known status of messages sent in a given time period, or for a particular campaign or campaigns. Conversely, the function getdeliveryreports (page 18) gets a list of available delivery report names, including delivery reports for campaigns. See also What is a sent message? on page 7. NOTE messages sent with the API can be given a 'tag'. The getdeliveryreport function allows you to specify that tag in order to restrict your search. Examples To get the contents of a delivery report for the campaign name 'mycampaign ': DeliveryReport[] reports = tmclient.getdeliveryreport("mycampaign "); To get the delivery report details for 'mycampaign ' between 01:00 and 02:00 on 1st Jan 2011: DeliveryReport[] reports = tmclient.getdeliveryreport("mycampaign ", new DateTime(2011, 1, 1, 1, 0, 0), DateTime(2011, 1, 1, 2, 0, 0)); Or, between 01:00 on 1st Jan 2011 and now: DeliveryReport[] reports = tmclient.getdeliveryreport("mycampaign ", new DateTime(2011, 1, 1, 1, 0, 0), DateTime.Today); To get delivery report details for all campaigns and API sends between the same dates as the previous 2 examples: DeliveryReport[] reports = tmclient.getdeliveryreport("all", new DateTime(2011, 1, 1, 1, 0, 0), DateTime(2011, 1, 1, 2, 0, 0)); reports = tmclient.getdeliveryreport("all", new DateTime(2011, 1, 1, 1, 0, 0), DateTime.Today); To get a delivery report with the name 'mycampaign ', restricted to those messages sent with custom tag 'test': DeliveryReport[] reports = tmclient.getdeliveryreport("mycampaign ", "test"); To get the status of messages from all delivery reports for messages sent with custom tag 'test': DeliveryReport[] reports = tmclient.getdeliveryreport("all", "test"); Version 2.1 Text Marketer Ltd Page 15 of 30

16 The same as the previous 2 examples, but between 2 dates: DeliveryReport[] reports = tmclient.getdeliveryreport("all", test, new DateTime(2011, 1, 1, 1, 0, 0), DateTime(2011, 1, 1, 2, 0, 0)); reports = tmclient.getdeliveryreport("all", test, new DateTime(2011, 1, 1, 1, 0, 0), DateTime.Today); A complete example, including output: DeliveryReport[] reports = tmclient.getdeliveryreport("all"); foreach (DeliveryReport report in reports) { Console.WriteLine(report); foreach (Hashtable row in report.rows) { Console.WriteLine("\tMessage ID: {0}", row["message_id"]); Console.WriteLine("\tLast Updated: {0}", row["last_updated"]); Console.WriteLine("\tMobile Number: {0}", row["mobile_number"]); Console.WriteLine("\tStatus: {0}", row["status"]); Console.WriteLine("\tCustom {0}", row["custom"]); } } Arguments String name: String custom: Date date_start: Date date_end: name of the delivery report to retrieve or 'all' to retrieve all campaign/api report data. restrict search to those SMS sent with a custom 'tag' (see custom parameter of sendsms function). Up to and including 20, alphanumeric characters. restrict search to be from date_start (Europe/London time). restrict search to be up to date_end (Europe/London time). Returns A DeliveryReport object array. Each Hashtable represents a delivery report and has 4 keys: 'name', 'last_updated', 'extension' and 'rows': Hashtable key name Value String. The name of the delivery report containing the message statuses. For campaigns sent via the web interface, this is the campaign name that way specified. For messages sent via one of our APIs, the name is GatewayAPI_DD-MM-YY, where DD is the calendar day, MM the month, and YY the year. last_updated String. The last time a message delivery status in this delivery report was updated, ISO 8601 format. This allows you to determine whether there was a change since you last accessed the report. Version 2.1 Text Marketer Ltd Page 16 of 30

17 Hashtable key extension rows Value DEPRECATED this value no longer has any meaning. ArrayList. rows is an ArrayList of Hashtable with keys 'message_id', 'mobile_number', 'status' and 'last_updated' (see below). reportrow is an array with 4 keys: Hashtable key message_id mobile_number status Value String. The unique ID of the sent message (different for each number sent to). String. The mobile number that the message was sent to, in international format, e.g String. The status of the message delivery. PENDING means the status of the sent message is currently unknown. REJECTED means that the relevant operator rejected the message and did not attempt to deliver it. FAILED probably means that the number doesn't exist (or not anymore), or the recipient didn't turn on their phone to receive the message and it expired. DELIVERED means the message was received on the handset. NON-UK means you are on a UK-only account and have tried to send a non- UK number. last_updated String. The last time this message delivery status was updated, ISO 8601 format. This allows you to determine whether there has been a change since you last accessed the report. Specific error codes Code Meaning 0 The custom value must contain only alpha-numeric characters 1 The custom value must be between 1 and 20 characters in length 2 The 'from' and 'to' timestamps must be in ISO 8601 format NOTE error code 404 is reported if no delivery reports are found using the specified search criteria. See General error codes on page 8 for more details. Version 2.1 Text Marketer Ltd Page 17 of 30

18 getdeliveryreports Retrieve a list of available delivery report names. Example String[] result = rclient.getdeliveryreports(); foreach (String report in result) Console.WriteLine("Report name: {0}", report); Arguments None. Returns An array of String with the delivery report names. Specific error codes None. Version 2.1 Text Marketer Ltd Page 18 of 30

19 getgroup Shows the details of a group. Only gets the details of one group at a time, and includes all the numbers in the group, if there are any. Also lists the numbers in a 'stop' groups - numbers in these groups will never be sent messages. Every account has at least one stop group, so that your recipients can always opt out of receiving messages from you. This is a legal requirement. Example String[] numbers = tmclient.getgroup("my Group"); foreach (String number in result) Console.WriteLine("Number {0}", number); Arguments String group: Group name or group ID to get the numbers of. Returns A String array containing the numbers in the group. Specific error codes None. NOTE error code 404 is reported if the group does not exist; error code 400 is reported if the group name was not specified. See General error codes on page 8 for more details. Version 2.1 Text Marketer Ltd Page 19 of 30

20 getgroups Get a list of available 'send' groups, including 'merge' groups - pre-defined groups containing a list of mobile numbers to send a message to. Also lists 'stop' groups - numbers in these groups will never be sent messages. Every account has at least one stop group, so that your recipients can always opt out of receiving messages from you. This is a legal requirement. Example Hashtable[] result = tmclient.getgroups(); foreach (Hashtable group in result) { Console.WriteLine("Group ID: {0}", group["id"]); Console.WriteLine("Group numbers: {0}", group[""]); Console.WriteLine("Group name: {0}", group["name"]); Console.WriteLine("Group IS STOP: {0}", group["is_stop"]); } Arguments String name: Name of the delivery report to retrieve or 'all' to retrieve all campaign/api report data Returns An array of Hashtable, each group represented by a Hashtable. Each Hashtable has 4 keys: 'is_stop', 'id', 'numbers' and 'name' e.g. name of the first returned group is group["name"] Each Hashtable has 4 keys: Hashtable key name quantity id is_stop Value String. The name of the group. Integer. The quantity of numbers in the group. Integer. The unique ID of the group, unique for this account. Boolean. Whether the group is a stop group, normally false. Specific error codes None. Version 2.1 Text Marketer Ltd Page 20 of 30

21 getkeyword Get the availability of a given reply keyword. A reply keyword allows you receive incoming text messages to your account by providing people with a keyword, which they text to the short code 88802, e.g. text 'INFO' to to see this in action. Example Hashtable result = rclient.getkeyword("gold"); Console.WriteLine("The 'gold' keyword is available ({0}), recycled ({1})", result["available"], result["recycle"]); Arguments String keyword: The keyword to check is availability Returns A Hashtable with two keys: 'available' and 'recycle' e.g. result["available"] Hastable key available recycle Value Whether this keyword is currently available from Text Marketer. Whether this keyword has been recycled (previously used). Specific error codes None. NOTE error code 400 is reported if the keyword name is not specified. See General error codes on page 8 for more details. Version 2.1 Text Marketer Ltd Page 21 of 30

22 getlasterrors Get all errors encountered after the last call to the API. Example foreach (DictionaryEntry de in tmclient.getlasterrors()) Console.WriteLine("Error {0}: {1}", de.key, de.value); Arguments None. Returns Errors Hashtable with all the errors codes and messages. There may be multiple errors. Specific error codes None. This function never throws an exception. Version 2.1 Text Marketer Ltd Page 22 of 30

23 isloginvalid Test whether the username and password are correct. Example if (rclient.isloginvalid()) Console.WriteLine("Login is OK!"); Arguments None. Returns Boolean, true if login is valid, false otherwise. Specific error codes None. This function does not throw exceptions. Version 2.1 Text Marketer Ltd Page 23 of 30

24 sendsms Send a text message to the specified recipient. Optionally, sends can be scheduled. See also What is a sent message? on page 7. Examples With the minimum arguments required, sends 'my message' to with sender ID 'Sender': Hashtable result = tmclient.sendsms("my message", " ", "Sender", 72, "", "", null); Console.WriteLine("Used {0} Credits, ID:{1}, Status: {2}", result["credits_used"], result["message_id"], result["status"]); As above, but sets validity to 72 hours and is scheduled for sending on 1 st Jan 2013 at 01:00 GMT: Hashtable result = tmclient.sendsms("my message", " ", "Sender", 72, "", "mytag, new DateTime(2013, 1, 1, 1, 0, 0)); Console.WriteLine("Used {0} Credits, ID:{1}, Status: {2}", result["credits_used"], result["scheduled_id"], result["status"]); Arguments String message: the textual content of the message to be sent. Up to 612 characters from the GSM alphabet. See Supported Characters below for the characters we support. Please ensure messages are encoded in UTF-8. String mobile_number: String $originator: int validity: String String custom: the mobile number of the intended recipient, in international format, e.g Only one number is allowed. To send a message to multiple recipients, you must call the function for each number. sender ID: text (up to 11 alpha-numeric characters) or the international mobile number (up to 16 digits) of the sender, to be displayed to the recipient, e.g for a UK number. an integer from 1 to 72 (the default), indicating the number of hours during which the message is valid for delivery. Messages which cannot be delivered within the specified time will fail. (optional) available to txtus Plus customers only. Specifies the address for incoming responses. If you specify an address, you must specify an originator that is a txtus Plus number that is on your account, or you will get an error response. (optional) an alpha-numeric string, 1-20 characters long, which will be used to 'tag' your outgoing message and will appear in Version 2.1 Text Marketer Ltd Page 24 of 30

25 delivery reports, thus facilitating filtering of reports (see getdeliveryreport function) Date schedule: (optional) date to schedule the message to be sent at a given time (Europe/London time) Supported Characters When constructing the message to be sent you should be aware that not all characters are supported by the GSM networks. They have a specific character set that they use. It shouldn t be of concern to 99% of people since the English alphabet is supported, plus some common accented characters. Please note we expect the data to be encoded in UTF-8. You will need to convert your message first if you are using a different character set, for example people sometimes store message templates in databases in one of the latin character sets. If you are storing messages in a database you may need to check this. Returns A Hashtable with 4 keys: 'message_id', 'scheduled_id', 'credits_used', 'status' e.g. result["credits_used"] Version 2.1 Text Marketer Ltd Page 25 of 30

26 Hashtable key message_id scheduled_id credits_used status Value Integer. The unique ID of the message sent. You can use this ID to find the status of the sent message in a delivery report. However for scheduled messages (i.e. where you have specified a 'schedule' argument), the ID will be zero. String. The unique ID of the scheduled message. You can use this ID later to delete a previously scheduled message. Unless the message has been scheduled for a future date, the ID will be zero. Integer. The number of credits used to send the message (up to 3 for UK or 6 for international). If the message is scheduled for future sending, this value indicates how many credits will be used when it is sent. String. Values possible are SENT, QUEUED, or SCHEDULED. Indicates whether the message was put in a queue for processing as soon as resources allow (QUEUED), sent immediately (SENT), or scheduled for future sending at your request (SCHEDULED). Specific error codes Code Meaning 0 Refused (bad number or trying international sending without a valid account). 1 Bad username or password. 2 You have zero credits. 3 The originator is invalid or too long. 4 The originator is invalid or missing. 5 The message is invalid or too long. 6 You have insufficient credits to send this message. 7 The message is invalid or missing. 8 The message contains unsupported characters (these will be listed in the error message). 9 The mobile number is invalid or too short. 10 The mobile number is invalid or not an integer. 30 Invalid address format. 31 An address was specified, but the originator specified was not a txtus number on your account. 32 If specified, the validity period (in hours) must be between 1 and 72 inclusive. 33 If specified, the custom field must be alpha-numeric and up to 20 characters in length. Version 2.1 Text Marketer Ltd Page 26 of 30

27 Code Meaning 34 The 'schedule' parameter is not in ISO 8601 date format. Version 2.1 Text Marketer Ltd Page 27 of 30

28 deletesms Delete a previously scheduled SMS Example Hashtable result = tmclient.deletesms("1234"); Console.WriteLine("Message with ID {0} was {1}", result["scheduled_id"], result["status"]); Arguments string scheduled_id: The ID of the scheduled text message, as returned by the sendsms method. Returns A Hashtable with 2 keys: 'scheduled_id', 'status' e.g. result["scheduled_id"] Hashtable key scheduled_id status Value String: The unique ID of the scheduled message. The status of the message, i.e., DELETED. Specific error codes Code Meaning 35 The provided Resource ID is not valid or is malformed. 36 This can have multiple meanings: either 1) the scheduled message id doesn't exist or belongs to other account than the one using the REST API; or 2) the scheduled message has already been sent and, as so, can't be deleted. Version 2.1 Text Marketer Ltd Page 28 of 30

29 transfercreditstoaccount Transfer credits from one account to another account, using the integer account number to specify the target account. Example Hashtable result = tmclient.transfercreditstoaccount(3, "1234"); Console.WriteLine("Transfered 3 Credits (have {0} now), to account 902, now with {1} Credits", result["source_credits_after"], result["target_credits_after"]); Arguments int quantity: String targetaccountnumber: The number of credits to transfer from the source account to the target account. The account number of the account to transfer the credits to (available in the web-based UI) Returns A Hashtable with four keys: 'source_credits_before', 'source_credits_after', 'target_credits_before' and 'target_credits_after' e.g. result["source_credits_after"] Hashtable key source_credits_before source_credits_after target_credits_before target_credits_after Value The number of credits on the source account before the transfer. The number of credits on the source account after the transfer. The number of credits on the target account before the transfer. The number of credits on the target account after the transfer. Specific error codes Code Meaning 0 There are insufficient credits available to transfer the specified quantity, or the specified quantity is not a positive number 1 The target account number specified is not a valid number or username/password combination does not refer to any known account Version 2.1 Text Marketer Ltd Page 29 of 30

30 transfercreditstouser Transfer credits from one account to another account, using the username to specify the target account. Example Hashtable result = tmclient.transfercreditstouser(3, "targetusername", "targetuserpass"); Console.WriteLine("Transfered 3 Credits (have {0} now), to account targetusername, now with {1} Credits", result["source_credits_after"], result["target_credits_after"]); Arguments int quantity: The number of credits to transfer from the source account to the target account. String target_username: The username of the account to transfer the credits to. String target_password: The password of the account to transfer the credits to. Returns A Hashtable with four keys: 'source_credits_before', 'source_credits_after', 'target_credits_before' and 'target_credits_after' e.g. result["source_credits_after"] Array key source_credits_before source_credits_after target_credits_before target_credits_after Value The number of credits on the source account before the transfer. The number of credits on the source account after the transfer. The number of credits on the target account before the transfer. The number of credits on the target account after the transfer. Specific error codes Code Meaning 0 There are insufficient credits available to transfer the specified quantity, or the specified quantity is not a positive number 1 The target account number specified is not a valid number or username/password combination does not refer to any known account Version 2.1 Text Marketer Ltd Page 30 of 30