Utgående SMS - senast uppdaterad: 2015-08-10 16:36:57

Det finns tre olika sätt att ansluta till iP.1´s SMSgateway:

  • Web-service
  • URL-anrop
  • EXE-applikation

Vi rekomenderar dig att skapa en Web-service, då det finns mer funktioner att utveckla till denna typ av API. Leveranstiden på skickade SMS påverkas inte beroende på vilken anslutning du väljer.

För att se historik över skickade SMS, vänligen besök https://web.smscom.se/visastatus.aspx


Web-Service - senast uppdaterad: 2014-07-14 11:49:01

Adressen för vår Web-Service är https://web.smscom.se/sendSms/sendSms.asmx 

Via den här adressen hittar du också en hel del exempel på SOAP-anrop för varje funktion. 

Via denna adress hittar du en WSDL-beskrivning av tjänsten:https://web.smscom.se/sendSms/sendSms.asmx?WSDL 

Om du av något skäl har problem med SSL-anrop är det möjligt att använda följande länkar: http://web.smscom.se/sendSms/sendSms.asmx


Saldo - senast uppdaterad: 2016-10-04 09:16:57

Funktionen saldo kräver ett konto samt en API-nyckel för att returnera det aktuella saldot för ditt konto. Returnerat Värde: Balance

 

Parameter: Beskrivning: Typ:
acc Konto-id Sträng
pass Din API-nyckel Sträng

Beskrivning - senast uppdaterad: 2016-10-04 09:17:32

Funktionen hämtar en statuskod och returnerar en beskrivning. Se Appendix A för en gull specifikation över statuskoder och beskrivningar.

 

Parameter: Beskrivning: Typ:
ID Statuskod Sträng

Avbryt BundleSMS - senast uppdaterad: 2016-10-04 09:17:59

Funktionen använder ett ID för att avbryta tidsinställda meddelanden och avbryter eventuella planerade utskick.

Returnerat värde: Om tidsinställda utskick finns returneras 0. Om det inte finns några meddelanden på kö returneras felmeddelande (Se Tillägg A).

Parameter: Beskrivning: Typ:
Acc Konto-id Sträng
pass Din API-nyckel Sträng
BundleID ID för Bundle Sträng

Avbryt enskillt SMS - senast uppdaterad: 2016-10-04 09:18:19

Funktion använder ett ID för ett SMS och avbryter det.

Returnerat värde: Om handlingen lyckas får du värde 0. Om inte returneras ett felmeddelande. (Se Appendix A)

 

Parameter: Beskrivning: Typ:
Acc Konto-id Sträng
pass Din API-nyckel Sträng
smsID ID för SMS Sträng

Flash-SMS - senast uppdaterad: 2014-07-14 11:51:53

Skicka ett så kallat Flash-SMS. Ett Flash-SMS visas direkt i mottagarens skärm utan att någon handling behöver göras. Meddelandet sparas inte automatiskt i telefonen, utan måste sparas mannuellt.

Returnerat Värde: SMS-id eller statuskod (se Appendix A)

Parametrar för FlashSMS hittar du under avsnittet SMS.


SMS - senast uppdaterad: 2017-12-01 08:40:37

Skicka ett SMS

Returnerat värde: SMS-ID eller statuskod

Parameter: Beskrivning: Typ:
Acc Konto-id Sträng
pass Din API-nyckel Sträng
till Mottagarens telefonnummer. Numret ska vara specifierat med aktuell landskod (ex. 46712345678). Sträng
from Avsändartext eller telefonnummer. Detta fält får innehålla mellan 3 - 11 tecken, A-Z eller 3 - 15 siffror. Om telefonnummer används och ska kunna mottaga svar krävs även här aktuell landskod. Sträng
meddelande Själva innehållet i ditt SMS. Ett standard-SMS innehåller 160 tecken vilket betyder att texten delas upp i flera SMS ifall denna gräns överskrids. Radbryt skickas som "%0a" och räknas alltså som tre tecken. Sträng
prio Det finns två olika prioriteter, där 1 är den minsta och 2 är den högsta. Prio 1 passar alldeles utmärkt till gruppmeddelanden medan extremt tidskänsliga meddelanden kan behöva prio 2. Vi rekomenderar prio 1 vid vanligt bruk. Oavsett vilken Prio som används så levereras SMS:en, det rör sig bara om minuter mellan de olika prioriteterna i vanliga fall. Sträng

