SMS-rajapinnat

Tekstiviestit

Päivitetty viimeksi: 15.9.2022

Primuksesta ja Wilmasta voi lähettää tekstiviestejä, kunhan käytössä on Visma SMS -rajapintapalvelu. Jos palvelu ei ole vielä käytössänne, voit hankkia sen täältä. Palvelun saa käyttöön maksutta, käyttökulut muodostuvat lähetettyjen viestien määrän perusteella.

Primus tukee vielä toistaiseksi Visma SMS -rajapinnan lisäksi muitakin rajapintoja, niiden käyttöön liittyvät ohjeistukset löydät alempaa tästä ohjeesta. Näiden rajapintojen tukemisesta kuitenkin luovutaan tulevaisuudessa, joten suosittelemme ottamaan mahdollisimman pian käyttöön Visma SMS -rajapinnan, ellei se ole teillä jo ennestään käytössä.

Kun Visma SMS -rajapintapalvelu on hankittuna, täytä Koulun tiedot -rekisteriin seuraavat asetukset niiden koulujen rekisterikorteille, joilla haluat tekstiviestien lähettämisen olevan käytössä:

  • Oikeus lähettää tekstiviestejä: rasti kenttä
  • SMS palvelimen tyyppi: "Visma SMS"
  • SMS lähettäjän nimi: Kirjoita kenttään lähettäjän nimi, joka näkyy viestin vastaanottajalle. SMS lähettäjän nimi -kenttään tallennetaan informatiivinen tieto, joka näkyy vastaanottajalla viestin lähettäjänä. Lähettäjän nimi saa olla korkeintaan 11 merkkiä pitkä. Sallitut merkit ovat a-z, A-Z ja 0-9.

Muita SMS-asetuksiin liittyviä kenttiä ei tarvitse täyttää. Jos teillä on esim. jonkin muun rajapinnan käytön jäljiltä täytettynä seuraavat kentät, niin tyhjää niissä olevat tiedot:

  • SMS portti
  • SMS osoite
  • SMS tunnus
  • SMS salasana
  • SMS välityspalvelu

Tämä rajapinta on korvattu Arena Interactive SmartDialog -rajapinnalla, ks. ohje alempana. Jos käytössänne on ollut tähän asti Arena Interactive, vaihtakaa asetukset Arena Interactive SmartDialog -rajapinnan mukaisiksi sen jälkeen, kun olette sopineet rajapintamuutoksesta Arenan kanssa.

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "Arena Interactive"
  • SMS-osoite: Operaattoriltasi saamasi osoite
  • SMS portti: 80
  • SMS tunnus: Operaattoriltasi saamasi tunnus
  • SMS salasana: Operaattoriltasi saamasi salasana
  • SMS välityspalvelu: Kirjoita kenttään VISMA, jos käytössänne on useita Arenan viestipalveluja. Jos ei, jätä tyhjäksi.
  • SMS lähettäjän nimi: Kirjoita kenttään lähettäjän nimi, joka näkyy viestin vastaanottajalle. Jos kenttää ei ole täytetty, vastaanottajalle näkyy operaattorin kanssa määritelty selkokielinen lähettäjän nimi.

Lisätietoa

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "Arena Interactive SmartDialog"
  • SMS-SMTP-domainnimi: e1 tai e0 riippuen käytössä olevasta SMS-osoitteesta. Jos et tiedä kumpaa tulee käyttää, selvitä tieto Arenalta.
  • SMS tunnus: Operaattoriltasi saamasi tunnus
  • SMS salasana: Operaattoriltasi saamasi salasana
  • SMS välityspalvelu: Kirjoita kenttään VISMA, jos käytössänne on useita Arenan viestipalveluja. Jos ei, jätä tyhjäksi.
  • SMS lähettäjän nimi: Kirjoita kenttään lähettäjän nimi, joka näkyy viestin vastaanottajalle. Jos kenttää ei ole täytetty, vastaanottajalle näkyy operaattorin kanssa määritelty selkokielinen lähettäjän nimi.

