Doc Dev -kutsu - SMSMobileAPI
SMSMobileAPI – Puhelunhallinta-API:n dokumentaatio

Puhelunhallinta-API:n dokumentaatio

Näiden päätepisteiden avulla voit hakea Vastaamattomat puhelut, Saapuvat vastatut puhelut, ja Lähtevät puhelut synkronoitu SMSMobileAPI-mobiilisovelluksesta kojelautaasi + API:in.

Tärkeää: jos mobiilisovellus toimii taustalla, puhelinjärjestelmä saattaa aiheuttaa viiveen (usein jopa noin 10 minuuttia) synkronointien välillä. Voit aina avata sovelluksen synkronointia varten manuaalisesti tarvittaessa.

Tarvitsetko apua? api@smsmobileapi.com

Pika-aloitus

Perus-URL

SAADA https://api.smsmobileapi.com
Kaikki alla olevat päätepisteet on dokumentoitu seuraavasti: SAADA pyyntöjä. Korvaa YOUR_API_AVAIN oikealla avaimellasi (älä jaa sitä julkisesti).

Esimerkkejä

HANKI https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY
HANKI https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
HANKI https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=1555&date_from_ms=17000000000000&date_to_ms=1700864000000

Todennus

Puheluidenhallinnan päätepisteet todennetaan käyttämällä apikey kyselyparametri.

Tilauksen vahvistus: Saapuvat/lähtevät päätepisteet vahvistavat API-avaimesi ja tarkistavat tilauksesi voimassaolon (päivämääräraja >= CURDATE()). Jos voimassaoloaika on umpeutunut, saat api_vanhentunut.

Yleisiä käsitteitä

Sivunumerointi

Käyttää rajoittaa ja offset sivuttaaksesi tulokset.

Aikaleimat

  • puhelupäivämäärä_ms on UNIX-aikaleima millisekuntia.
  • puhelupäivämäärä_aika_UTC tallennetaan UTC-päivämäärä- ja aikamerkkijonona (tietokantakenttä).
  • Vastaamattomien puheluiden osalta API palauttaa muotoillun päivämäärä merkkijono (johdettu millisekuntiarvosta).

Haku

  • Vastaamattomat puhelut: haku vastaa numeroa tai nimeä.
  • Saapuva/Lähtevä: q tulitikut puhelinnumero tai välimuistissa_ oleva_nimi.

Lajittelu (vain saapuvat/lähtevät)

Lajittelua ohjaa lajitteluperuste + lajitteluhakemisto (vain valkoisen listan kentät). Vastaamattomat puhelut järjestetään aina uusimmasta alkaen.

Kaikki tässä dokumentaatiossa olevat vastausesimerkit ovat anonymisoituAlla näkyvät API-avaimet, puhelinnumerot ja yhteyshenkilöiden nimet ovat vain esimerkkiarvoja.

Virheet

HTTP Esimerkkivirhe Merkitys
400 {"success":false,"error":"puuttuva_apiavain"} Puuttuu tai on tyhjä apikey.
403 {"onnistui":false,"virhe":"virheellinen_apiavain"} API-avainta ei löydy / sitä ei tunnistettu.
403 {"onnistui":false,"virhe":"api_vanhentunut"} Tilauksesi on vanhentunut (päivämääräraja on ennen tätä päivää).
500 {"success":false,"error":"server_error","detail":"..."} Palvelinvirhe (tietokanta, SQL, poikkeus).

Huomautus: Vastaamattomien puheluiden päätepiste voi myös palauttaa viestejä, kuten Puuttuva apikey tai SQL-valmisteluvirheitä tilanteesta riippuen.

Vastaamattomat puhelut – Luettelo

Hae mobiililaitteesta synkronoidut vastaamattomat puhelut.

Päätepiste

SAADA https://api.smsmobileapi.com/call/missed/list/

Kyselyparametrit

ParametriTyyppiKuvaus
apikeyjonoPakollinen Matkapuhelimeen linkitetty API-avaimesi.
offsetintValinnainen Sivutuksen siirtymä (oletus: 0).
rajoittaaintValinnainen Rivien enimmäismäärä (oletus: 100, maks.: 500).
hakujonoValinnainen Hae numeron tai nimen perusteella (SQL LIKE).
päivämäärän_aloitusVVVV-KK-PPValinnainen Suodata tältä päivältä (00:00:00).
päivämäärän_loppuVVVV-KK-PPValinnainen Suodata tähän päivään asti (23:59:59).