Om returnerat värde är under 1000 så är det en statuskod (Se Appendix A). Om värdet överstiger 1000 så har ditt SMS skickats och returnerat värde är dess ID.


Tidsintällt SMS - senast uppdaterad: 2016-10-04 09:19:08

Skicka ett tidsinställt SMS vid önskad tidpunkt.

Returnerat Värde: SMS-ID eller statuskod (se Appendix A).

 

Parameter: Beskrivning: Typ:
sendAt Unix timestamp för vald tid att skicka ut SMS. En Unix timestamp är de antal sekunder sen midnatt sen den första januari 1970 UTC. Svensk tid och sommartid måste räknas med i ekvationen. Sträng

 

 

För en beskrivning av tillhörande parametrar, vänligen se avsnittet för SMS.


Grupputskick SMS - senast uppdaterad: 2016-10-04 09:19:26

Skickar ett meddelande till en grupp mottagare.

Returnerat värde: Bundle-ID eller statuskod (se Appendix A)

 

Parameter: Beskrivning: Typ:
acc Konto-id Sträng
pass Din API-nyckel Sträng
till Mottagarnas telefonnummer i form av en kommaseparerad lista. Sträng
from Avsändartext eller telefonnummer. Detta fält får innehålla mellan 3 - 11 tecken, A-Z eller 3 - 15 siffror. Om telefonnummer används och ska kunna mottaga svar krävs även här aktuell landskod. Sträng
meddelande Själva innehållet i ditt SMS. Ett standard-SMS innehåller 160 tecken vilket betyder att texten delas upp i flera SMS ifall denna gräns överskrids. Radbryt skickas som "%0a" och räknas alltså som tre tecken. Sträng
prio Det finns tre olika prioriteter, där 1 är den minsta och 3 är den högsta. Prio 1 passar alldeles utmärkt till gruppmeddelanden medan larm-sms kan behöva prio 3. Vi rekomenderar prio 1 eller 2 för normalt bruk. Sträng

 

 

Om returnerat värde är under 1000 så är det en statuskod (Se Appendix A). Om värdet överstiger 1000 så har ditt SMS skickats och returnerat värde är dess ID.


Tidsintällt grupputskick - senast uppdaterad: 2016-10-04 09:19:56

Skickar ett meddelande till en grupp mottagare vid en angiven tidpunkt

Returnerat Värde: Bundle-ID eller Statuskod (se Tillägg A).

 

Parameter: Beskrivning: Typ:
sendAt Unix timestamp för vald tid att skicka ut SMS. En Unix timestamp är de antal sekunder sen midnatt sen den första januari 1970 UTC. Svensk tid och sommartid måste räknas med i ekvationen. Sträng

 

 

För resterande parametrar, se avsnittet "SMS".


Status - senast uppdaterad: 2016-10-04 09:20:11

Funktionen använder ett SMS-ID och returnerar den senaste kända statusen för ett specifikt sms. Leveransstatusen kan till exempel tala om att meddelandet har levererats till mottagarens telefon, eller om det levererats till GSM-nätet. Se tillägg A för en komplett lista med statuskoder och deras beskrivningar.

 

Returnerat värde: Statuskod

Parameter Beskrivning Typ
id SMS-ID sträng

statusBundle - senast uppdaterad: 2016-10-04 09:20:45

Funktionen använder ett samlings-ID och returnerar senast kända status för varje SMS i en specifik samling.

 

Returnerat värde: En samling SMS, där varje SMS innehåller ett specifikt SMS-id och dess statuskod.

Parameter Beskrivning Typ
bundleID Samlings-ID sträng

 


Tidpunkt - senast uppdaterad: 2016-10-04 09:21:00

Funtkionen använder ett SMS-ID och returnerar en tidpunkt då det är planerat för utskick.

Returnerat värde:

Tidpunkt då ett specifikt SMS är planerat för utskick I formatet yyyy-mmdd hh:mm:ss. Om det specifika meddelandet inte är tidsinställt eller om man angivit ett felaktigt SMS-id returneras värdet 0.

 

Parameter Beskrivning Type
Id SMS-ID sträng

URL-anrop - senast uppdaterad: 2016-10-04 09:21:20

