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.
Pika-aloitus
Perus-URL
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=3247&date_from_ms=17000000000000&date_to_ms=1700864000000
Todennus
Puheluidenhallinnan päätepisteet todennetaan käyttämällä apikey kyselyparametri.
päivämääräraja >= CURDATE()). Jos voimassaoloaika on umpeutunut, saat api_vanhentunutVastaamattomien puheluiden päätepiste saattaa palauttaa yleisen ”Puuttuva apikey” -virheen / palvelinvirheen olosuhteista riippuen.
Yleisiä käsitteitä
Sivunumerointi
Käyttää rajoittaa ja offset sivuttaaksesi tulokset.
Aikaleimat
puhelupäivämäärä_mson UNIX-aikaleima millisekuntia.puhelupäivämäärä_aika_UTCtallennetaan UTC-päivämäärä- ja aikamerkkijonona (tietokantakenttä).- Vastaamattomien puheluiden osalta API palauttaa muotoillun
päivämäärämerkkijono (johdettu millisekuntiarvosta).
Haku
- Vastaamattomat puhelut:
hakuvastaa numeroa tai nimeä. - Saapuva/Lähtevä:
qvastaa phone_number- tai cached_name-arvoa.
Lajittelu (vain saapuvat/lähtevät)
Lajittelua ohjaa lajitteluperuste + lajitteluhakemisto (vain valkoisen listan kentät). Vastaamattomat puhelut järjestetään aina uusimmasta alkaen.
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
Kyselyparametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
Pakollinenapikey |
jono | Matkapuhelimeen linkitetty API-avaimesi. |
Valinnainenoffset |
int | Sivutuksen siirtymä (oletus: 0). |
Valinnainenrajoittaa |
int | Palautettavien rivien enimmäismäärä (oletus: 100, maks.: 500). |
Valinnainenhaku |
jono | Hae numeron tai nimen perusteella (SQL LIKE). |
Valinnainenpäivämäärän_aloitus |
VVVV-KK-PP | Suodata tästä päivästä (00:00:00). Verrattuna tallennettuun millisekuntiaikaleimaan. |
Valinnainenpäivämäärän_loppu |
VVVV-KK-PP | Suodata tähän päivään asti (23:59:59). Verrattuna tallennettuun millisekuntiaikaleimaan. |
Lajittelu
Korjattu: uusin ensin (JÄRJESTÄ päivämäärän MUKAAN LASKEVA).
Esimerkkipyyntö
HANKI https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY&limit=100&offset=0&search=John&date_start=2026-02-01&date_end=2026-02-24
Esimerkkivastaus
{ "onnistuminen": true, "offset": 0, "limit": 100, "count": 2, "data": [ { "number": "+123470000000", "name": "Matti Meikäläinen", "date": "2026-02-24 12:49:39" }, { "number": "+123471111111", "name": "", "date": "2026-02-24 11:12:09" } ] }
Saapuvat puhelut – Luettelo
Hae saapuvat ja vastatut puhelut synkronoituna mobiililaitteesta.
Päätepiste
Kyselyparametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
Pakollinenapikey |
jono | API-avaimesi. Vahvistettu tilausta vastaan (päivämääräraja). |
Valinnainenrajoittaa |
int | Riviä sivulla (oletus: 50, min 1, max 200). |
Valinnainenoffset |
int | Sivutuksen siirtymä (oletus: 0). |
Valinnainenlajitteluperuste |
jono |
Lajittelukenttä (oletus: puhelupäivämäärä_ms). Sallittu:
puhelupäivämäärä_ms, puhelupäivämäärä_aika_UTC, kesto_sekuntia, puhelinnumero,
luotu_paikalla, välimuistissa_ oleva_nimi, maantieteellinen_sijainti.
|
Valinnainenlajitteluhakemisto |
nouseva|laskeva | Lajittelusuunta (oletus: kuvaus). |
Valinnainenpäivämäärä_alkaen_ms |
kokonaisluku (ms) | Suodata missä puhelupäivämäärä_ms >= soittopäivämäärä_ms. |
Valinnainenpäivämäärä_loppuun_ms |
kokonaisluku (ms) | Suodata missä kutsupäivämäärä_ms <= päättymispäivämäärä_ms. |
Valinnainenq |
jono | Hae (TYKKÄÄ) sivustolta puhelinnumero tai välimuistissa_ oleva_nimi. |
Esimerkkipyyntö
HANKI https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=100&offset=0&sort_by=call_date_ms&sort_dir=desc&q=3247
Esimerkkivastaus
{ "success": true, "apikey": "OMA_API_AVAIMESI", "limit": 100, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": "+12347" }, "count": 2, "rows": [ { "phone_number": "+123470000000", "cached_name": "Matteo Css", "call_date_ms": 1761233379000, "call_datetime_utc": "2026-02-23 12:49:39", "duration_sec": 440, "geo_location": "Belgia", "created_at": "2026-02-24 04:14:38" } } ] }
Lähtevät puhelut – Luettelo
Hae mobiililaitteesta synkronoidut lähtevät puhelut.
Päätepiste
Kyselyparametrit
Samat parametrit ja toiminta kuin Saapuvat puhelut -kohdassa.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
Pakollinenapikey |
jono | API-avaimesi. Vahvistettu tilausta vastaan (päivämääräraja). |
Valinnainenrajoittaa |
int | Riviä sivulla (oletus: 50, maks. 200). |
Valinnainenoffset |
int | Sivutuksen siirtymä (oletus: 0). |
Valinnainenlajitteluperuste |
jono |
Oletus puhelupäivämäärä_msSallittu:
puhelupäivämäärä_ms, puhelupäivämäärä_aika_UTC, kesto_sekuntia, puhelinnumero,
luotu_paikalla, välimuistissa_ oleva_nimi, maantieteellinen_sijainti.
|
Valinnainenlajitteluhakemisto |
nouseva|laskeva | Oletus kuvaus. |
Valinnainenpäivämäärä_alkaen_ms |
kokonaisluku (ms) | Suodata tästä aikaleimasta (ms). |
Valinnainenpäivämäärä_loppuun_ms |
kokonaisluku (ms) | Suodata tähän aikaleimaan (ms) asti. |
Valinnainenq |
jono | Hae sivustolta puhelinnumero tai välimuistissa_ oleva_nimi. |
Esimerkkipyyntö
HANKI https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=duration_sec&sort_dir=desc&date_from_ms=17000000000000&date_to_ms=1700864000000
Esimerkkivastaus
{ "success": true, "apikey": "OMA_API_AVAIMESI", "limit": 50, "offset": 0, "sort_by": "duration_sec", "sort_dir": "desc", "filters": { "date_from_ms": "1700000000000", "date_to_ms": "1700864000000", "q": null }, "count": 1, "rows": [ { "phone_number": "+123490000000", "cached_name": null, "call_date_ms": 1761231000000, "call_datetime_utc": "2026-02-23 12:10:00", "duration_sec": 120, "geo_location": "Belgia", "created_at": "2026-02-24 04:14:37" } ] }
Vastaamattomien puheluiden kentät
| Ala | Tyyppi | Kuvaus |
|---|---|---|
menestys | totuusarvo | Pyynnön tila. |
offset | int | Sivutuksen siirtymä palautettu. |
rajoittaa | int | Sivutusrajoitus palautettu. |
laskea | int | Palautettujen rivien määrä data. |
data | taulukko | Vastaamattomien puheluiden luettelo. |
data[].numero | jono | Soittajan puhelinnumero. |
data[].nimi | jono | Välimuistissa oleva yhteyshenkilön nimi (voi olla tyhjä). |
data[].päivämäärä | jono | Muotoiltu päivämäärä ja kellonaika -merkkijono, joka on johdettu millisekuntien aikaleimasta. |
Saapuvat/Lähtevät kentät
| Ala | Tyyppi | Kuvaus |
|---|---|---|
menestys | totuusarvo | Pyynnön tila. |
apikey | jono | API (avaimesi) toistaa sen. |
rajoittaa | int | Palautettujen rivien määrä sivua kohden. |
offset | int | Sivutuksen siirtymä palautettu. |
lajitteluperuste | jono | Lajittelukenttä käytössä. |
lajitteluhakemisto | jono | Lajittelusuunta käytössä. |
suodattimet | esine | Kaikusuodattimet (päivämäärä_alkaen_ms, päivämäärä_loppuun_ms, q). |
laskea | int | Palautettujen rivien määrä rivit. |
rivit | taulukko | Puheluluettelo. |
rivit[].puhelinnumero | jono | Puhelinnumero. |
rivit[].välimuistissa_oleva_nimi | merkkijono|null | Välimuistissa oleva yhteyshenkilön nimi (voi olla tyhjä). |
rivit[].puhelupäivämäärä_ms | int | Kutsun aikaleima millisekunteina. |
rivit[].kutsupäivämäärä_aika_utc | jono | UTC-päivämäärä- ja aikakenttä (tietokanta). |
rivit[].kesto_sekuntia | int | Kesto sekunteina. |
rivit[].geo_location | merkkijono|null | Maantieteellisen sijainnin tunniste (voi olla tyhjä/null). |
rivit[].luodtu_kohdassa | jono | Palvelimen lisäyksen aikaleima. |
