Kehittäjä DOC - SMSMobileAPI

SMS-dokumentaatio

SMSmobileAPI-kehittäjien dokumentaatio

SMSmobileAPI:lla pyrimme tekemään API:sta mahdollisimman yhteensopivan minkä tahansa arkkitehtuurin tai alustan kanssa.
Käytätpä sitten RESTiä, SOAPia, cURL:ää tai erilaisia ohjelmointikieliä, kuten Python, JavaScript, PHP ja paljon muuta, API on suunniteltu integroitumaan saumattomasti projekteihisi.

Meillä on myös käyttövalmiita laajennuksia verkkokaupan ratkaisuihin ja ohjelmistoihin. Klikkaa tästä löytääksesi ne.

.

API REST

cURL

Composer

JavaScript

Python

Node.js

Rubiini

WSDL

Todennus

API-AVAIN
OAuth2

Lähetä SMS

Tämän päätepisteen avulla voit lähettää tekstiviestin matkapuhelimellasi.

Päätepiste:

SAADA LÄHETTÄÄ https://api.smsmobileapi.com/sendsms/

Parametrit:

- apikey: Ainutlaatuinen API-avaimesi.

- recipients: Vastaanottajan puhelinnumero.

- message: Lähetettävä viesti (Viestin pituus ei ole rajoitettu 160 merkkiin; voit lähettää pidempiä viestejä)

- sendwa: 1 = viesti on lähetettävä WhatsAppin kautta.

- sendsms: 1 = viesti tulee lähettää perinteisellä tekstiviestillä. (Jos lähetyksiä on tyhjä: lähetetty oletuksena, aseta arvoksi 0 estääksesi tekstiviestin)

- schedule_timestamp = Ilmoittaa aikaa, josta alkaen tekstiviesti tulee lähettää - täytyy olla **UNIX-aikaleima (GMT 0)**

Esimerkki:


        HANKI https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld

Huomautus: Jos operaattorisi aiheuttaa toimitusvirheen, oletustoiminto yrittää lähettää saman tekstiviestin uudelleen enintään 3 kertaa määritetyn aikavälin sisällä.

Lähetä uudelleen lähettämätön tekstiviesti

Tätä API-päätepistettä käytetään lähettämättömän tekstiviestin lähettämiseen uudelleen (vain jos viestissä on virhetila)

Päätepiste:

SAADA LÄHETTÄÄ https://api.smsmobileapi.com/resend/

Parametri:

- guid: (pakollinen) Uudelleenlähetettävän viestin GUID.

Esimerkki:


        HANKI https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE

API:lta lähetetty tekstiviestiloki

Tätä API-päätepistettä käytetään API:n kautta lähetettyjen tekstiviestien lokin hakemiseen.

Päätepiste:

SAADA https://api.smsmobileapi.com/log/sent/sms/

Parametri:

- apikey: (pakollinen) API-avaimesi.

- guid_message: lyhennetään lajitteluun ja suodatukseen käytetyn viestin yksilöllisen tunnisteen mukaan.

- before: Hae viestit, jotka on lähetetty ennen tätä tiettyä aikaleimaa tai GUID-tunnusta.

- error_api: Kirjoita `1` (`&error_api=1`), jos haluat luetella kaikki tekstiviestit, jotka havaitsivat virheen API-pyynnön aikana.

- error_mobile: Kirjoita `1` (`&error_mobile=1`) listataksesi kaikki tekstiviestit, joissa havaittiin virhe mobiilikäsittelyn aikana.

- keyword: Avainsana viestien suodattamiseen vastaanottajan numeron tai tekstiviestin sisällön perusteella.

Esimerkki:


        HANKI https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY

SMS vastaanotettu

Tätä API-päätepistettä käytetään älypuhelimeen vastaanotettujen tekstiviestien noutamiseen.

Päätepiste:

SAADA https://api.smsmobileapi.com/getsms/

Parametri:

- apikey: API-avain, joka sinulla on tai saat.

Esimerkki:


        HANKI https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY

Poista tekstiviesti

