Dokumentation af API til opkaldsstyring
Disse slutpunkter giver dig mulighed for at hente dine Ubesvarede opkald, Indgående besvarede opkald, og Udgående opkald synkroniseret fra SMSMobileAPI-mobilappen til dit dashboard + API.
Vigtigt: Hvis mobilappen kører i baggrunden, kan telefonsystemet muligvis pålægge en forsinkelse (ofte op til ~10 minutter) mellem synkroniseringer. Du kan altid åbne appen for at synkronisere manuelt, hvis det er nødvendigt.
Hurtigstart
Basis-URL
Eksempler
Autentificering
Opkaldsstyringsslutpunkter godkendes ved hjælp af apikey forespørgselsparameter.
Almindelige begreber
Paginering
Bruge begrænse og forskydning at paginere resultater.
Tidsstempler
- opkaldsdato_ms er et UNIX-tidsstempel i millisekunder.
- opkaldsdato_tidspunkt_utc gemmes som en UTC-dato- og klokkeslætsstreng (databasefelt).
- For ubesvarede opkald returnerer API'en et formateret dato streng (afledt af en millisekundværdi).
Søge
- Ubesvarede opkald: søge matcher nummer eller navn.
- Indgående/Udgående: q kampe telefonnummer eller cachelagret_navn.
Sortering (kun indgående/udgående)
Sortering styres af sorter_efter + sorteringsmappe (kun hvidlistede felter). Ubesvarede opkald sorteres altid efter nyeste først.
Fejl
| HTTP | Eksempelfejl | Mening |
|---|---|---|
| 400 | {"succes":false,"error":"missing_apikey"} | Mangler eller er tom apikey. |
| 403 | {"succes":false,"error":"invalid_apikey"} | API-nøgle ikke fundet / ikke genkendt. |
| 403 | {"succes":false,"error":"api_expired"} | Dit abonnement er udløbet (datogrænse er før i dag). |
| 500 | {"succes":false,"error":"server_error","detail":"..."} | Serverfejl (database, SQL, undtagelse). |
Bemærk: Slutpunktet for ubesvarede opkald kan også returnere beskeder som Manglende apikey eller SQL-forberedelsesfejl afhængigt af situationen.
Ubesvarede opkald – Liste
Hent ubesvarede opkald synkroniseret fra mobilenheden.
Slutpunkt
Forespørgselsparametre
| Parameter | Type | Beskrivelse |
|---|---|---|
| apikey | snor | Påkrævet Din API-nøgle er knyttet til mobiltelefonen. |
| forskydning | int | Valgfri Pagineringsforskydning (standard: 0). |
| begrænse | int | Valgfri Maks. rækker (standard: 100, maks: 500). |
| søge | snor | Valgfri Søg efter nummer eller navn (SQL LIKE). |
| startdato | ÅÅÅÅ-MM-DD | Valgfri Filtrer fra denne dag (00:00:00). |
| dato_slut | ÅÅÅÅ-MM-DD | Valgfri Filtrer op til i dag (23:59:59). |
Eksempel på anmodning
Eksempel på JSON-svar
{ "succes": sand, "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" } ] }
Forklaring af svar
| Felt | Beskrivelse |
|---|---|
| succes | ægte betyder, at anmodningen blev behandlet korrekt. |
| forskydning | Pagineringsforskydning returneret af API'en. |
| begrænse | Pagineringsgrænse anvendt på anmodningen. |
| tælle | Antal rækker returneret i data. |
| data | Array med poster i mistede opkald. |
| data[].nummer | Opkalderens telefonnummer. |
| data[].navn | Cachelagret kontaktnavn. Kan være tomt, hvis der ikke er et tilgængeligt kontaktnavn. |
| data[].dato | Formateret opkaldsdato og -tidspunkt. |
Indgående opkald – Liste
Hent indgående besvarede opkald synkroniseret fra den mobile enhed.
Slutpunkt
Forespørgselsparametre
| Parameter | Type | Beskrivelse |
|---|---|---|
| apikey | snor | Påkrævet Din API-nøgle (valideret mod abonnement). |
| begrænse | int | Valgfri Rækker pr. side (standard: 50, maks: 200). |
| forskydning | int | Valgfri Pagineringsforskydning (standard: 0). |
| sorter_efter | snor | Valgfri Tilladt: opkaldsdato_ms opkaldsdato_tidspunkt_utc varighed_sek telefonnummer oprettet_på cachelagret_navn geoplacering |
| sorteringsmappe | stigende|nedgående | Valgfri Misligholdelse: beskrivelse. |
| dato_fra_ms | int (ms) | Valgfri Filtrer hvor opkaldsdato_ms >= dato_fra_ms. |
| dato_til_ms | int (ms) | Valgfri Filtrer hvor opkaldsdato_ms <= dato_til_ms. |
| q | snor | Valgfri Søg på telefonnummer eller cachelagret_navn (LIGESOM). |
Eksempel på anmodning
Eksempel på JSON-svar
{ "success": sand, "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": "Canada", "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": "Canada", "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": "Canada", "created_at": "2026-03-20 12:59:01" } ] }
Forklaring af svar
| Felt | Beskrivelse |
|---|---|
| succes | ægte betyder, at anmodningen blev behandlet korrekt. |
| apikey | Gentaget API-nøgleværdi. I dokumentationseksempler skal dette altid maskeres. |
| begrænse | Antal ønskede rækker pr. side. |
| forskydning | Pagineringsforskydning returneret af API'en. |
| sorter_efter | Sorteringsfelt anvendt af API'en. |
| sorteringsmappe | Sorteringsretning anvendt af API'en. |
| filtre | Objekt, der indeholder de aktive filtre, der bruges til anmodningen. |
| tælle | Antal rækker returneret i rækker. |
| rækker | Array, der indeholder indgående besvarede opkald. |
| rækker[].telefonnummer | Telefonnummer knyttet til opkaldet. |
| rækker[].cachelagret_navn | Navn på cachelagret kontaktperson. Kan være nul eller tomt afhængigt af tilgængelige data. |
| rækker[].call_date_ms | Opkaldstidsstempel i millisekunder. |
| rækker[].call_datetime_utc | UTC-dato og -tidspunkt for opkaldet. |
| rækker[].varighed_sek | Opkaldsvarighed i sekunder. |
| rækker[].geo_placering | Geografisk betegnelse knyttet til nummeret, hvis tilgængelig. |
| rækker[].oprettet_ved | Dato og klokkeslæt, hvor rækken blev indsat på serveren. |
Udgående opkald – Liste
Hent udgående opkald synkroniseret fra mobilenheden.
Slutpunkt
Forespørgselsparametre
Samme parametre og funktionsmåde som indgående opkald.
| Parameter | Type | Beskrivelse |
|---|---|---|
| apikey | snor | Påkrævet Din API-nøgle (valideret mod abonnement). |
| begrænse | int | Valgfri Rækker pr. side (standard: 50, maks: 200). |
| forskydning | int | Valgfri Pagineringsforskydning (standard: 0). |
| sorter_efter | snor | Valgfri Tilladt: opkaldsdato_ms opkaldsdato_tidspunkt_utc varighed_sek telefonnummer oprettet_på cachelagret_navn geoplacering |
| sorteringsmappe | stigende|nedgående | Valgfri Misligholdelse: beskrivelse. |
| dato_fra_ms | int (ms) | Valgfri Filtrer hvor opkaldsdato_ms >= dato_fra_ms. |
| dato_til_ms | int (ms) | Valgfri Filtrer hvor opkaldsdato_ms <= dato_til_ms. |
| q | snor | Valgfri Søg på telefonnummer eller cachelagret_navn (LIGESOM). |
Eksempel på anmodning
Eksempel på JSON-svar
{ "success": sand, "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": "Canada", "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": "Canada", "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": "Canada", "created_at": "2026-03-20 15:09:11" } ] }
Forklaring af svar
| Felt | Beskrivelse |
|---|---|
| succes | ægte betyder, at anmodningen blev behandlet korrekt. |
| apikey | Gentaget API-nøgleværdi. I dokumentationseksempler skal dette altid maskeres. |
| begrænse | Antal ønskede rækker pr. side. |
| forskydning | Pagineringsforskydning returneret af API'en. |
| sorter_efter | Sorteringsfelt anvendt af API'en. |
| sorteringsmappe | Sorteringsretning anvendt af API'en. |
| filtre | Objekt, der indeholder de aktive filtre, der bruges til anmodningen. |
| tælle | Antal rækker returneret i rækker. |
| rækker | Array indeholdende udgående opkaldsposter. |
| rækker[].telefonnummer | Telefonnummer knyttet til opkaldet. |
| rækker[].cachelagret_navn | Navn på cachelagret kontaktperson. Kan være nul eller tomt afhængigt af tilgængelige data. |
| rækker[].call_date_ms | Opkaldstidsstempel i millisekunder. |
| rækker[].call_datetime_utc | UTC-dato og -tidspunkt for opkaldet. |
| rækker[].varighed_sek | Opkaldsvarighed i sekunder. |
| rækker[].geo_placering | Geografisk betegnelse knyttet til nummeret, hvis tilgængelig. |
| rækker[].oprettet_ved | Dato og klokkeslæt, hvor rækken blev indsat på serveren. |
Felter for mistede opkald
| Felt | Type | Beskrivelse |
|---|---|---|
| succes | bool | Anmodningsstatus. |
| forskydning | int | Pagineringsforskydning returneret. |
| begrænse | int | Pagineringsgrænse returneret. |
| tælle | int | Antal rækker returneret i data. |
| data | array | Liste over ubesvarede opkald. |
| data[].nummer | snor | Opkalderens telefonnummer. |
| data[].navn | snor | Navn på kontaktperson i cachelagret tilstand (kan være tomt). |
| data[].dato | snor | Formateret dato- og klokkeslætsstreng afledt af et tidsstempel i millisekunder. |
Indgående/udgående felter
| Felt | Type | Beskrivelse |
|---|---|---|
| succes | bool | Anmodningsstatus. |
| apikey | snor | Sendes tilbage af API (din nøgle). Maskér den altid i offentlige dokumenter. |
| begrænse | int | Rækker pr. side returneret. |
| forskydning | int | Pagineringsforskydning returneret. |
| sorter_efter | snor | Anvendt sorteringsfelt. |
| sorteringsmappe | snor | Anvendt sorteringsretning. |
| filtre | objekt | Ekkofiltre (dato_fra_ms, dato_til_ms, q). |
| tælle | int | Antal rækker returneret i rækker. |
| rækker | array | Liste over opkald. |
| rækker[].telefonnummer | snor | Telefonnummer. |
| rækker[].cachelagret_navn | streng|nul | Cachelagret kontaktnavn (kan være null). |
| rækker[].call_date_ms | int | Opkaldstidsstempel i millisekunder. |
| rækker[].call_datetime_utc | snor | UTC-dato- og klokkeslætsfelt (database). |
| rækker[].varighed_sek | int | Varighed i sekunder. |
| rækker[].geo_placering | streng|nul | Geografisk placeringsetiket (kan være tom/null). |
| rækker[].oprettet_ved | snor | Tidsstempel for serverindsættelse. |
