Versions Compared

Old Version 17

changes.mady.by.user Diogo Afonso

Saved on

compared with

New Version 18

changes.mady.by.user TextMarketer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
SEO Metadata
titleGET Request parameters

 

 

In your preferred programming language all you need to do is generate a GET request like this:

Panel

https://api.textmarketer.co.uk/gateway/?username=u&password=p&to=4477777777&message=test+message&orig=my_script


If you want to send to multiple numbers, use a comma delimited list. Here is an example:

Panel

https://api.textmarketer.co.uk/gateway/?username=u&password=p&to=4477777777,4477777778,4477777779&message=test+message&orig=my_script


Beware that, due to limitations on the HTTP protocol, sending to multiple numbers is limited to 500 recipients. So, if you want to send the same SMS to more than 500 recipients, e.g. 750 recipients, you'll have to send it in two batches: 500 + 250.

Here's a summary of the different variables you need.

Parameter

Comment

username 

Found in your api settings page

password Found in your api settings page
orig

Who the message is from (the originator or sender ID). This can be 11 alpha-numeric or 16 numeric only characters.

to

The recipient (or recipients) you are sending the message to. If you want to send to multiple numbers, use a comma delimited list. Try to include the international code, for example 44 in the UK. Beware that due to limitations on the HTTP protocol, sending to multiple numbers is limited to 500 recipients. So, if you want to send the same SMS to 750 recipients, you'll have to send it in two batches: 500 + 250.

message 

Up to 612 characters, messages above 160 characters require more credit.

validity (optional) 

Integer 1-72 this represents the number of hours before the text message will expire in it's undelivered status, the default is 72.

custom (optional) 

String 1-20 chars this is a custom value you can set to group data together in your delivery reporting, for example you might want to individually bill / report several of your clients.

scheduled (optional)* 

Integer (unixtime stamp) the date and time you want the SMS to be sent. If an unknown value or date in the past is set it will use now + 1 minute.

optionCan be blank or set to xml.
check_stop 

If set to 'true', prior to sending the , number(s) will be checked against the STOP group.

number
DEPRECATED

The recipient, the person you are sending the message to. Try to include the international code, for example 44 in the UK.
This parameter will be maintained for backwards compatibility reasons. You should use the 'to' parameter.

 

*to view your scheduled sends, log in to the customer system and go to “reports” =>“sent sms”.

You can also cancel or amend the queued sms.

 

Panel