Kentät SMS osoite ja SMS portti jätetään tyhjiksi.

Aspsms.com-palvelun saa käyttöön rekisteröitymällä osoitteessa www.aspsms.com.

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "aspsms.com"
  • SMS tunnus: (saat tunnuksen rekisteröityessäsi palveluun)
  • SMS salasana: (saat salasanan rekisteröityessäsi palveluun)
  • SMS osoite: xml2.aspsms.com
  • SMS portti: 5061
  • SMS lähettäjän nimi: Kirjoita teksti, jonka halutaan näkyvän viestin lähettäjänä, esim. "OpeVaasa". Lähettäjätiedon on oltava tekstiä, ei numero.

Lisätietoa

Lisätietoja tästä vaihtoehdosta saat tuestamme tai Bitracelta. Ottaessasi yhteyttä, kerro, että kyse on Visma InSchoolin Wilma- tai Primus-järjestelmästä.

Palvelu otetaan käyttöön tilaamalla Elisalta Dialogi. Kerro, että olet ottamassa käyttöön http API -rajapinnan.

Tämä rajapinta sallii liikenteen vain salattuna (https), ja siksi täytyy varmistaa, että Primuksen palvelimen asennushakemistossa on tiedostot libeay32.dll ja ssleay32.dll.

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "Elisa Dialogi"
  • SMS osoite: viestipalvelu-api.elisa.fi
  • SMS portti: 443
  • SMS salasana: Täytä kenttään API key, jonka saa Dialogi-palvelun asetussivuilta tai Elisalta.
  • SMS lähettäjän nimi: Kentässä olevassa nimessä voi olla max. 11 alfanumeerista merkkiä tai 15 numeroa. Tämä näkyy viestin vastaanottajille.

Täytä seuraavat kentät:

  • SMS osoite: gate.cc.elisa.fi
  • SMS-portti: 80
  • Täytä myös SMS tunnus- ja SMS salasana -kentät.
  • Lähettäjän nimi: Jätä tyhjäksi, kenttää ei huomioida.

Lisätietoja tästä vaihtoehdosta saat tukipalvelustamme tai Fujitsulta. Ottaessasi yhteyttä Fujitsuun, kerro, että kyse on Visma InSchoolin Wilma- tai Primus-järjestelmästä.

Täytä kentät SMS osoite, SMS portti, SMS tunnus ja SMS salasana. SMS-palvelimen tyyppi -kenttään valitaan "Kannel http".

Lisätietoa palvelusta saat tuestamme tai Link Mobilityltä. Ottaessasi yhteyttä Link Mobilityyn kerro, että kyse on Visma InSchoolin Wilma- tai Primus-järjestelmästä.

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "Link Mobility"
  • SMS osoite: gw.labyrintti.com
  • SMS portti: 28443 (vaihtoehtoisesti myös 28080 käy, mutta se on salaamaton toisin kuin 28443)

Lisätietoa

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "Messto"
  • SMS osoite: www.messto.com
  • SMS portti: 443
  • SMS tunnus: Saat tunnuksen operaattorilta.
  • SMS salasana: Saat salasanan operaattorilta.
  • Lähettäjän nimi: Jätä tyhjäksi, kenttää ei huomioida.

Lisätietoa

Viestit lähtevät operaattorin viestikeskuksen kautta. Ennen toiminnon käyttöönottoa tulee selvittää, mikä operaattori on kunnan palveluntarjoaja, onko kunnalla jo sopimus viestikeskuksen käyttämisestä ja ellei ole, mitä viestien lähettäminen SMPP-protokollalla viestikeskuksen kautta vaatisi. Tätä vaihtoehtoa tukee ainakin DNA.

Paikallisen operaattorin viestipalvelinta käytettäessä valitaan SMS palvelimen tyyppi -kenttään "SMPP V3.4". SMPP-ohjeet ja tunnukset saa koulun/kunnan käyttämältä operaattorilta. Operaattorille tulisi mainita, että lähetyksessä käytetään SMPP-protokollaa.