Ett enkelt sätt att skicka iväg sms på är att använda sig av ett URL-anrop. Man skapar då ett enkelt HTTP GET-anrop till http://web.smscom.se/sendsms.aspx. Om du inte kan anropa funktioner över SSL kan du istället använda dig utav http://web.smscom.se/sendsms.aspx

Exempelhttp://web.smscom.se/sendsms.aspx?acc=ip1-1000&pass=******&to=46730123456&from=ip1&msg=Test+SMS&prio=1

 

Parameter Description Type
Acc Ditt konto-ID sträng
Pass Din API-nyckel sträng
Msg Ett enskillt SMS får max vara 160 tecken (7bit GSM 03.38 encoding). Det betyder att längre SMS blir uppdelade I flera meddelanden upp till 152 tecken som sedan sätts ihop igen I mottagarens telefon. Det betyder att ett meddelande som innehåller 161 tecken blir uppdelade i två SMS vilket innebär att ditt saldo blir debiterat för två SMS. Radbryt skickas som ”%0a” (Alltså tre tecken). sträng
To Telefonnummer ska vara specificerade med korrekt landskod (t.ex  46705555555). sträng
From Din avsändare. Avsändaren får bestå av max 11 tecken. För att vara på den säkra sidan rekommenderar vi att bara använda versaler och gemener (A-Z) samt siffror (0-9), då vissa telefoner inte kan hantera andra tecken. Om ett telefonnummer används som avsändare så måste numret innehålla korrekt landskod (t.ex  46705555555). sträng
Prio Prioritet delas upp I tre olika nivåer där 1 är lägsta prioritet och 3 är högsta. Prio 1 passar för vanliga grupputskick, Prio 3 passar bättre till kritiska meddelanden så som larm. Vi rekomenderar Prio 1 för vanligt bruk. sträng

Inkommande SMS - senast uppdaterad: 2016-10-04 09:22:11

För att ta emot inkommande SMS behöver du ett telefonnummer. I dagens läge finns möjligheten att välja ett virtuellt nummer med 11 siffror samt 5 siffror och prefix. Kom ihåg att avsändaren inte får bestå av ett nummer längre än 11 tecken och det bara är möjligt att ta emot meddelanden från vår server om detta krav är uppfyllt.


Callback - senast uppdaterad: 2016-10-04 09:23:47

Callback

Det enklaste sättet att hantera inkommande SMS är att skapa en webb-applikation och sedan registrera en callback-URL för mottagarnumret hos oss.

När ett meddelandet tas emot av vår gateway så genomförs ett HTTP GET-anrop till callback-URL:en med följande parametrar:

 

Parameter Beskrivning Typ
Text Meddelandets innehåll sträng
To Mottagarens telefonnummer sträng
Sender Avsändaren sträng
incsmsid ID-nummer sträng

 

Exempel: Om din callback-URL är http://www.example.com/smscallback.php ser anropet ut så här:

http://www.example.com/smscallback.php?incsmsid=123456789&sender=46732222 22&text=testmeddelande&to=4673XXXXXXXXXXX  

Det är också möjligt att skapa ett anrop med query-strängar, till exempel: http://www.example.com/smscallback.php?someparam=somevalue  

Som svar på ditt callback-anrop ska din application returnera ett oformaterat OK (två tecken, utan formatering). Om ditt anrop inte lyckas eller om du får ett annat svar från servern så kommer servern att försöka igen med en intervall på 30 minuter, maximalt tio försök.

Koppla på en Callback-URL

När du har en färdig Callback-url måste du registrera den på https://app.ip1sms.com/settings/#extra. Klistra in din URL i text-fältet ”Callback URL och spara dina inställningar.


Utgående MMS - senast uppdaterad: 2016-10-04 09:23:58

Utgående MMS-meddelande skickas med hjälp av en SOAP-baserad web-service, liknande web-servicen för SMS-meddelanden. Observera att avsändaren inte kan specificeras som text när du skickar MMS-meddelanden.

Web-service MMS

Adressen till Web-servicen är: 

https://web.smscom.se/mms/mms.asmx  

Via den här adressen hittar du också exempel på SOAP-anrop för varje function.

En WSDL-beskrivning hittar du via: https://web.smscom.se/mms/mms.asmx?WSDL  

Om du av någon anledning inte kan genomföra SSL-anrop har du möjlighet att använda dig utav följande URL:er:

http://web.smscom.se/mms/mms.asmx  https://web.smscom.se/mms/mms.asmx?WSDL  


