This API is deprecated

This API is deprecated and will not be updated or further developed. We recommend that you intregrate our REST API´s

Application Type - Last updated: 2016-10-04 09:25:56

There are three different ways to connect to IP1's SMSgateway:

  • Web Service
  • URL call
  • EXE application

We recommend you to create an Web Service, as there are more functions to develop for this sort of API. The delivery time of sent text messages wont be effected depending on what connection type you choose.

To see your history for sent text messages, please visit : https://web.smscom.se/visastatus.aspx

Web Service - Last updated: 2016-10-04 09:26:03

The adress for our Web-service is https://web.smscom.se/sendSms/sendSms.asmx . Through this adress you will also find samples of (SOAP announcements?) for every function.

Through this adress you will find a (WSDL-Description) of the service: https://web.smscom.se/sendSms/sendSms.asmx?WSDL

If, for any reason you have any difficulty with an (SSL announcement) it is possible to use the following link: http://web.smscom.se/sendSms/sendSms.asmx

Account Balance - Last updated: 2016-10-04 09:26:13

The function "Account Balance" requires an account as well as an (API-Key) in order to display the actual balance of your account. (Returnerat värde: Balance)

Parameter

Description

Type

Acc

Account-ID

string

pass

your API- Key

string

Description - Last updated: 2015-06-23 13:53:44

The function will retrieve a (status code) and return a description. See appendix A for specifications of status codes and descriptions.

Paramter

Description

type

ID

status code

string

Cancel BundleSMS - Last updated: 2015-06-23 13:54:05

The function uses an ID to cancel any time configured message and will cancel any planned sends.

Returned Value: if time configured messages exist return will be 0. If there are no messages planned, an error message will be returned instead.

Parameter

Description

Type

Acc

Account-ID

String

pass

your API key

String

BundleID

ID for Bundle

String

cancel a single text message - Last updated: 2015-06-23 13:54:29

The function uses an ID for a text message and cancels it.

Returned value: if the action is succesfull, returned value will be 0. If not, an error message will be returned instead. (see appendix A)

Parameter

description

Type

acc

Account-ID

string

pass

your API- Key

string

smsID

ID for SMS

string

Send an SMS (text message) - Last updated: 2015-06-23 13:58:29

returned value: SMS-ID or statuscode

Parameter

Description

Type

acc

Account-ID

Account-ID

pass

your API- Key

string

to

the recipients telephone number. The numer should be specified with the correct country code. (ie. 46712345678)

string

from

Sender name or telephone number.  This can contain 3-11 letters between A-Z, or 3-15 numbers. If the telephone number is used and is to recieve replies, a relevant country code is required.

string

message

The content of the text message. A standard SMS contains 160 characters, which means that the text may be divided into several SMS's in the scenario that the number of characters should exceed the limit of 160. (Radbryt?) is sent as "%0a" and will count as 3 characters.

string

prio

There are 2 types of priorities. 1 will be the less relevant, with 2 being a high priority message. Priority 1 is suitable for group messages whilst with extremely time sensitive messages, a priority 2 will be more suitable. We recommend priority 1 for everyday use. No matter what priority used, the message will be delievered. However, there is usually only a slight variation in a number of minutes between the two types of priorities. 

string

Time configured SMS - Last updated: 2015-06-23 13:59:37

Send a time configured message to a group (or individual?)

returned value: SMS-ID or status code (See Appendix A)

Parameter

Description

Type

SendAt

Unix timestamp for the chosen time to send the SMS. A unix timestamp is the number of seconds since midnight the 1/1/1970 UTC. Swedish time as well as day light savings have to be considered.

 

For a description of relevant parameters, see section "SMS".

Group send SMS - Last updated: 2015-06-23 14:00:05

sends a message to a group of recipients.

returned value: Bundle-ID or status code (See Appendix A)

 

Parameter

Description

type

Acc

account ID

 

pass

Your API-Key

 

to

recipients telephone number in the format of a comma (,) seperated list.

 

from

Sender name or telephone number.  This can contain 3-11 letters between A-Z, or 3-15 numbers. If the telephone number is used and is to recieve replies, a relevant country code is required.

 

message

The content of the text message. A standard SMS contains 160 characters, which means that the text may be divided into several SMS's in the scenario that the number of characters should exceed the limit of 160. (Radbryt?) is sent as "%0a" and will count as 3 characters.

 

prio

There are 2 types of priorities. 1 will be the less relevant, with 2 being a high priority message. Priority 1 is suitable for group messages whilst with extremely time sensitive messages, a priority 2 will be more suitable. We recommend priority 1 for everyday use. No matter what priority used, the message will be delievered. However, there is usually only a slight variation in a number of minutes between the two types of priorities.

 

 

If the returned value is under 1000 it will be classified as a statuscode (See appendix A). If the value exceeds 1000 your SMS has been sent and the return value is its ID.

Time configured group send - Last updated: 2015-06-23 14:00:29

sends a message to a group recipient at a selected time.

returned value: Bundle-ID or status code (See Appendix A)

Parameter

Description

SendAt

Unix timestamp for the chosen time to send the SMS. A unix timestamp is the number of seconds since midnight the 1/1/1970 UTC. Swedish time as well as day light savings have to be considered.

For a description of relevant parameters, see section "SMS".

status Bundle - Last updated: 2015-06-23 14:02:30

The function uses a collection-ID and returns the last known status for every SMS in a specific collection.

returned value: A collection SMS, where every SMS contains a specific SMS-ID and their status code.

Parameter

Description

Type

bundleID

Collection-ID

string

Function Time - Last updated: 2015-06-23 14:03:01

the function uses an SMS-ID and returns a specific time for when a message has been planned to be sent.

returned value:

time when a specific SMS has been planned to be sent in the fomat of yyy-mmdd hh:mm:ss. If the specific message is not time configured or if an incorrect SMS-id has been submitted a return value of 0 will be given.

Parameter

Description

Type

Id

SMS-ID

string

URL Call - Last updated: 2015-06-23 14:04:59

an easy way to send an SMS is by using a URL Call. This can be done by simply creating a (HTTP GET-Call) to https://web.smscom.se/sendsms.aspx. If you can't call the function over SSL you can instead use https://web.smscom.se/sendsms.aspx.

 

Parameter

Description

Type

Acc

your account ID

string

Pass

your API-Key

string

Msg

A single SMS can contain a maximum of 160 characters (7bit GSM 03.38 encoding). This means that a message longer than this will be divided into seperate messages up to 152 characters, which will then be connected in the recipients phone. This means that a message containing 161 characters will be divided into 2 messages which means that your account will be charged for 2 sent messages.

 will be sent as ”%0a” accounting for 3 characters.

string

To

Telephone numbers shall be specified with the correct country code. ie. 46705555555.

string

From

your chosen sender. The sender name can contain max 11 characters. To be safe, we only recommend  A-Z and numbers 0-9 as some telephones can't handle other characters. if a telephone number is used as a sender ID the number has to include the correct country code.

string

Prio

Priority is divided into 3 different levels, where 1 is the lowest, with 3 being the highest priority. Prio 1 is suitable for normal group sends. Prio 3 is more suitable for critical messages such as alarms. We reccomend Prio 1 for casual use.

string