Dev DOC WhatsApp - SMSMobileAPI

WhatsApp-dokumentaatio

Tämä dokumentaatio koskee erityisesti WhatsApp-viestien lähettämistä ja vastaanottamista.

Napsauta tätä saadaksesi lisätietoja kaikista WhatsApp-integraatiomme tarjoamista ominaisuuksista.

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

JavaScript

Python

Node.js

Rubiini

WSDL

Todennus

API-AVAIN
OAuth2

Lähetä WhatsApp API

Tätä API-päätepistettä käytetään WhatsApp-viestien lähettämiseen.

Päätepiste:

GET POST https://api.smsmobileapi.com/sendsms

Parametrit:

Parametri	Kuvaus
apikey	Pakollinen Ainutlaatuinen API-avaimesi.
recipients	Pakollinen Vastaanottajan puhelinnumero (numeron on oltava saatavilla WhatsAppissa). Syötä puhelinnumero alkaen maakoodista (ilman '+' ja ilman '00'), jota seuraa suoraan loput numerostasi. Esimerkki: 191728660
message	Pakollinen Lähetettävä viesti (useita rivejä mahdollista).
waonly	Pakollinen Täytyy olla arvo kyllä → Pakollinen määrittämään, että vain yksi WhatsApp-viesti lähetetään.
url_media	Mediatiedoston suora URL-osoite, jonka haluat lähettää WhatsAppin kautta. Täytyy aloittaa https:// ja osoita kelvollista PDF, doc tai kuva tiedosto. Tiedoston on oltava julkisesti saatavilla ilman todennusta. Tuetut muodot: Asiakirjat: pdf, xml, doc, docx, odt, rtf, txt, tex, xls, xlsx, csv, ods, ppt, pptx, odp, zip, rar, 7z, tar, gz Kuvat: jpg, jpeg, png
url_media_shorted	Jos arvo on kyllä, ja [pdf_with_image=yes] on asetettu, PDF-tiedoston latauslinkin näyttö kulkee lyhyen URL-osoitteen kautta.
pdf_with_image	Jos arvo on kyllä, PDF-tiedoston esikatselu näytetään viestin mukana (vain jos tiedosto on PDF).
encrypt_message	kyllä = Viesti salataan, kun vastaanottaja lukee sen. Vastaanottajan on syötettävä yksilöllinen avain viestin salauksen purkamiseksi. Lue lisää viestien salauksesta

Esimerkki ilman mediaa:


        GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&waonly=yes&recipients=191728660&message=Hello%20World

Esimerkki median kanssa:


        GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&waonly=yes&recipients=191728660&message=Hello%20World&url_media=https://smsmobileapi.com/logo.png

Muotoile teksti WhatsAppissa:

Kursiivi: Käytä alaviivoja → _text_
Lihavoitu: Käytä tähtiä → *teksti*
Yliviivaus: Käytä aaltoja → ~teksti~
Monospace: Käytä backticks → ```teksti```

Esimerkki: _Hei_ maailma, kuinka *voi olla* ~tänään~ ```SMSMobileAPI```:sta

Lähetä uudelleen lähettämättömät WhatsApp-viestit

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

Päätepiste:

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

Parametri:

Parametri	Kuvaus
guid	Pakollinen Uudelleenlähetettävän viestin GUID.

Esimerkki:


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

Synkronointi viestin hakemiseksi

Tätä API-päätepistettä käytetään lähettämään pyyntö synkronoida ja noutaa WhatsApp-viestejä.
Tämä vaihe on pakollinen ja se on suoritettava ennen kuin kutsutaan viestit noutavalle päätepisteelle.

Varoitus: Synkronointia vaaditaan ehdottomasti vain viestien hakutoimintoa varten. Älä aloita synkronointia lähettääksesi viestin.

Päätepiste:

GET https://api.smsmobileapi.com/getwa/synchronisation/

Parametri:

Parametri	Kuvaus
apikey (required)	Pakollinen API-avain, joka sinulla on tai saat.

Esimerkki:


        GET https://api.smsmobileapi.com/getwa/synchronisation/?apikey=YOUR_API_KEY

Vastaa:



{


 "error": "0",

   "messages": "synkronoitu",

  "expire_at ": "2025-03-11 12:27:00",

  "expire_at_unix": "1741692420",


 

}

Hae WhatsApp-viesti

Tätä API-päätepistettä käytetään vastaanotettujen WhatsApp-viestien noutamiseen.

Päätepiste:

GET https://api.smsmobileapi.com/getwa

Parametri:

Parametri	Kuvaus
apikey	Pakollinen API-avain, joka sinulla on tai saat.
before	Anna aikaleima parametriksi ja näytä tietueet tämän aikaleiman alla.
date	(vvvv-kk-pp) Hanki kaikki tietueet päivämäärän perusteella.
message_type	Jätä tyhjäksi nähdäksesi kaikki (teksti- ja ääniviestit) Käyttää `teksti` nähdäksesi vain tekstiviestit Käyttää `audio` nähdäksesi vain tekstiksi muunnetut ääniviestit

