\n| ShowErrorMessage (optional)<\/td>\n | If this is set (to any value) and an error occurs in the API call, the text for the error message will be shown one line beneath the error code.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nCheck Credits<\/h3>\nChecks your current credit balance. No further parameters are required. Your credit balance will be returned in the content of the page.<\/p>\n Example GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=CheckCredits<\/div>\n <\/div>\n Check Message Status<\/h3>\n\n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| MessageID<\/td>\n | 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<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=CheckMessageStatus&MessageID=[Your Message ID]<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Send Message<\/h3>\nSends 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<\/p>\n \n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| DestinationAddress<\/td>\n | 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 \u201cList\u201d and add a new parameter \u201cListName\u201d with the name of the list to send to.For a group set the DestinationAddress parameter to \u201cGroup\u201d and add a new parameter \u201cGroupName\u201d 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.<\/td>\n<\/tr>\n | \n| SourceAddress<\/td>\n | 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.<\/td>\n<\/tr>\n | \n| Body<\/td>\n | The Message Body (max 459 characters)<\/td>\n<\/tr>\n | \n| ScheduleDate (optional)<\/td>\n | The date that the message should be sent (YYYYMMDDHHMMSS)<\/td>\n<\/tr>\n | \n| SourceTON (optional)<\/td>\n | The Type Of Number for the source address (1 for international, 5 for alphanumeric)<\/td>\n<\/tr>\n | \n| ValidityPeriod<\/td>\n | 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.<\/td>\n<\/tr>\n | \n| GetAllMessageIDs<\/td>\n | 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.<\/td>\n<\/tr>\n | \n| GetBGSendID<\/td>\n | 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.<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=Send&DestinationAddress=[Your Number]&SourceAddress=API&Body=Hello%20World<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Reports<\/h3>\nRetrieve the data from a report. The report, in CSV format, will be returned in the content of the page.<\/p>\n \n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| ReportType<\/td>\n | The Type of report. Options are:\u00a0Outbox<\/strong>\u00a0(From and To dates are ignored for this report),\u00a0Messages,\u00a0<\/strong>Usage,\u00a0<\/strong>InboundMessages, FailedMessages<\/strong><\/td>\n<\/tr>\n\n| From<\/td>\n | The start date for the report (YYYYMMDDHHMMSS)<\/td>\n<\/tr>\n | \n| To<\/td>\n | The end date for the report (YYYYMMDDHHMMSS)<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=Report&ReportType=Messages&From=20130704000000&To=20130711000000<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Create User<\/h3>\nOnly possible if you are an admin user, this will create a child user. If successful, \u20181\u2019 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).<\/p>\n \n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| ChildUsername<\/td>\n | The username of the user you wish to create<\/td>\n<\/tr>\n | \n| ChildPassword<\/td>\n | The password for the user<\/td>\n<\/tr>\n | \n| AccessLevel<\/td>\n | What access level the user should have (Normal or Admin)<\/td>\n<\/tr>\n | \n| FirstName<\/td>\n | The first name of the user<\/td>\n<\/tr>\n | \n| LastName<\/td>\n | The last name of the user<\/td>\n<\/tr>\n | \n| Email<\/td>\n | The email address of the user<\/td>\n<\/tr>\n | \n| Telephone (Optional)<\/td>\n | The telephone number of the user<\/td>\n<\/tr>\n | \n| Credits<\/td>\n | How many credits the user should start with (these will be deducted from your account)<\/td>\n<\/tr>\n | \n| Credit Reminder (Optional)<\/td>\n | When to send the user a low credit warning email (number of credits left to trigger the email)<\/td>\n<\/tr>\n | \n| Alert (Optional)<\/td>\n | After how many days of inactivity should an inactivity alert be sent<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=CreateUser&ChildUsername=[Child Username]&ChildPassword=[Child Password]&AccessLevel=Normal&FirstName=[User\u2019s First Name]&LastName=[User\u2019s Last Name]&Email=[User\u2019s Email]&Credits=5<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Update Credits<\/h3>\nTransfer credits to\/from a child user. If successful, \u20181\u2019 will be returned in the content of the page.<\/p>\n \n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| ChildUsername<\/td>\n | The username of the user that you wish to transfer credits to\/from. The user must belong to you.<\/td>\n<\/tr>\n | \n| Quantity<\/td>\n | 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.<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=UpdateCredits&ChildUsername=[Child Username]&Quantity=5<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Import Contacts CSV<\/h3>\nThis allows you to import contacts into your address book.<\/p>\n For each line in the ContactsCSV parameter, a corresponding line will be returned in the content of the page in the format:<\/p>\n [line] : [result]<\/p><\/blockquote>\n Where result is one of:<\/p>\n Success
\nDuplicate Name
\nDuplicate Number
\nPartial
\nFailed<\/p><\/blockquote>\n 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.<\/p>\n Example:<\/p>\n ContactsCSV Parameter contains:
\nContact 1,447777777771,noone@anywhere.com,group1
\nContact 2,447777777772,
\nContact 3,447777777773,,group1,group2,group3
\n,447777777774,noone@anywhere.com,group3
\nContact 5,mynumber,noone@anywhere.com,group3<\/p><\/blockquote>\n Gives the reponse:<\/p>\n 1 : Success
\n2 : Success
\n3 : Success
\n4 : Failed
\n5 : Failed<\/p><\/blockquote>\n Errors:<\/p>\n 4 : No name
\n5 : Invalid number (mynumber)<\/p><\/blockquote>\n \n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| ContactsCSV<\/td>\n | A comma separated list of contacts to add, one per line formatted as follows: name,number,email,group1,group2,group3<\/td>\n<\/tr>\n | \n| IgnoreDupes (Optional)<\/td>\n | 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.<\/td>\n<\/tr>\n | \n| OverwriteDupes (Optional)<\/td>\n | is set to 1, the value of IgnoreDupes is ignored.<\/td>\n<\/tr>\n | \n| OverwriteDupes (Optional)<\/td>\n | 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.<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=ImportContactsCSV&ContactsCSV=contact%201%2C447777777777%2Cnoreply%40anywhere.com%2Cgroup1%2Cgroup2%2Cgroup3%0Acontact%202%2C447777777778%2Cnoreply%40anywhereelse.com%2Cgroup1%2C<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Delete All Contacts<\/h3>\nDeletes 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.<\/p>\n Example GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=DeleteAllContacts<\/div>\n Delete All Groups<\/h3>\nDeletes 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.<\/p>\n Example GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=DeleteAllGroups<\/div>\n Empty Group<\/h3>\nRemove all contacts from the specified group<\/p>\n Example GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=EmptyGroup&Group=MyGroupName<\/div>\n Delete Group<\/h3>\nDelete the specified group<\/p>\n Example GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=DeleteGroup&Group=MyGroupName<\/div>\n GetBGMessages<\/h3>\nReturns a JSON array of MessageID\/Number\/Status objects (e.g. [{\u201cMessageID\u201d:\u201d3509592\u2033,\u201dDestination\u201d:\u201d447777777777\u2033,\u201dStatus\u201d:\u201dSent\u201d},{\u201cMessageID\u201d:\u201d3509593\u2033,\u201dDestination\u201d:\u201d447777777778\u2033,\u201dStatus\u201d:\u201dSent\u201d}]
\nor a json error array as follows: {\u201cerror\u201d:\u201d-521\u2033,\u201dmessage\u201d:\u201dUnknown Background SendID\u201d}<\/p>\n Possible errors:<\/strong>
\n-521 : Unknown Background Send ID
\n-522 : Background Send Not Finished
\n-523 : No messages were found<\/p>\nThis function will be unable to access messages that have been archived.<\/p>\n \n\n\n| Parameter Name<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| BGSendID<\/td>\n | ID of the send you want to retrieve messages for.<\/td>\n<\/tr>\n | \n\nExample GET URL : https:\/\/goto.text-connect.co.uk\/api?Token=th1S-15my-t0ken&Action=GetBGMessages&BGSendID=[BGSendID]<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Inbound Message HTTP Forwarding<\/h3>\nIf you have bought an Virtual Mobile\u00a0Number (VMN or MSISDN), you can set up the system to forward messages sent to that VMN to a web page on your website.<\/p>\n To do this, login into the web interface, go to your inbox and click on the manage button for the VMN you want to forward.<\/p>\n Once there you will be able to choose the URL to forward to, whether you want to forward with the GET or POST method and what to pass with the auth parameter. (The auth parameter is a passthrough variable designed to add some security by having a password passed through)<\/p>\n The following parameters are used in the call to your site:<\/p>\n source<\/strong>\u00a0\u2013 the phone number that the message came from<\/p>\ndest<\/strong>\u00a0\u2013 the VMN that the message was received on<\/p>\nmsg<\/strong>\u00a0\u2013 the body of the message<\/p>\nid<\/strong>\u00a0\u2013 the ID of the message<\/p>\nreceivedts<\/strong>\u00a0\u2013 the timestamp that the message was received by us in the format YYYY-MM-DD HH:MM:SS<\/p>\nauth<\/strong>\u00a0\u2013 the passthrough variable defined in manage VMN on the web interface<\/p>\nSupplemental Data from a Distribution List<\/h4>\nIf you have selected a distribution list to receive supplemental data from, you will receive the following additional parameters, with data from the mail merge fields of that list<\/p>\n MMName<\/strong>\u00a0\u2013 the data from the Name field<\/p>\nMMEmail<\/strong>\u00a0\u2013 the data from the Email field<\/p>\nMM1<\/strong>\u00a0\u2013 the data from the first mail merge field<\/p>\nMM2<\/strong>\u00a0\u2013 the data from the second mail merge field<\/p>\nMM3<\/strong>\u00a0\u2013 the data from the third mail merge field<\/p>\nMM4<\/strong>\u00a0\u2013 the data from the fourth mail merge field<\/p>\nMM5<\/strong>\u00a0\u2013 the data from the fifth mail merge field<\/p>\n | |
| | | | | | |