Esimerkkipyyntö

HANKI https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY&offset=0&limit=100

Esimerkki JSON-vastauksesta

{ "success": true, "offset": 0, "limit": 100, "count": 3, "data": [ { "number": "+15551230001", "name": "", "date": "2026-03-20 16:12:28" }, { "number": "+15551230002", "name": "Alex Carter", "date": "2026-03-20 16:12:00" }, { "number": "+447700900123", "name": "Taylor Reed", "date": "2026-03-20 15:48:41" } ] }

Vastauksen selitys

AlaKuvaus
menestystotta tarkoittaa, että pyyntö on käsitelty onnistuneesti.
offsetAPI:n palauttama sivutusoffset.
rajoittaaSivutusrajoitus on käytössä pyyntöön.
laskeaPalautettujen rivien määrä data.
dataVastaamattomien puheluiden merkintöjä sisältävä taulukko.
data[].numeroSoittajan puhelinnumero.
data[].nimiVälimuistissa oleva yhteyshenkilön nimi. Voi olla tyhjä, jos yhteyshenkilön nimeä ei ole saatavilla.
data[].päivämääräMuotoiltu puhelun päivämäärä ja kellonaika.
Yllä olevat esimerkkiarvot ovat anonymisoituja. Todellisissa vastauksissa voi olla eri puhelinnumeroita ja yhteystietojen tunnisteita.

Saapuvat puhelut – Luettelo

Hae saapuvat ja vastatut puhelut synkronoituna mobiililaitteesta.

Päätepiste

SAADA https://api.smsmobileapi.com/call/incoming/list/

Kyselyparametrit

ParametriTyyppiKuvaus
apikeyjonoPakollinen API-avaimesi (vahvistettu tilausta vastaan).
rajoittaaintValinnainen Riviä sivulla (oletus: 50, maks.: 200).
offsetintValinnainen Sivutuksen siirtymä (oletus: 0).
lajitteluperustejono Valinnainen Sallittu: puhelupäivämäärä_ms puhelupäivämäärä_aika_UTC kesto_sekuntia puhelinnumero luotu_paikalla välimuistissa_ oleva_nimi maantieteellinen_sijainti
lajitteluhakemistonouseva|laskevaValinnainen Oletus: kuvaus.
päivämäärä_alkaen_mskokonaisluku (ms)Valinnainen Suodata missä puhelupäivämäärä_ms >= soittopäivämäärä_ms.
päivämäärä_loppuun_mskokonaisluku (ms)Valinnainen Suodata missä kutsupäivämäärä_ms <= päättymispäivämäärä_ms.
qjonoValinnainen Hae sivustolta puhelinnumero tai välimuistissa_ oleva_nimi (PITÄÄ).

Esimerkkipyyntö

HANKI https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc

Esimerkki JSON-vastauksesta