sendMMS - senast uppdaterad: 2016-10-04 09:22:58

Skickar ett MMS-meddelande. 

Returnerat värde: MMS-ID eller statuskod (Se tillägg B). 

Om returnerat värde är under 1000 så har du fått en statuskod (Se Tillägg B), annars så har meddelandet skickats och det värdet du fått är meddelandets ID-kod.

 

Parameter beskrivning Typ
Acc Ditt Konto-ID sträng
pass Din API-nyckel sträng
msg Textdelen I ditt meddelande. Radbryt skapas genom tecken-strängen “%0a” (utan citattecken). sträng
to Mottagarens telefonnummer. sträng
from Avsändarens telefonnummer (t.ex 46705555555). Bokstäver accepteras inte som avsändare vid utskick av MMS. sträng
files Filer är skickade som base64-encoded binärdata. ett arbiträrt antal filer kan bifogas, men kan tillsammans inte överstiga en storlek på 300 kB. sträng

status MMS - senast uppdaterad: 2016-10-04 09:23:16

Funktion använder ett MMS-ID och returnerar senast kända status för det specifika MMS-meddelandet. Statusen kan till exempel innebära ”levererad till mottagaren” eller ”levererad till GSM-nät”. Se Tillägg B för en komplett lista med statuskoder samt beskrivning av dessa.

Returnerat värde: Status-kod (se tillägg B)

 

Parameter Description Type
mmsId MMS-ID sträng

Inkommande-MMS - senast uppdaterad: 2014-07-14 11:54:44

För att ta emot ett MMS-meddelande behöver du ett virtuellt 11-siffrigt mottagarnummer som iP.1 Tillhandahåller.


Tillägg A: Status-koder för SMS - senast uppdaterad: 2016-10-04 09:24:48

 

Kod Status Beskrivning/handling
0 Delivered to gateway  
1 Gateway login failed Kontrollera konto-ID och API-nyckel
2 Invalid message content Kontrollera ditt meddelandeinnehåll
3 Invalid phone number format Kontrollera mottagarens nummer
4 Insufficient funds Fyll på ditt saldo och försök igen
10 Received by the gateway Leverans pågår
11 Delayed delivery Leverans pågår
12 Delayed delivery cancelled Leveransen är avbruten
21 Delivered to the GSM network Leverans pågår
22 Delivered to the phone Leverans är bekräftad
30 Insufficient funds Fyll på ditt saldo och försök igen
41 Invalid message content Kontrollera ditt meddelandeinnehåll
42 Internal error Leverans misslyckades
43 Delivery failed Leverans misslyckades
50 General delivery error Leverans misslyckades
51 Delivery to GSM network failed Leverans misslyckades
52 Delivery to phone failed Leverans misslyckades
100 Insufficient credits Fyll på ditt saldo och försök igen
101 Wrong account credentials Kontrollera ditt konto-ID och/eller API-nyckel
110 Parameter error Kontrollera din kod, något är galet

 


Tillägg B: Status-koder för MMS - senast uppdaterad: 2016-10-04 09:25:03

Code Status Description/action
0 Delivered to gateway  
1 Gateway login failed Kontrollera ditt konto-ID och/eller API-nyckel
2 Invalid message content Kontrollera ditt meddelandeinnehåll
3 Invalid phone number format Kontrollera mottagarens nummer
4 Insufficient funds Fyll på ditt saldo och försök igen
11 Delayed delivery Leverans pågår
21 Delivered to the GSM network Leverans pågår
22 Delivered to the phone Leverans bekräftat
30 Insufficient funds Fyll på ditt saldo och försök igen
41 Invalid message content Kontrollera ditt meddelandeinnehåll
42 Internal error Leverans misslyckades
44 Delivery failed Leverans misslyckades
45 Invalid phone number Leverans misslyckades
50 General delivery error Leverans misslyckades

Tillägg C: Datatyper - senast uppdaterad: 2016-10-04 09:25:22

Egenskaper Beskrivning Typ
Number Format Telefonnummer sträng
Parameters Lista för parametrar som tillåter dig att byta ut text I meddelandet med ett unik värde för varje mottagare. TemplateField[] (Se TemplateField.) sträng

TemplateField - senast uppdaterad: 2016-10-04 09:25:46

Egenskaper Beskrivning Typ
Key Matchar värde I meddelandetext sträng
Value Byter ut matchad text med det angivna värdet sträng