Tätä API-päätepistettä käytetään tekstiviestien poistamiseen SMS Mobile API:n palvelinlokista

Päätepiste:

SAADA https://api.smsmobileapi.com/deletesms/

Parametri:

- apikey: Sinulla oleva API-avain.

- guid_message: Poistettavan viestin yksilöllinen tunnus.

- date_start: Yksin käytettynä poistaa kaikki viestit määritetyltä päivältä.

- date_start and date_end: Yhdistetty viestien poistamiseen tietyn ajan kuluessa.

Esimerkki:


        HANKI https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

Huomautus: Poistetut tekstiviestit ovat vain ne, jotka on tallennettu mobiilisovellustilisi lokeihin. Itse mobiililaitteen tekstiviestejä ei poisteta, koska meillä ei ole pääsyä niihin.

Webhook – SMS vastaanotettu

Tämä webhook-järjestelmä lähettää POST-pyynnön määritettyyn URL-osoitteeseen aina, kun tekstiviesti vastaanotetaan. Järjestelmä varmistaa reaaliaikaiset päivitykset toimittamalla tekstiviestin tiedot määritettyyn webhook-URL-osoitteeseen.

Webhookin määrittäminen hallintapaneelissa

Määritä webhookin URL-osoite hallintapaneelissa noudattamalla näitä ohjeita:

Kirjaudu tilillesi osoitteessa SMS Mobile API Dashboard.
Navigoi kohtaan Webhook-asetukset osio.
Anna webhookin URL-osoite (esim. https://example.com/webhook-endpoint
Napsauta Tallenna Webhook -painiketta.
Kun järjestelmä on tallennettu, se alkaa lähettää tekstiviestitietoja määritettyyn URL-osoitteeseen.

Webhook-hyötykuorma

Kun tekstiviesti vastaanotetaan, järjestelmä lähettää seuraavan JSON-hyötykuorman webhook-URL-osoitteeseen:

{

    "päivämäärä": "2025-01-20",

    "tunti": "10:15:00",

    "aika_vastaanotettu": "2025-01-20 10:14:50",

    "message": "Hei, tämä on testi."

    "numero": "+123456789",

    "guid": "abcde12345"

}

Hyötykuormakentät:

päivämäärä: Päivämäärä, jolloin tekstiviesti lisättiin (VVVV-KK-PP).
tunnin: Tunti, jolloin tekstiviesti lisättiin (HH:mm:ss).
time_received: Aika, jolloin tekstiviesti vastaanotettiin.
viesti: Tekstiviestin sisältö.
määrä: Lähettäjän puhelinnumero.
opas: SMS-viestin yksilöllinen tunniste.

Esimerkki Webhook-päätepiste

Palvelimesi pitäisi olla valmis käsittelemään saapuvia POST-pyyntöjä. Alla on esimerkki PHP-skriptistä webhook-hyötykuorman käsittelemiseksi:

<?php

// Lue saapuva hyötykuorma

$payload = file_get_contents('php://input');

$data = json_decode($payload, tosi);




// Käsittele tekstiviestitiedot

if ($data) {

    // Esimerkki: Kirjaa tekstiviestitiedot tiedostoon

    file_put_contents('sms_log.txt', print_r($data, true), FILE_APPEND);




    // Vastaa HTTP 200 -tilalla

    http_vastauskoodi(200);

    echo "Webhook vastaanotettu onnistuneesti.";

} muu {

    // Vastaa HTTP 400 -tilalla huonoihin pyyntöihin

    http_vastauskoodi(400);


    echo "Virheellinen hyötykuorma.";

}

?>

Webhookin testaus

Voit testata webhookin määrityksiä käyttämällä työkaluja, kuten:

Näiden työkalujen avulla voit tarkastaa järjestelmän lähettämän hyötykuorman ja korjata mahdolliset webhook-asetuksiin liittyvät ongelmat.

Vianetsintä

Varmista, että webhookin URL-osoite on oikea ja julkisesti saatavilla.
Varmista, että palvelimesi palauttaa HTTP 200 -tilakoodin onnistuneille pyynnöille.
Tarkista palvelimesi lokeista hyötykuorman käsittelyssä tapahtuneet virheet.

Todennus

SMSMobile API tukee kahta todennusmenetelmää: käyttämällä yksinkertaista API-avainta tai OAuth2-protokollaa, jossa on asiakastunnus ja asiakassalaisuus.

1. API-avaimen todennus

Tämä menetelmä vaatii API-avaimen, joka voidaan sisällyttää parametriksi joko GET- tai POST-pyyntöön. Se on suoraviivainen tapa todentaa API-pyyntösi.

2. OAuth2-todennus

OAuth2 tarjoaa turvallisemman ja skaalautuvamman todennusmenetelmän.
Sinun on käytettävä asiakastunnusta ja asiakassalaisuutta saadaksesi pääsytunnuksen, joka tulee sitten sisällyttää API-pyyntöihisi käyttämällä Valtuutus otsikko.

Asiakastunnus ja client_secret ovat saatavilla hallintapaneelissasi, ja ne ovat käytettävissä, kun olet asentanut sovelluksen ja luonut tilin mobiililaitteellesi.
Lataa mobiilisovellus nyt tai päästä kojelautaan.

Käyttöoikeustunnuksen hankkiminen

Saadaksesi käyttöoikeustunnuksen, lähetä POST-pyyntö tunnuksen päätepisteeseen asiakastunnuksellasi ja asiakkaan salaisuudella.


curl -X POST https://api.smsmobileapi.com/oauth2/token \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "grant_type=client_credentials" \

-d "client_id=1ab0ex4b4c1ef2c800690d" \

-d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

Käyttöoikeustunnuksen käyttäminen:

Kun sinulla on käyttöoikeustunnus, sisällytä se Valtuutus API-pyyntöjesi otsikko:


curl -X POST https://api.smsmobileapi.com/sendsms \

-H "Valtuutus: siirtotie abc123xyz456" \

-H "Sisältötyyppi: Application/x-www-form-urlencoded" \

-d "vastaanottajat=+1234567890" \

-d "viesti=Hei"

Mitä menetelmää sinun tulisi käyttää?

- Käytä API-avaimen todennus nopeaa ja suoraviivaista integrointia varten.

- Käytä OAuth2-todennus parantaaksesi integraatioidesi turvallisuutta ja skaalautuvuutta.

Katso lisätietoja täydellisestä dokumentaatiosta.

Lähetä SMS

WSDL URL

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

Parametrit:

- recipients: Vastaanottajan matkapuhelinnumero.

- message: Viesti lähetettäväksi. (Viestin pituus ei ole rajoitettu 160 merkkiin, voit lähettää pidempiä viestejä)

- apikey: API-avain, joka sinulla on tai saat.

Esimerkki


                require_once "lib/nusoap.php";

                

                $client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);

                $error  = $client->getError();

                

                $result = $client->call("sendSms", array("recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));

                

                print_r($result);

Lähetä SMS & WhatsApp

Perus cURL-komento

Voit käyttää seuraavaa cURL-komentoa lähettääksesi tekstiviestin SMSmobileAPI:n kautta:


        curl -X POST https://api.smsmobileapi.com/sendsms/ \

        -d "recipients=PHONE_NUMBER" \

        -d "message=YOUR_MESSAGE" \

        -d "apikey=YOUR_API_KEY" 

		
		 -d "sendwa=1"

		 -d "sendsms=1"

cURL-esimerkki PHP:ssä

Jos käytät PHP:tä, voit lähettää tekstiviestin cURL:n avulla seuraavasti:


        <?php

        

        $url = 'https://api.smsmobileapi.com/sendsms/';

        $data = array(

            'recipients' => 'PHONE_NUMBER',

            'message' => 'YOUR_MESSAGE',

            'apikey' => 'YOUR_API_KEY'

		    'sendwa' => '1'

		    'sendsms' => '1'

        );

        

        $options = array(

            CURLOPT_URL => $url,

            CURLOPT_POST => true,

            CURLOPT_POSTFIELDS => http_build_query($data),

            CURLOPT_RETURNTRANSFER => true,

        );

        

        $ch = curl_init();

        curl_setopt_array($ch, $options);

        $response = curl_exec($ch);

        curl_close($ch);

        

        echo $response;

        

        ?>

Tämä PHP-esimerkki osoittaa, kuinka lähetetään POST-pyyntö käyttämällä cURL-osoitetta SMSmobileAPI:lle ja välitetään tarvittavat parametrit assosiatiivisena taulukkona.

Lähetä SMS & WhatsApp

Käytä virallista Python-moduuliamme: https://smsmobileapi.com/python/
tai käytä manuaalista tapaa...

Pyyntökirjaston käyttäminen

Pyyntökirjasto on suosittu ja yksinkertainen HTTP-kirjasto Pythonille. Näin voit käyttää sitä tekstiviestin lähettämiseen SMSmobileAPI:n kautta:


        import requests



        url = "https://api.smsmobileapi.com/sendsms/"



        payload = {

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        }



        response = requests.post(url, data=payload)



        print(response.text)

Tämä esimerkki osoittaa yksinkertaisen POST-pyynnön SMSmobileAPI:lle, joka lähettää viestin tiettyyn puhelinnumeroon.

`http.client`-kirjaston käyttäminen

"http.client"-kirjasto sisältyy Pythonin vakiokirjastoon, ja sitä voidaan käyttää myös vuorovaikutukseen API:si kanssa:


        import http.client

        import urllib.parse



        conn = http.client.HTTPSConnection("api.smsmobileapi.com")



        params = urllib.parse.urlencode({

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        })



        headers = { "Content-type": "application/x-www-form-urlencoded" }



        conn.request("POST", "/sendsms/", params, headers)

        response = conn.getresponse()

        data = response.read()



        print(data.decode("utf-8"))

        conn.close()

Tämä esimerkki näyttää, kuinka `http.client`-kirjastoa käytetään POST-pyynnön lähettämiseen API:lle. Parametrit ovat URL-koodattuja ja lähetetään asianmukaisten otsikoiden kanssa.

SMS Mobile API – PHP SDK (säveltäjä)

SMS Mobile API PHP SDK on saatavilla Composerin kautta, mikä tekee tekstiviestien lähetyksen integroimisesta PHP-sovelluksiin helposti.


		säveltäjä vaatii smsmobileapi/sdk

Yksityiskohtaiset dokumentaatiot, asennusohjeet ja käyttöesimerkit ovat GitHub-arkistossamme:

🔗 SMS Mobile API PHP SDK GitHubissa: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main

GitHubista löydät:
✔️ Täydellinen asennusopas
✔️ Käyttöesimerkki
✔️ API-viittaus ja parhaat käytännöt

Tarvitsetko apua? Avaa ongelma GitHubissa! 🎯

Lähetä SMS & WhatsApp

"fetch" API:n käyttäminen

"Fetch" API on moderni ja monipuolinen tapa tehdä HTTP-pyyntöjä JavaScriptissä. Näin voit käyttää sitä tekstiviestin lähettämiseen SMSmobileAPI:n kautta:


        const url = "https://api.smsmobileapi.com/sendsms/";



        const data = {

            recipients: "PHONE_NUMBER",

            message: "YOUR_MESSAGE",

            apikey: "YOUR_API_KEY"

        };



        fetch(url, {

            method: "POST",

            headers: {

                "Content-Type": "application/x-www-form-urlencoded"

            },

            body: new URLSearchParams(data)

        })

        .then(response => response.text())

        .then(result => console.log(result))

        .catch(error => console.error("Error:", error));

Tämä esimerkki osoittaa, kuinka POST-pyyntö lähetetään käyttämällä "fetch" API:ta, jota tuetaan useimmissa nykyaikaisissa selaimissa.

XMLHttpRequest-komennolla

Jos sinun on tuettava vanhempia selaimia, voit käyttää XMLHttpRequest-objektia:


        const xhr = new XMLHttpRequest();

        const url = "https://api.smsmobileapi.com/sendsms/";



        const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";



        xhr.open("POST", url, true);

        xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");



        xhr.onreadystatechange = function() {

            if (xhr.readyState === 4 && xhr.status === 200) {

                console.log(xhr.responseText);

            }

        };



        xhr.send(data);

Tässä esimerkissä näytetään, kuinka XMLHttpRequest-komentoa käytetään POST-pyynnön lähettämiseen, mikä tarjoaa yhteensopivuuden vanhojen selainten kanssa, jotka eivät ehkä tue hakutoimintoa.

Lähetä SMS & WhatsApp

Axios-kirjaston käyttäminen

Axios-kirjasto on suosittu HTTP-asiakas Node.js:lle. Näin voit käyttää sitä tekstiviestin lähettämiseen SMSmobileAPI:n kautta:


        const axios = require('axios');



        const url = 'https://api.smsmobileapi.com/sendsms/';

        const data = {

            recipients: 'PHONE_NUMBER',

            message: 'YOUR_MESSAGE',

            apikey: 'YOUR_API_KEY'

        };



        axios.post(url, data)

        .then(response => {

            console.log(response.data);

        })

        .catch(error => {

            console.error('Error:', error);

        });

Tämä esimerkki osoittaa, kuinka POST-pyyntö lähetetään Node.js:n "axios"-komennolla vuorovaikutuksessa SMSmobileAPI:n kanssa.

Lähetä SMS & WhatsApp

Net::HTTP-kirjaston käyttäminen

Voit käyttää Rubyn Net::HTTP-kirjastoa lähettääksesi tekstiviestin SMSmobileAPI:n kautta:


        require 'net/http'

        require 'uri'



        uri = URI.parse("https://api.smsmobileapi.com/sendsms/")

        request = Net::HTTP::Post.new(uri)

        request.set_form_data(

            "recipients" => "PHONE_NUMBER",

            "message" => "YOUR_MESSAGE",

            "apikey" => "YOUR_API_KEY"

        )



        req_options = {

            use_ssl: uri.scheme == "https",

        }



        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|

            http.request(request)

        end



        puts response.body

Tämä esimerkki osoittaa, kuinka POST-pyyntö lähetetään SMSmobileAPI:lle käyttämällä Rubyn Net::HTTP:tä.

Voit lähettää WhatsApp-viestejä vain API:mme kautta. Napsauta tätä saadaksesi lisätietoja.

Jos sinulla on kysyttävää, ehdotuksia tai tarvitset apua, tiimimme on valmis auttamaan.
Ota rohkeasti yhteyttä osoitteeseen api@smsmobileapi.com

Napsauta tätä testataksesi API-avainta ja palvelua yksinkertaisella lomakkeella

Riippuen matkapuhelimeen asennetusta Android-versiosta, käyttöjärjestelmä voi haitata tekstiviestien automaattisen lähettämisen ja vastaanottamisen asianmukaista toimintaa, kun SmsMobileApi-sovellus ei ole etualalla.
Tämä ongelma johtuu prosessista, joka yrittää suorittaa taustalla, kun sovellusta ei käynnistetä aktiivisesti. Androidin akun optimointitoimenpiteiden vuoksi, jotka vaihtelevat eri versioiden välillä, tämä taustaprosessi ei välttämättä käynnisty oikein. Androidin akun optimointi on suunniteltu rajoittamaan sovellusten taustatoimintaa akun käyttöiän säästämiseksi, mikä voi vahingossa vaikuttaa sovelluksiin, jotka vaativat taustaprosesseja toimiakseen kunnolla.

Tämän ongelman ratkaisemiseksi käyttäjät voivat määrittää Android-asetukset manuaalisesti siten, että SmsMobileApi voi käyttää resursseja ilman rajoituksia.
Tämä sisältää tietyn sovelluksen akun optimointiasetusten säätämisen, lähinnä Androidille ohjeistamisen, että SmsMobileApi saa toimia taustalla ja käyttää resursseja tarpeen mukaan. Näin tehden sovelluksen pitäisi pystyä automaattisesti lähettämään ja vastaanottamaan tekstiviestejä, vaikka se ei olisikaan aktiivinen sovellus etualalla. Tämä säätö varmistaa, että tarvittava taustaprosessi voi toimia keskeytyksettä ja kiertää akun optimointiominaisuudet, jotka muuten voisivat estää sen asianmukaisen suorittamisen.

FAQ Kehittäjälle

Kuinka luoda API-avain?

Harmonikkaesimerkkikuvaus Voit luoda API-avaimen lataamalla sovelluksemme matkapuhelimeesi ja luomalla tilin maksutta. API-avain luodaan automaattisesti ja linkitetään matkapuhelimeesi. Saat myös sähköpostin, jossa on kaikki tarvittavat tiedot. Tämä prosessi varmistaa, että voit nopeasti ja helposti aloittaa palveluidemme käytön minimaalisella asennuksella.

Mistä löydän aina API-avaimeni?

Siirry mobiilisovelluksessasi ASETUKSET- tai OHJE-valikkoon, jossa API-avaimesi on aina näkyvissä. Tämä varmistaa, että pääset helposti käsiksi API-avaimellesi aina, kun tarvitset sitä palveluidemme integroimiseen tai käyttämiseen.

Voiko API-avaimen luominen olla nimetöntä?

Kyllä, emme vaadi henkilöllisyystodistusta API-avaimen luomiseen. API-liittymämme ja matkapuhelimesi välinen viestintä on siksi 100% nimetöntä. Tämän lähestymistavan avulla käyttäjät voivat säilyttää yksityisyytensä palveluitamme käyttäessään.

Aloita SMSmobileAPI jo tänään!

Koe tekstiviestipalveluidesi hallinnan vapaus ja joustavuus liikkeellä ollessasi. Lataa mobiilisovelluksemme nyt ja ota ensimmäinen askel kohti saumatonta tekstiviestien integrointia.

Lataa sovellus

SMS-dokumentaatio

Lähetä SMS

Lähetä lähettämättömät tekstiviestit uudelleen

LOG SMS lähetetty

Vastaanota tekstiviesti

Poista tekstiviesti

SMS vastaanotettu - Webhook

Todennus

Lähetä SMS

Päätepiste:

Parametrit:

Esimerkki:

Lähetä uudelleen lähettämätön tekstiviesti

Päätepiste:

Parametri:

Esimerkki:

API:lta lähetetty tekstiviestiloki

Päätepiste:

Parametri:

Esimerkki:

SMS vastaanotettu

Päätepiste:

Parametri:

Esimerkki:

Poista tekstiviesti

Päätepiste:

Parametri:

Esimerkki:

Webhook – SMS vastaanotettu

Webhookin määrittäminen hallintapaneelissa

Webhook-hyötykuorma

Hyötykuormakentät:

Esimerkki Webhook-päätepiste

Webhookin testaus

Vianetsintä

Todennus

1. API-avaimen todennus

2. OAuth2-todennus

Käyttöoikeustunnuksen hankkiminen

Käyttöoikeustunnuksen käyttäminen:

Mitä menetelmää sinun tulisi käyttää?

Lähetä SMS

WSDL URL

Parametrit:

Esimerkki

Lähetä SMS & WhatsApp

Perus cURL-komento

cURL-esimerkki PHP:ssä

Lähetä SMS & WhatsApp

Pyyntökirjaston käyttäminen

`http.client`-kirjaston käyttäminen

SMS Mobile API – PHP SDK (säveltäjä)

Lähetä SMS & WhatsApp

"fetch" API:n käyttäminen

XMLHttpRequest-komennolla

Lähetä SMS & WhatsApp

Axios-kirjaston käyttäminen

Lähetä SMS & WhatsApp

Net::HTTP-kirjaston käyttäminen

FAQ Kehittäjälle

Kuinka luoda API-avain?

Mistä löydän aina API-avaimeni?

Voiko API-avaimen luominen olla nimetöntä?

Aloita SMSmobileAPI jo tänään!