{ "success": true, "apikey": "YOUR_API_KEY_HASH", "limit": 50, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": null }, "count": 3, "rows": [ { "phone_number": "+15551230010", "cached_name": "Jordan Blake", "call_date_ms": 1774027779390, "call_datetime_utc": "2026-03-20 17:29:39", "duration_sec": 23, "geo_location": "Kanada", "created_at": "2026-03-20 17:46:45" }, { "phone_number": } "+15551230011", "cached_name": "Morgan Lee", "call_date_ms": 1774018268663, "call_datetime_utc": "2026-03-20 14:51:08", "duration_sec": 50, "geo_location": "Kanada", "created_at": "2026-03-20 14:58:37" }, { "phone_number": "+447700900124", "cached_name": "Sam Parker", "call_date_ms": 1774011205123, "call_datetime_utc": "2026-03-20 12:53:25", "duration_sec": 92, "geo_location": "Kanada", "created_at": "2026-03-20 12:59:01" } ] }

Vastauksen selitys

AlaKuvaus
menestystotta tarkoittaa, että pyyntö on käsitelty onnistuneesti.
apikeyToistettu API-avaimen arvo. Dokumentaatioesimerkeissä tämä tulisi aina peittää.
rajoittaaSivua kohden pyydettyjen rivien määrä.
offsetAPI:n palauttama sivutusoffset.
lajitteluperusteAPI:n käyttämä lajittelukenttä.
lajitteluhakemistoAPI:n käyttämä lajittelusuunta.
suodattimetObjekti, joka sisältää pyynnössä käytetyt aktiiviset suodattimet.
laskeaPalautettujen rivien määrä rivit.
rivitSaapuvien ja vastattujen puheluiden merkintöjä sisältävä taulukko.
rivit[].puhelinnumeroPuheluun linkitetty puhelinnumero.
rivit[].välimuistissa_oleva_nimiVälimuistissa oleva yhteyshenkilön nimi. Voi olla null tai tyhjä saatavilla olevien tietojen mukaan.
rivit[].puhelupäivämäärä_msKutsun aikaleima millisekunteina.
rivit[].kutsupäivämäärä_aika_utcPuhelun UTC-päivämäärä ja -aika.
rivit[].kesto_sekuntiaPuhelun kesto sekunteina.
rivit[].geo_locationNumeroon liittyvä maantieteellinen tunniste, jos saatavilla.
rivit[].luodtu_kohdassaPäivämäärä ja aika, jolloin rivi lisättiin palvelimelle.
API voi toistaa sinun apikey vastauksessa. Julkisissa dokumenteissa, kuvakaappauksissa ja esimerkeissä se tulee aina peittää.

Lähtevät puhelut – Luettelo

Hae mobiililaitteesta synkronoidut lähtevät puhelut.

Päätepiste

SAADA https://api.smsmobileapi.com/call/outgoing/list/

Kyselyparametrit

Samat parametrit ja toiminta kuin Saapuvat puhelut -kohdassa.

ParametriTyyppiKuvaus
apikeyjonoPakollinen API-avaimesi (vahvistettu tilausta vastaan).
rajoittaaintValinnainen Riviä sivulla (oletus: 50, maks.: 200).
offsetintValinnainen Sivutuksen siirtymä (oletus: 0).
lajitteluperustejono Valinnainen Sallittu: puhelupäivämäärä_ms puhelupäivämäärä_aika_UTC kesto_sekuntia puhelinnumero luotu_paikalla välimuistissa_ oleva_nimi maantieteellinen_sijainti
lajitteluhakemistonouseva|laskevaValinnainen Oletus: kuvaus.
päivämäärä_alkaen_mskokonaisluku (ms)Valinnainen Suodata missä puhelupäivämäärä_ms >= soittopäivämäärä_ms.
päivämäärä_loppuun_mskokonaisluku (ms)Valinnainen Suodata missä kutsupäivämäärä_ms <= päättymispäivämäärä_ms.
qjonoValinnainen Hae sivustolta puhelinnumero tai välimuistissa_ oleva_nimi (PITÄÄ).

Esimerkkipyyntö

HANKI https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc

Esimerkki JSON-vastauksesta

{ "success": true, "apikey": "YOUR_API_KEY_HASH", "limit": 50, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": null }, "count": 3, "rows": [ { "phone_number": "+15551230020", "cached_name": "Casey Morgan", "call_date_ms": 1774025965645, "call_datetime_utc": "2026-03-20 16:59:25", "duration_sec": 15, "geo_location": "Kanada", "created_at": "2026-03-20 17:17:58" }, { "phone_number": } "+15551230021", "cached_name": "Taylor Brooks", "call_date_ms": 1774023172638, "call_datetime_utc": "2026-03-20 16:12:52", "duration_sec": 556, "geo_location": "Kanada", "created_at": "2026-03-20 16:28:38" }, { "phone_number": "+33198765432", "cached_name": "Jamie Carter", "call_date_ms": 1774019040000, "call_datetime_utc": "2026-03-20 15:04:00", "duration_sec": 61, "geo_location": "Kanada", "created_at": "2026-03-20 15:09:11" } ] }

Vastauksen selitys

AlaKuvaus
menestystotta tarkoittaa, että pyyntö on käsitelty onnistuneesti.
apikeyToistettu API-avaimen arvo. Dokumentaatioesimerkeissä tämä tulisi aina peittää.
rajoittaaSivua kohden pyydettyjen rivien määrä.
offsetAPI:n palauttama sivutusoffset.
lajitteluperusteAPI:n käyttämä lajittelukenttä.
lajitteluhakemistoAPI:n käyttämä lajittelusuunta.
suodattimetObjekti, joka sisältää pyynnössä käytetyt aktiiviset suodattimet.
laskeaPalautettujen rivien määrä rivit.
rivitLähtevien puheluiden merkintöjä sisältävä taulukko.
rivit[].puhelinnumeroPuheluun linkitetty puhelinnumero.
rivit[].välimuistissa_oleva_nimiVälimuistissa oleva yhteyshenkilön nimi. Voi olla null tai tyhjä saatavilla olevien tietojen mukaan.
rivit[].puhelupäivämäärä_msKutsun aikaleima millisekunteina.
rivit[].kutsupäivämäärä_aika_utcPuhelun UTC-päivämäärä ja -aika.
rivit[].kesto_sekuntiaPuhelun kesto sekunteina.
rivit[].geo_locationNumeroon liittyvä maantieteellinen tunniste, jos saatavilla.
rivit[].luodtu_kohdassaPäivämäärä ja aika, jolloin rivi lisättiin palvelimelle.
Yllä olevat esimerkkiarvot ovat anonymisoituja. Korvaa ne omilla reaaliaikaisilla tiedoillasi vain yksityisissä/sisäisissä työkaluissa, älä koskaan julkisissa dokumenteissa.

Vastaamattomien puheluiden kentät

AlaTyyppiKuvaus
menestystotuusarvoPyynnön tila.
offsetintSivutuksen siirtymä palautettu.
rajoittaaintSivutusrajoitus palautettu.
laskeaintPalautettujen rivien määrä data.
datataulukkoVastaamattomien puheluiden luettelo.
data[].numerojonoSoittajan puhelinnumero.
data[].nimijonoVälimuistissa oleva yhteyshenkilön nimi (voi olla tyhjä).
data[].päivämääräjonoMuotoiltu päivämäärä ja kellonaika -merkkijono, joka on johdettu millisekuntien aikaleimasta.

Saapuvat/Lähtevät kentät

AlaTyyppiKuvaus
menestystotuusarvoPyynnön tila.
apikeyjonoAPI (avaimesi) toistaa sen. Julkisissa dokumenteissa peitä se aina.
rajoittaaintPalautettujen rivien määrä sivua kohden.
offsetintSivutuksen siirtymä palautettu.
lajitteluperustejonoLajittelukenttä käytössä.
lajitteluhakemistojonoLajittelusuunta käytössä.
suodattimetesineKaikusuodattimet (päivämäärä_alkaen_ms, päivämäärä_loppuun_ms, q).
laskeaintPalautettujen rivien määrä rivit.
rivittaulukkoPuheluluettelo.
rivit[].puhelinnumerojonoPuhelinnumero.
rivit[].välimuistissa_oleva_nimimerkkijono|nullVälimuistissa oleva yhteyshenkilön nimi (voi olla tyhjä).
rivit[].puhelupäivämäärä_msintKutsun aikaleima millisekunteina.
rivit[].kutsupäivämäärä_aika_utcjonoUTC-päivämäärä- ja aikakenttä (tietokanta).
rivit[].kesto_sekuntiaintKesto sekunteina.
rivit[].geo_locationmerkkijono|nullMaantieteellisen sijainnin tunniste (voi olla tyhjä/null).
rivit[].luodtu_kohdassajonoPalvelimen lisäyksen aikaleima.
Tarvitsetko apua? Yhteystiedot api@smsmobileapi.com
Vinkki: älä koskaan julkaise API-avaintasi kuvakaappauksissa, tikettien avulla tai julkisissa arkistoissa.
💬 Live-chat
💬 Live-chat saatavilla
Onko sinulla kysyttävää tai tarvitsetko apua?
Tiimimme on täällä auttaakseen sinua!
Anna sähköpostiosoitteesi
auttaaksemme meitä pyyntösi käsittelyssä:
Kojelauta