Tekstiviestisi lähetetään omasta puhelimestasi.Katso, miten se toimii
ILMA-AINEISTOAPI-ensimmäinen arkkitehtuuriTurvallisen laitteen paritusToimituksen näkyvyysMonilaiteohjausVersioasiakirjat
Kehittäjän solmupiste/ SMS API

SMS · 16 dokumentoitua toimintoa

SMS API-dokumentaatio

Lähetä ja vastaanottaa SMS, tarkastaa toimitus lokit, rakentaa keskusteluja ja hallita kytketty mobiili yhdyskäytävät.

A smartphone connected to SMS and cloud gateway infrastructure
REST-tukikohdan URLhttps://api.smsmobileapi.com

JSON-vasteet · HTTPS vaaditaan · UTF-8

Yhdistä API-näppäin

Yhdistä kerran, sitten testata päätetapahtumia SMS, puhelut, ilmoitukset, WhatsApp ja sähköposti.

Aloita tästä.

Ensimmäinen pyyntösi neljässä vaiheessa

1

Luo tili ja kopioi API-näppäin kojelautaan.

2

Asenna mobiilisovellus ja varmista, että laite on online.

3

Lähetä yksi testi SMS kanssa /sendms / päätepiste.

4

Tallenna palautetun viestin tunniste korreloida lokit ja toimitustila.

Turvallinen SMSMobileAPI-mobiilisovellus, joka yhdistää puhelimen verkkokojelautaan ja REST API-sovellus SMS- ja puhelutoimintoihin
Salattu mobiili-lautalta-liitäntä

Virallinen mobiilisovellus

Turvallinen silta puhelimen, kojelauta ja API:n välillä.

SMS- ja puhelutoiminnot kulkevat puhelimeen asennetun virallisen SMSMobileAPI-sovelluksen kautta. Sovellus yhdistää laitteen turvallisesti tiliisi, synkronoi hyväksytyt tapahtumat ja linkittää mobiiliverkon kojelautaan ja REST API:iin.

1MobiilisovellusParittele puhelin ja sen SIM 2Salattu linkkiTunnistaa ja suojaa tietoja kauttakulussa 3& APIHallitsee työnkulkua ja toimintaa
  • Allekirjoitetut tiedotteet, jotka on jaettu virallisten Google Play- ja Apple App Store -listausten kautta
  • Google ja Apple -alustan katselmointi, allekirjoittaminen ja jakelun valvonta
  • Turvalaiteparitus, HTTPS-kuljetus ja aito API-yhteys
  • Vain mobiiliominaisuuksille tarvittavat oikeudet
Hanki virallinen SMSMobileAPI-sovellus Google Playsta Download the official SMSMobileAPI app on the Apple App Store
Kyvyt riippuvat Android:n tai iOS:n sallimista käyttöoikeuksista ja tausta-aineistoista.

Todennus

Pidä tiedot palvelimellasi

Every request accepts an API key through the apikey parameter. OAuth2 client credentials are also available for server-to-server integrations. Never expose a production key in browser code, public repositories or support messages.

Historianhallinta

Tyhjennä historia turvallisesti: esikatselu, poista, seuraa edistymistä

Nämä päätepisteet tyhjentävät valitun palvelimen historian API-avaimellesi, eivät puhelimissa tai ulkoisissa palveluissa. Niissä ei säädetä tilien poistamisesta. Uusia toimintoja voi ilmaantua poistamisen jälkeen.

Lue request_id ja yritä uudelleen opas
Kotouttamisen suoja

Oletuksena on, että linkit tai käsittely kirjataan edelleen näkyviin. Käytä include_linked=1:ää vain, jos hyväksyt, että integraatiot tai jatkuva käsittely voivat lopettaa työskentelyn.

Miten request_id vaikuttaa

  1. Esikatsele lukuja action=preview: llä. request_id:ää ei tarvita eikä tietueita poisteta.
  2. Luo ainutlaatuinen request_id uuden poiston, esimerkiksi UUID. Tallenna se ennen action=delete:n lähettämistä.
  3. ennallistamis-, aikakatkaisu- tai HTTP 202, uudelleenkäyttäydy samalla tavalla API avain, historian päätetapahtuma, request_id sekä include_linked arvo. Älä koskaan luo uutta tunnistetta automaattisesti virheen jälkeen.
  4. Kun completed=true, operaatio on päättynyt. Henkilötunnuksen uudelleenkäyttö palauttaa saman tuloksen sen sijaan, että poistaisi uudet tietueet. Käytä uutta henkilökorttia vain tarkoituksella uuteen siivoukseen.

request_id tunnistaa poistotoimintosi, ei yksittäinen SMS. Sallittu muoto: 16...128 ASCII kirjaimet, numerot, väliviivat tai alleviivat. UUID:n generoitu salauksella.randomUID() sopii hyvin.

Poisto etenee erissä. Jos vastaus on HTTP 202 ja continue_required=true, toista action=delete 3 sekunnin kuluttua. Taustalla ei suoriteta cron-tehtävää. action=status vain lukee edistymisen eikä jatka poistoa, vaikka vastaus olisi HTTP 200.

Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET also accepts action=preview or action=delete. POST is recommended: URL parameters can leak into browser history and server logs. Never place a deletion URL in a public link, image or prefetch.

Lähetä POST:lle kaikki parametrit muodossa keho tai JSON:n objekti, älä koskaan kyselyn merkkijonossa. Tuntematon parametreja hylätään; päivämäärä tai liikkuvia suodattimia ei tueta.

Historiallisten päätetapahtumien todentaminen

Käyttö apikey tai Authorization: Bearer kulkutunnus, jonka on antanut SMSMobileAPI OAuth2. Älä lähetä virkistävää kuponkia tai API avain Bearer -Ei. Vanhentuneet kuponkit hylätään.

Kun ulottuvuudet on asetettu, history:read mahdollistaa esikatselun/statuksen ja history:delete myös poiston. Sekä token että OAuth-asiakkaan rajoituksia sovelletaan. Perintö rahakkeita ilman soveltamisalaa säilyttää niiden nykyinen tili pääsy.

OAuth2 valitsee ainutlaatuisen ensisijaisen API-avain. Jos on olemassa useita ensisijaisia avaimia, anna apikey myös valita yksi tilin. Toissijaiset avaimet eivät koskaan anna pääsyä ensisijaisen avainhistorian.

Lue vastaus ennen kuin jatkat

count_delete on tämän operaation poistama kumulatiivinen numero. selected_at_start on ensimmäinen valinta; protected_at_start laskee pois tietueita. Käytä preview.linked_or_processing:ää laskeaksesi linkitettyjä tietueita myös include_linked=1:n aikana.

JSON · HTTP 202
{
    "result": {
        "error": 0,
        "history": "sms-api",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}
  • 200 completed=true: valmis. 200 esikatselu tai tilavaste ei yksin todista valmistumista.
  • 400 INVALID_REQUEST_ID: tarkista muoto. 404 REQUEST_NOT_FOUND: tälle ID:lle, API-avaimelle ja historialle ei ole olemassa operaatiota.
  • 401: pätemättömät tai vanhentuneet tunnukset. 403: riittämätön OAuth-alue tai luvaton tili.
  • 409 HISTORY_BUSY: toinen puhdistus on käynnissä; jatka sitä alkuperäisestä asiakkaasta. 409 INCLUDE_LINKED_CONFLICT: Palauta alkuperäinen include_linked-arvo.
  • 409 OAUTH_ACCOUNT_AMBIGUOUS: anna tälle tilille kuuluva API-avain.
  • 503 tai verkon keskeytys: jotkut erät voidaan jo täyttää. Tarkista asetukset ja yritä sitten uudelleen alkuperäisen request_id:n kanssa. Älä luo korvaavaa toimintoa automaattisesti.
POST · GET

Send an SMS

#
endpointhttps://api.smsmobileapi.com/sendsms/

-Ei. POSTia suositellaan, kun viesti on pitkä tai sisältää erikoismerkkejä.

Milloin sitä käytetään

Use this for transactional messages, reminders, alerts and application-generated SMS.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
recipients puhelin Pakollinen Määränpäänumero kansainvälisissä yhteyksissä.
message jono Pakollinen Viestin runko. URL-koodia kun käytät GET.
port 1 | 2 Vapaaehtoinen SIM-portti yhteensopivilla Android-laitteilla; jätä tyhjäksi automaattiseen valintaan.
sIdentifiant jono Vapaaehtoinen Erityinen yhdistetty puhelin SID; jätä tyhjä ensimmäinen käytettävissä oleva laite.
shorturl 0 | 1 Vapaaehtoinen Aseta 1 lyhentämään viestissä olevia URL-osoitteita.
sendsms 0 | 1 Vapaaehtoinen SMS-kanavalippu. Oletus 1:een, kun se on jätetty pois.
sendwa 0 | 1 Vapaaehtoinen Pyydä myös WhatsApp toimitusta, kun tili tukee sitä.
encrypt_message kyllä Vapaaehtoinen Salaa viesti vastaanottajan puolella suojatulle lukemiselle.
schedule_timestamp Unix seconds Vapaaehtoinen UTC-aika, josta viesti voidaan lähettää.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/sendsms/" \
  -d "apikey=YOUR_API_KEY" \
  -d "recipients=+1234567890" \
  --data-urlencode "message=Your appointment is confirmed for tomorrow."

Esimerkkivastaus

JSON
{
  "result": {
    "error": 0,
    "sent": "1",
    "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25",
    "note": "sent by mobile",
    "datetime": "2026-03-20T21:07:44Z",
    "port": null,
    "send_with_whatsapp": "0"
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Onnistunut API-vastaus tarkoittaa, että alusta hyväksyi viestin; pidä palautettu ID myöhempää seurantaa varten.
  • Operaattorin toimitus ja mobiilikäsittely voi tapahtua HTTP-vasteen jälkeen.
POST · GET

Resend an unsent SMS

#
endpointhttps://api.smsmobileapi.com/resend/

Palauttaa viestin, joka on tällä hetkellä virhetilassa.

Milloin sitä käytetään

Käytä tätä sen jälkeen, kun olet tarkistanut lähetetyn lokin ja vahvistanut, että epäonnistunut viesti on oikeutettu toiseen yritykseen.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
guid jono Pakollinen Viesti GUID palautetaan lähetykseen tai lokipäätetapahtumaan.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE"

Esimerkkivastaus

JSON
{
  "result": {
    "error": "0",
    "sms": "resent with successfully",
    "attempt": 1
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Vain virhetilan omaavat viestit voivat olla pahoja.
SAADA

List SMS sent from the API

#
endpointhttps://api.smsmobileapi.com/log/sent/sms/

Palauttaa viestit SMS API jonossa, mobiili ja virhetiedot.

Milloin sitä käytetään

Käytä sitä toimituksen seurantaan, tukemaan diagnostiikkaa ja täsmäytys.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
guid_message jono Vapaaehtoinen Palauta yksi viesti sen ainutlaatuisen guid.
before aikaleima tai viite Vapaaehtoinen Palauta viestit ennen toimitettua kursoria tai aikaleimaa.
error_api 0 | 1 Vapaaehtoinen Aseta 1 palauttaa API käsittelyvirheet.
error_mobile 0 | 1 Vapaaehtoinen Aseta 1 palauttaa mobiilin lähetyksessä vain virheitä.
keyword jono Vapaaehtoinen Etsi vastaanottajan numero tai viestiteksti.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/log/sent/sms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

Esimerkkivastaus

JSON
{
  "result": {
    "error": "0",
    "sms": [{
      "sIdentifiantPhone": "508b004b4aadacc4",
      "recipients": "+1234567890",
      "sms": "Test message",
      "guid_message": "MESSAGE_GUID",
      "send_from_mobile": 1,
      "error_api": "",
      "send_from_mobile_erreur": ""
    }]
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
SAADA

List SMS synchronized from a phone

#
endpointhttps://api.smsmobileapi.com/log/sent/frommobile/

Listaa SMS fyysisesti lähettää mobiili ja synkronoitu kanssa alustan.

Milloin sitä käytetään

Käytä sitä, kun viestit voivat olla peräisin puhelimesta sekä API:n kautta.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
date VVVV-KK-PP Vapaaehtoinen Suodata yksi tarkka päivämäärä.
date_from VVVV-KK-PP Vapaaehtoinen Start of a date range.
date_to VVVV-KK-PP Vapaaehtoinen -Entä treffimatka?
period enum Vapaaehtoinen Tänään, eilen, viime 24h, viime 3 päivää tai viime 7 päivää.
number puhelin Vapaaehtoinen Suodata vastaanottajan mukaan.
sIdentifiant jono Vapaaehtoinen Suodata liitetyllä mobiililla SID: llä.
message jono Vapaaehtoinen Suodata viestien sisältö.
search jono Vapaaehtoinen Maailmanlaajuinen haku mobiilien, numeroiden, viestien ja aikaleiman välillä.
sort_by enum Vapaaehtoinen sIDENTIFIANT, numero, viesti, mobile date ms, mobile date formated or synkro time.
sort_order ASC . DESC. Vapaaehtoinen -Ei.
limit kokonaisluku Vapaaehtoinen Enintään 200 levyä.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&period=last_7days&limit=200"

Esimerkkivastaus

JSON
{
  "result": {
    "error": "0",
    "count": 1,
    "history_limit_days": 7,
    "sms": [{
      "sIdentifiant": "508b004b4aadacc4",
      "number": "+15551234567",
      "message": "Appointment confirmed.",
      "mobile_date_ms": 1774041004692,
      "synchro_time": "2026-03-20 21:10:05"
    }]
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Vaaditaan Android-sovellus 4.1.20 tai uudempi ja se on otettava käyttöön sovelluksessa.
  • Tämä päätetapahtuma palauttaa enintään seitsemän päivää synkronoitu historia.
SAADA

List received SMS

#
endpointhttps://api.smsmobileapi.com/getsms/

Returns incoming SMS synchronized from connected phones.

Milloin sitä käytetään

Käytä sitä rakentaa laatikko, kyselyn vastauksia tai palauttaa viestejä jälkeen webkookin keskeytys.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
sIdentifiantPhone jono Vapaaehtoinen Filter by the phone that received the SMS.
after_timestamp_unix Unix seconds Vapaaehtoinen Palauta viestit tämän aikaleiman jälkeen.
onlyunread kyllä Vapaaehtoinen Palauta vain viestit, joita ei ole merkitty luetuksi API-tilassa.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY&onlyunread=yes"

Esimerkkivastaus

JSON
{
  "result": {
    "error": "",
    "sms": [{
      "id": 466340,
      "sIdentifiantPhone": "508b004b4aadacc4",
      "timestamp_unix": 1774041814,
      "message": "Please call us back.",
      "number": "+15551234567",
      "guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122",
      "alias": null
    }]
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
POST · GET

Mark a received SMS as read

#
endpointhttps://api.smsmobileapi.com/getsms/set-read/

Merkitse yksi vastaanotettu viesti SMSMobileAPI API-tilassa.

Milloin sitä käytetään

Käytä tätä sen jälkeen, kun sovelluksesi on käsitellyt saapuvan viestin.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
guid_message jono Pakollinen GUID of the received SMS.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Tämä ei muuta lukutilaa puhelinviestisovelluksen sisällä.
POST · GET

Update a received SMS alias

#
endpointhttps://api.smsmobileapi.com/getsms/update/

Adds, changes or clears the alias associated with a received SMS.

Milloin sitä käytetään

Käytä peitenimiä liittääksesi viestin yhteysnimi tai sovellusmerkki.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
guid jono Pakollinen GUID of the received SMS.
alias jono Pakollinen Uusi peitenimi. Lähetä tyhjä arvo tyhjentämään se.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID&alias=John%20Doe"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
POST · GET

Delete SMS server logs

#
endpointhttps://api.smsmobileapi.com/deletesms/

Poistaa SMS-tietueet SMSMobileAPI-palvelimen lokista.

Milloin sitä käytetään

Käytä sitä tallennustyön virtauksiin tai tietyn kirjautuneen viestin poistamiseen.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
guid_message jono Vapaaehtoinen Poista yksi viesti GUIDilta.
date_start VVVV-KK-PP Vapaaehtoinen Poista tietueet tästä päivästä.
date_end VVVV-KK-PP Vapaaehtoinen Date start -toiminnolla rajoitetaan poistoväliä.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

Esimerkkivastaus

JSON
{
  "result": {
    "error": null,
    "count_delete": 1
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Tämä poistaa vain palvelinlokitiedot. Se ei poista mobiililaitteeseen tallennettuja viestejä.
  • Käsittele tätä operaatiota tuhoisina ja varmista suodattimet ennen kuin kutsut sitä.
SAADA

List SMS conversations

#
endpointhttps://api.smsmobileapi.com/conversation/sms/list/

Ryhmät saapuvat ja lähtevät viestit keskusteluun puhelinnumeron mukaan.

Milloin sitä käytetään

Käytä sitä chat näkymät, viimeaikaiset keskustelut widgetit ja tukea aikajanat.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
origineConversation vastaanotettu Pakollinen Dataset, jota käytettiin alkukeskustelujen tunnistamiseen.
numero puhelin Vapaaehtoinen - Palauta yksi numerokeskustelu.
date_from päivämäärä tai päivämäärä Vapaaehtoinen Viestialueen alku.
date_to päivämäärä tai päivämäärä Vapaaehtoinen Viestialueen loppu.
sort ASC . DESC. Vapaaehtoinen Keskustelujärjestys; oletus DESC.
limit kokonaisluku Vapaaehtoinen Keskusteluraja, kun numeroa ei ole; oletus 20.
resume 0 | 1 Vapaaehtoinen Aseta 1 palauttaaksesi vain uusimmat viestit keskustelua kohti.
resume_line_how kokonaisluku Vapaaehtoinen Viestien määrä keskustelua kohti, kun jatkat = 1

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&resume=1&resume_line_how=3"

Esimerkkivastaus

JSON
{
  "success": true,
  "origineConversation": "received",
  "conversations": [{
    "phone_number": "+15551234567",
    "contact_alias": "John Doe",
    "messages": [{
      "direction": "incoming",
      "message_id": "msg_1001",
      "timestamp_utc": "2026-03-13T08:45:12Z",
      "message": "I need more information.",
      "status": "received",
      "mobile_sid": "device_sid_1"
    }]
  }]
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
SAADA

Listaa yhdistetyt matkapuhelimet

#
endpointhttps://api.smsmobileapi.com/gateway/mobile/list/

Listaa puhelimet, jotka on liitetty SMS-porttitiliin.

Milloin sitä käytetään

Käytä sitä valita lähettäjä, näyttö laitteen tila tai tarkastaa portti laivaston.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
sid jono Vapaaehtoinen Palauta yksi sID-auto.
search jono Vapaaehtoinen Hae SID, päivämäärä, akku, versio, etiketti ja siihen liittyvät kentät.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
POST · GET

Päivitä yhdistetty mobiili

#
endpointhttps://api.smsmobileapi.com/gateway/mobile/update/

Päivittää kytketyn laitteen ihmisluettavan merkinnän tai puhelinnumeron.

Milloin sitä käytetään

Käytä sitä pitääksesi laitemerkinnät mielekkäinä monipuhelinasennuksessa.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
sid jono Pakollinen Laite SID.
label jono Pakollinen Uusi merkki; se voi olla tarkoituksella tyhjä.
phone_number puhelin Vapaaehtoinen Uusi numerometatieto.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=DEVICE_SID&label=OfficePhone"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
POST · GET

Yhdistetyn mobiililaitteen poistaminen

#
endpointhttps://api.smsmobileapi.com/gateway/mobile/delete/

Poistaa kytketty mobiili ja sen portti historia rivit.

Milloin sitä käytetään

Käytä vain silloin, kun puhelin on poistettava pysyvästi tililtä.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen Tilisi API avain.
sid jono Pakollinen Poistattavan laitteen SID.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=DEVICE_SID"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Tämä toiminto poistaa laitehistorian liittyen SID. Vahvista laite ennen kuin soitat.
YHDISTELMÄPOST

Receive SMS by webhook

#
MÄÄRÄAIKAYour HTTPS endpoint

SMSMobileAPI sends a JSON request to your configured URL whenever an SMS is received.

Milloin sitä käytetään

Käytä webkoukkuja reaaliaikaiseen käsittelyyn tiheän kyselyn sijaan.

Vastaanottajan esimerkki

PHP 8
<?php
$payload = json_decode(file_get_contents('php://input'), true);
if (!is_array($payload) || empty($payload['guid'])) {
    http_response_code(400);
    exit('Invalid payload');
}
// Queue the event, then acknowledge quickly.
http_response_code(200);
echo 'OK';

Esimerkkivastaus

JSON
{
  "date": "2026-03-20",
  "hour": "10:15:00",
  "time_received": "2026-03-20 10:14:50",
  "message": "Hello, this is a test.",
  "number": "+123456789",
  "guid": "abcde12345"
}
Saapuvan päätetapahtuman päätetapahtuma

This endpoint receives events at your own HTTPS URL. Use the receiver example above, then send an SMS to your connected phone to test it.

Hyvä tietää
  • Aseta julkinen HTTPS URL Dashboard → Webhook Settings.
  • Palauta HTTP 200 nopeasti ja käsittele tapahtumaa synkronoidusti.
  • Deduplicate retries käyttäen Guid.
POST · GET

Clear API SMS history

#
endpointhttps://api.smsmobileapi.com/delete-history-sms-api/

Tyhjentää SMS:n palvelimen tiedot API:n kautta. Se ei muista viestiä, joka on jo kerätty puhelimella.

Milloin sitä käytetään

Käytä ensin esikatselu, tarkista laskut ja pyydä sitten nimenomaisesti poistoa. Tämä tyhjentää API-avaimen koko valitun historian ilman päivämäärää, puhelin- tai viestisuodattimia.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Vapaaehtoinen Ei OAuth2. OAuth2, valitkaa valinnaisesti API samaan tiliin kuuluva avain.
action preview | delete | status Vapaaehtoinen preview laskee tietueet poistamatta niitä; delete aloittaa poiston tai jatkaa sitä; status näyttää vain edistymisen. API:n oletus on delete, tämän testaustyökalun oletus on preview.
include_linked 0 | 1 Vapaaehtoinen Oletus 0: säilytetään linkitettyjä tai prosessoituja tietoja. Aseta 1 sisällyttämään ne, jolloin on riski murtaa integraatioita. Säilytä tämä arvo muuttumattomana, kun jatkat poistoa.
request_id jono Vapaaehtoinen Pakollinen toiminnoille delete ja status, valinnainen toiminnolle preview. Käytä 16–128 ASCII-kirjainta, numeroa, yhdysmerkkiä (-) tai alaviivaa (_). Luo jokaiselle uudelle poistolle yksilöllinen tunniste ja säilytä se kaikissa uusintayrityksissä. Tämä ei ole viestin tunniste eikä API-avain.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

Esimerkkivastaus

JSON
{
    "result": {
        "error": 0,
        "history": "sms-api",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Edellä oleva esimerkki on esikatselu, ei poisto. Laskelmat ovat havainnollisia; lopullinen valinta on vahvistettu poiston alkaessa.
  • include_linked=1 voi häiritä GHL:ää, Zapier:ää, automaatioita, peruuttaa linkit tai seurata toimitusta. Se ei koskaan ohita tilin omistajuuden tai säilytyksen eheyden tarkistuksia.
POST · GET

Clear mobile SMS history

#
endpointhttps://api.smsmobileapi.com/delete-history-sms-mobile/

Tyhjentää synkronoidut tiedot SMS:stä, joka on lähetetty matkapuhelimista, ei puhelimiin tallennetuista viesteistä.

Milloin sitä käytetään

Käytä ensin esikatselu, tarkista laskut ja pyydä sitten nimenomaisesti poistoa. Tämä tyhjentää API-avaimen koko valitun historian ilman päivämäärää, puhelin- tai viestisuodattimia.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Vapaaehtoinen Ei OAuth2. OAuth2, valitkaa valinnaisesti API samaan tiliin kuuluva avain.
action preview | delete | status Vapaaehtoinen preview laskee tietueet poistamatta niitä; delete aloittaa poiston tai jatkaa sitä; status näyttää vain edistymisen. API:n oletus on delete, tämän testaustyökalun oletus on preview.
include_linked 0 | 1 Vapaaehtoinen Oletus 0: säilytetään linkitettyjä tai prosessoituja tietoja. Aseta 1 sisällyttämään ne, jolloin on riski murtaa integraatioita. Säilytä tämä arvo muuttumattomana, kun jatkat poistoa.
request_id jono Vapaaehtoinen Pakollinen toiminnoille delete ja status, valinnainen toiminnolle preview. Käytä 16–128 ASCII-kirjainta, numeroa, yhdysmerkkiä (-) tai alaviivaa (_). Luo jokaiselle uudelle poistolle yksilöllinen tunniste ja säilytä se kaikissa uusintayrityksissä. Tämä ei ole viestin tunniste eikä API-avain.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

Esimerkkivastaus

JSON
{
    "result": {
        "error": 0,
        "history": "sms-mobile",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Edellä oleva esimerkki on esikatselu, ei poisto. Laskelmat ovat havainnollisia; lopullinen valinta on vahvistettu poiston alkaessa.
  • include_linked=1 voi häiritä GHL:ää, Zapier:ää, automaatioita, peruuttaa linkit tai seurata toimitusta. Se ei koskaan ohita tilin omistajuuden tai säilytyksen eheyden tarkistuksia.
POST · GET

Clear received SMS history

#
endpointhttps://api.smsmobileapi.com/delete-history-sms-received/

Tyhjentää palvelimen tiedot SMS:stä. Integraatio- ja automaatiotallenteet suojataan oletusarvoisesti.

Milloin sitä käytetään

Käytä ensin esikatselu, tarkista laskut ja pyydä sitten nimenomaisesti poistoa. Tämä tyhjentää API-avaimen koko valitun historian ilman päivämäärää, puhelin- tai viestisuodattimia.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Vapaaehtoinen Ei OAuth2. OAuth2, valitkaa valinnaisesti API samaan tiliin kuuluva avain.
action preview | delete | status Vapaaehtoinen preview laskee tietueet poistamatta niitä; delete aloittaa poiston tai jatkaa sitä; status näyttää vain edistymisen. API:n oletus on delete, tämän testaustyökalun oletus on preview.
include_linked 0 | 1 Vapaaehtoinen Oletus 0: säilytetään linkitettyjä tai prosessoituja tietoja. Aseta 1 sisällyttämään ne, jolloin on riski murtaa integraatioita. Säilytä tämä arvo muuttumattomana, kun jatkat poistoa.
request_id jono Vapaaehtoinen Pakollinen toiminnoille delete ja status, valinnainen toiminnolle preview. Käytä 16–128 ASCII-kirjainta, numeroa, yhdysmerkkiä (-) tai alaviivaa (_). Luo jokaiselle uudelle poistolle yksilöllinen tunniste ja säilytä se kaikissa uusintayrityksissä. Tämä ei ole viestin tunniste eikä API-avain.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-received/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-sms-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

Esimerkkivastaus

JSON
{
    "result": {
        "error": 0,
        "history": "sms-received",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Edellä oleva esimerkki on esikatselu, ei poisto. Laskelmat ovat havainnollisia; lopullinen valinta on vahvistettu poiston alkaessa.
  • include_linked=1 voi häiritä GHL:ää, Zapier:ää, automaatioita, peruuttaa linkit tai seurata toimitusta. Se ei koskaan ohita tilin omistajuuden tai säilytyksen eheyden tarkistuksia.

Vianetsintä

Virheet ja turvalliset korjaukset

Lue HTTP- tila ja JSON- virhekenttä ennen kuin yrität uudelleen. Älä yritä uudelleen validointi- tai tunnistusvirheitä korjaamatta ensin pyyntöä.

HTTPKoodiMitä tehdä?
400missing_parameterVaadittu parametri on tyhjä tai puuttuu. Tarkista päätetapahtuman parametritaulukko.
403invalid_apikeyAPI-avain on tuntematon, vanhentunut tai ei ole hyväksytty pyydettyyn ominaisuuteen.
429too_many_requestsPyyntöjä tulee liian nopeasti. -En. Yritä sitten uudelleen.
500server_errorPalvelu ei voinut täyttää pyyntöä. Pidä vastaus ja ota yhteyttä, jos se jatkuu.
Yritä uudelleen sääntöKokeile vain ohimeneviä 429 ja 5xx-vasteita. Aloita 1 sekunnin jälkeen ja peräänny 2, 4 ja 8 sekunnin kuluttua.

Tarvitsetko apua?

Tuo pyyntö kontekstia. Ei salaisuuksia.

Jaa päätepiste, aikaleima, HTTP-status ja puhdistava vaste. Älä koskaan sisälly API-näppäimiin, rahakkeisiin tai yksityiseen viestisisältöön.

Ota yhteyttä API-tukeen →