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=3247&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.
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
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| apikey | jono | Pakollinen Matkapuhelimeen linkitetty API-avaimesi. |
| offset | int | Valinnainen Sivutuksen siirtymä (oletus: 0). |
| rajoittaa | int | Valinnainen Rivien enimmäismäärä (oletus: 100, maks.: 500). |
| haku | jono | Valinnainen Hae numeron tai nimen perusteella (SQL LIKE). |
| päivämäärän_aloitus | VVVV-KK-PP | Valinnainen Suodata tältä päivältä (00:00:00). |
| päivämäärän_loppu | VVVV-KK-PP | Valinnainen Suodata tähän päivään asti (23:59:59). |
Saapuvat puhelut – Luettelo
Hae saapuvat ja vastatut puhelut synkronoituna mobiililaitteesta.
Päätepiste
SAADA https://api.smsmobileapi.com/call/incoming/list/
Kyselyparametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| apikey | jono | Pakollinen API-avaimesi (vahvistettu tilausta vastaan). |
| rajoittaa | int | Valinnainen Riviä sivulla (oletus: 50, maks.: 200). |
| offset | int | Valinnainen Sivutuksen siirtymä (oletus: 0). |
| lajitteluperuste | jono | Valinnainen Sallittu: puhelupäivämäärä_ms puhelupäivämäärä_aika_UTC kesto_sekuntia puhelinnumero luotu_paikalla välimuistissa_ oleva_nimi maantieteellinen_sijainti |
| lajitteluhakemisto | nouseva|laskeva | Valinnainen Oletus: kuvaus. |
| päivämäärä_alkaen_ms | kokonaisluku (ms) | Valinnainen Suodata missä puhelupäivämäärä_ms >= soittopäivämäärä_ms. |
| päivämäärä_loppuun_ms | kokonaisluku (ms) | Valinnainen Suodata missä kutsupäivämäärä_ms <= päättymispäivämäärä_ms. |
| q | jono | Valinnainen Hae sivustolta puhelinnumero tai välimuistissa_ oleva_nimi (PITÄÄ). |
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.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| apikey | jono | Pakollinen API-avaimesi (vahvistettu tilausta vastaan). |
| rajoittaa | int | Valinnainen Riviä sivulla (oletus: 50, maks.: 200). |
| offset | int | Valinnainen Sivutuksen siirtymä (oletus: 0). |
| lajitteluperuste | jono | Valinnainen Sallittu: puhelupäivämäärä_ms puhelupäivämäärä_aika_UTC kesto_sekuntia puhelinnumero luotu_paikalla välimuistissa_ oleva_nimi maantieteellinen_sijainti |
| lajitteluhakemisto | nouseva|laskeva | Valinnainen Oletus: kuvaus. |
| päivämäärä_alkaen_ms | kokonaisluku (ms) | Valinnainen Suodata missä puhelupäivämäärä_ms >= soittopäivämäärä_ms. |
| päivämäärä_loppuun_ms | kokonaisluku (ms) | Valinnainen Suodata missä kutsupäivämäärä_ms <= päättymispäivämäärä_ms. |
| q | jono | Valinnainen Hae sivustolta puhelinnumero tai välimuistissa_ oleva_nimi (PITÄÄ). |
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. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian