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

PUSH · 3 dokumentoitua toimintoa

Ilmoitus API-asiakirjat

Lähetä sisäiset ilmoitukset tiettyyn yhdistettyyn mobiiliin ja hae niiden jakeluhistoria.

Matkapuhelimet, jotka liittyvät reaaliaikaisiin puhelu- ja analytiikkatietoihin
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

Listaa liitetyt matkapuhelimet ja kopioi kohde SID.

2

Luo ilmoitus otsikolla ja viestillä.

3

Polta luettelo päätepisteestä SID:n mukaan.

4

Käytä distributed status ja GMT aikaleimat seurata jakelua.

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 Lataa Apple App Storen virallinen SMSMobileAPI-sovellus
Kyvyt riippuvat Android:n tai iOS:n sallimista käyttöoikeuksista ja tausta-aineistoista.

WEBHOOK V2 TÄLLE API:LLE

Käytä mobiiliviestintää seuraavan liiketoimintatoimenpiteen käynnistämiseen.

3 tapahtumatyyppiä

Yksi kohde voi vastaanottaa kaiken, tai voit erotella tuotantojärjestelmät, analytiikan ja operatiiviset hälytykset. Jokaisella tapahtumalla on tarkka nimi, jotta sovelluksesi käsittelee ne ennustettavasti.

Important

Ilmoitus-API lähettää ilmoituksia yhdistetyille laitteille. Se ei tällä hetkellä julkaise erillistä ilmoitus-webhook-tapahtumaa. Käytä ilmoitustyönkulun käynnistämiseen lähdetapahtumia, kuten vastaanotettua tekstiviestiä, vastaamatonta puhelua tai vastaanotettua WhatsApp-viestiä.

sms.received

SMS vastaanotettu

Yhdistetty mobiililaite synkronoi saapuneen SMS.

call.missed

Vastaamaton puhelu

Yhdistetystä mobiililaitteesta synkronoitiin vastaamaton puhelu.

whatsapp.received

WhatsApp vastaanotettu

Tilin synkronointipyynnön jälkeen haettiin WhatsApp-viesti.

Todennus

Pidä tiedot palvelimellasi

Ilmoituksen päätepisteissä käytetään apikey-parametria. Kohdepuhelin tunnistetaan Sid kun lähetät ja Sid tai sidentifiant kun listaa.

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-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OTAM2
curl -X POST "https://api.smsmobileapi.com/delete-history-notifications/" \
  -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-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET hyväksyy myös action=preview:n tai action=delete:n. POST suositellaan: URL-parametrit voivat vuotaa selaimen historiaan ja palvelinlokiin. Älä koskaan aseta poisto-osoitetta julkiseen linkkiin, kuva tai 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://WWW.EUROPA.EU/
{
    "result": {
        "error": 0,
        "history": "notifications",
        "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.
POSTI

Lähetä ilmoitus

#
endpointhttps://api.smsmobileapi.com/notification/send

Luo sisäisen ilmoituksen yhdestä kytketystä laitteesta.

Milloin sitä käytetään

Käytä sitä operatiivisissa kuulutuksissa, jotka olisi esitettävä hallitussa puhelimessa.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.
sid jono Pakollinen Kohde on salainen.
title jono Vapaaehtoinen Ilmoitusnimike; ilmoituksen laiminlyönnit.
message jono Pakollinen Ilmoituksen sisältö.
type jono Vapaaehtoinen Ilmoituksen tyyppi; ilmoituksen laiminlyönti.

Esimerkki pyynnön esittämisestä

kiemura
curl -X POST "https://api.smsmobileapi.com/notification/send" \
  -d "apikey=YOUR_API_KEY" \
  -d "sid=TARGET_SIDENTIFIANT" \
  --data-urlencode "title=Order ready" \
  --data-urlencode "message=Order #1042 is ready for collection."

Esimerkkivastaus

JSON
{
  "success": true,
  "message": "Notification created.",
  "id": 22087,
  "apikey": "YOUR_API_KEY",
  "sid": "508b004b4aadacc4"
}

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

Liitä avain ↑
Hyvä tietää
  • Luominen ja jakelu ovat erillisiä tapahtumia. Käytä luettelon päätepistettä tarkistaaksesi toimituksen laitteelle.
SAADA

Luettelo ilmoituksista

#
endpointhttps://api.smsmobileapi.com/notification/list/

Palauttaa jopa 200 ilmoitusta tilattu uusimmista vanhimpiin.

Milloin sitä käytetään

Käytä sitä seurata jakelua ja rakentaa ilmoitushistoria.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.
sidentifiant jono Vapaaehtoinen Suodata kohdemobiililla.
sid jono Vapaaehtoinen - Sidentifiantin peitenimiä.
distribued 0 | 1 Vapaaehtoinen 1 jaetulle, 0 jakamatta.
date_from VVVV-KK-PP Vapaaehtoinen Aloituspäivä.
date_to VVVV-KK-PP Vapaaehtoinen Päättymispäivä.

Esimerkki pyynnön esittämisestä

kiemura
curl "https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY&sidentifiant=TARGET_SIDENTIFIANT&distribued=1"

Esimerkkivastaus

JSON
{
  "success": true,
  "count": 1,
  "data": [{
    "sidentifiant": "508b004b4aadacc4",
    "title": "Order ready",
    "message": "Order #1042 is ready for collection.",
    "distribued": "1",
    "distribued_status": "distributed",
    "distributed_at_gmt": "2026-03-18 10:18:30",
    "distributed_at_unix": 1773829110,
    "sent_at_gmt": "2026-03-18 10:15:03",
    "sent_at_unix": 1773828903
  }]
}

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

Liitä avain ↑
Hyvä tietää
  • Kaikki lähetetyt ja jaetut aikaleimat ovat GMT:tä.
POSTI

Tyhjennä ilmoitushistoria

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

Tyhjentää tämän tilin omistamien matkapuhelimien ilmoitustiedot. Se ei irrota matkapuhelimia.

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

kiemura
curl -X POST "https://api.smsmobileapi.com/delete-history-notifications/" \
  --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-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OTAM2
curl -X POST "https://api.smsmobileapi.com/delete-history-notifications/" \
  -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-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

Esimerkkivastaus

JSON
{
    "result": {
        "error": 0,
        "history": "notifications",
        "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 required paramApina, sivusauva tai viesti puuttuu.
400Invalid date formatKäytä VVVV-KK-PP päivämäärä alkaen ja päivämäärä to.
400Invalid distribued valueVain 0 tai 1 hyväksytään.
500DB connection / query failedIlmoituspalvelu ei voinut suorittaa toimenpidettä loppuun.
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 →