Esimerkki:


        GET https://api.smsmobileapi.com/getwa/?apikey=YOUR_API_KEY

Vastaa:



{


  "päivämäärä": "2025-03-11",

  "tunti": "12:27:00",

  "timestamp": "1741692420",

  "numero": "19176728660",

  "contact": "Smsmobileapi",

  "message": "Voitko kertoa minulle milloin saan tilaukseni?",

  "guid": "652fcfc0-12a8-46f5-b5ba-9391135b8b4c",

  
  "lisää": {

    "auto_reply": "1",

    "transfert_to_email": "1",

    "chatgpt_reply": "1"

	
  },


  "chatgpt": {

    "prompt_tokens": "900",

    "completion_tokens": "10",

    "total_tokens": "910",

    "total_tokens_cost": "0,182"

	 "response": "Tilauksesi #576 lähetetään huomenna."

	
  }

    
  
}

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

WhatsApp-viestien lähettäminen tai hakeminen API:n kautta edellyttää todennusta API-avaimella. Tämä varmistaa turvallisen ja valtuutetun pääsyn viestipalveluun. Liitä vain API-avaimesi pyyntöön todentaaksesi ja aloittaaksesi viestien lähettämisen saumattomasti.

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.

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?waonly=yes \

-H "Authorization: Bearer abc123xyz456" \

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

-d "recipients=+1234567890" \

-d "message=Hello"

Which Method Should You Use?

- Use API Key Authentication for quick and straightforward integrations.

- Use OAuth2 Authentication for enhanced security and scalability in your integrations.

Lähetä WhatsApp viesti

WSDL URL

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

Parametrit:

- recipients: Vastaanottajan matkapuhelinnumero.

- message: Viesti lähetettäväksi.

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

- waonly: täytyy olla arvo kyllä -> Pakollinen määrittämään, että vain yksi WhatsApp-viesti lähetetään.

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("waonly" =>"yes","recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));

                

                print_r($result);

Lähetä WhatsApp

Perus cURL-komento

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


        curl -X POST https://api.smsmobileapi.com/sendsms/?waonly=yes \

        -d "recipients=PHONE_NUMBER" \

        -d "message=YOUR_MESSAGE" \

        -d "apikey=YOUR_API_KEY"

cURL-esimerkki PHP:ssä

Jos käytät PHP:tä, voit lähettää WhatsApp-viestin cURL-osoitteella seuraavasti:


        <?php

        

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

        $data = array(

            'recipients' => 'PHONE_NUMBER',

            'message' => 'YOUR_MESSAGE',

            'apikey' => 'YOUR_API_KEY'


        );

        

        $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ä 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ä WhatsApp-viestin lähettämiseen SMSmobileAPI:n kautta:


        import requests



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



        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ää WhatsApp-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/?waonly=yes", 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.

Lähetä 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ä WhatsApp-viestin lähettämiseen SMSmobileAPI:n kautta:


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



        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/?waonly=yes";



        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ä WhatsApp

Axios-kirjaston käyttäminen

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


        const axios = require('axios');



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

        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ä WhatsApp

Net::HTTP-kirjaston käyttäminen

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


        require 'net/http'

        require 'uri'



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

        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ä.

On myös mahdollista lähettää WhatsApp-viestin ja tekstiviestin samanaikaisesti.

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

SMS-ominaisuudet

WhatsApp-ominaisuudet

Yleiset lisäosat

Verkkokaupan lisäosat

API & Developer Docs

Työkalu- ja muutosloki

WhatsApp-dokumentaatio

Lähetä WhatsApp

Lähetä viesti uudelleen

Synkronointi

Hae viestejä

Todennus

Lähetä WhatsApp API

Päätepiste:

Parametrit:

Esimerkki ilman mediaa:

Esimerkki median kanssa:

Muotoile teksti WhatsAppissa:

Lähetä uudelleen lähettämättömät WhatsApp-viestit

Päätepiste:

Parametri:

Esimerkki:

Synkronointi viestin hakemiseksi

Päätepiste:

Parametri:

Esimerkki:

Vastaa:

Hae WhatsApp-viesti

Päätepiste:

Parametri:

Esimerkki:

Vastaa:

Todennus

1. API-avaimen todennus

2. OAuth2-todennus

Käyttöoikeustunnuksen hankkiminen

Käyttöoikeustunnuksen käyttäminen:

Which Method Should You Use?

Lähetä WhatsApp viesti

WSDL URL

Parametrit:

Esimerkki

Lähetä WhatsApp

Perus cURL-komento

cURL-esimerkki PHP:ssä

Lähetä WhatsApp

Pyyntökirjaston käyttäminen

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

Lähetä WhatsApp

"fetch" API:n käyttäminen

XMLHttpRequest-komennolla

Lähetä WhatsApp

Axios-kirjaston käyttäminen

Lähetä WhatsApp

Net::HTTP-kirjaston käyttäminen