Viestien hinta ja palvelun toimitusaika vaihtelee operaattorin mukaan.

Täytä seuraavat kentät:

  • SMS osoite: api.quriiri.fi
  • SMS portti: 80
  • SMS lähettäjän nimi: Kentässä olevassa nimessä voi olla max. 11 alfanumeerista merkkiä tai 15 numeroa.
  • SMS salasana: Täytä kenttään API key, jonka saa Quriirin asetussivuilta.
  • SMS välityspalvelu siirretään laskutuksen ohjaustietona (billingref), jos se on koulun kortille täytetty.

Lisätietoa

SMTP-rajapinta toimii sellaisilla palvelimilla, joille voi lähettää tekstiviestejä sähköpostin välityksellä. Tämä vaihtoehto toimii esim. Kannel-järjestelmällä.

Sähköpostin vastaanottajaksi merkitään pelkkä vastaanottajan puhelinnumero, esim. "0501234567". Numeron perään lisätään automaattisesti SMS-SMTP -domainnimi, esim. "@sms.mallila.fi". Sähköpostin otsikoksi (Subject-rivi) laitetaan SMS salasana -kentän tieto. Viestiosuuteen kirjoitetaan varsinainen tekstiviestin sisältö. SMS tunnus -kenttään merkitään viestin lähettäjä, esim. "[email protected]". Tunnuksella tulee olla oikeus lähettää tekstiviestejä.

Postipalvelin tarkistaa salasanan sekä onko "[email protected]":llä oikeus lähettää tekstiviestejä. Jos salasana ja oikeudet ovat kunnossa, postipalvelin lähettää sähköpostin tekstiviestinä matkapuhelimeen.

  • SMS palvelimen tyyppi: "SMTP-rajapinta"
  • SMS-SMTP domainnimi: Täytä tekstiviestipalvelimen domain-nimi
  • Täytä myös SMS osoite ja SMS portti.

Täytä seuraavat kentät:

  • SMS palvelimen tyyppi: "Telia http CGW"
  • Täytä myös kentät SMS osoite ja SMS portti.
  • SMS lähettäjän nimi: Täytä lähettävä puhelinnumero, lyhytnumero tai lähettäjän nimi. Lähettäjän nimi annetaan muodossa dollarinmerkki+nimi, esim. $Mallilan kunta. Lähettäjänä näkyy annettu puhelinnumero tai annettu nimi.

Täytä seuraavat kentät:

  • SMS osoite: api.opaali.telia.fi
  • SMS portti: 443
  • SMS palvelimen tyyppi: "Telia Mobiiliviesti"
  • SMS välityspalvelu: Täytä kenttään joko puhelinnumero tai lyhytnumero. Jos lyhytnumeroa ei ole käytössä, tulisi numeroksi laittaa lähettäjän puhelinnumero muodossa +358000000000.
  • SMS lähettäjän nimi: Täytä kenttään nimi, joka koostuu max. 11 merkistä. Tämä näkyy viestin vastaanottajille.
  • SMS tunnus ja SMS salasana: Täytä tunnus ja salasana, jonka saat luomalla applikaation Telian Opaali-profiiliin. Applikaatiotyyppi voi olla Receive only MO (mobile originated) -liikennettä varten tai Massalähetys (bulk) MT (mobile terminated) -liikennettä varten. Jos käytössä ei ole lyhytnumeroa, käytetään Massalähetys-palvelua.

Lisätietoa

Tämä rajapinta sallii liikenteen vain salattuna (https), ja siksi täytyy varmistaa, että Primuksen palvelimen asennushakemistossa on tiedostot libeay32.dll ja ssleay32.dll.

Täytä seuraavat kentät:

  • SMS osoite: ws.mkv.sonera.fi
  • SMS portti: 443
  • SMS tunnus: Telialta saamasi tunnus
  • SMS salasana: Telialta saamasi salasana
  • SMS lähettäjän nimi: Täytä kenttään nimi, joka voi olla max. 11 merkkiä alfanumeerisena tai 15 merkkiä numeroina.