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.
Brug for hjælp? api@smsmobileapi.com
Hurtigstart
Basis-URL
FÅ https://api.smsmobileapi.com
Alle nedenstående slutpunkter er dokumenteret som FÅ anmodninger. Erstat DIN_API_NØGLE med din rigtige nøgle (del den ikke offentligt).
Eksempler
HENT https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY
HENT https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
HENT https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=3247&date_from_ms=1700000000000&date_to_ms=1700864000000
Autentificering
Opkaldsstyringsslutpunkter godkendes ved hjælp af apikey forespørgselsparameter.
Validering af abonnement: Indgående/udgående slutpunkter validerer din API-nøgle og kontrollerer gyldigheden af dit abonnement (datoGrænse >= CUREDATE()Hvis den er udløbet, modtager du api_udløbet.
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
FÅ https://api.smsmobileapi.com/call/missed/list/
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). |
Indgående opkald – Liste
Hent indgående besvarede opkald synkroniseret fra den mobile enhed.
Slutpunkt
FÅ https://api.smsmobileapi.com/call/incoming/list/
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). |
Udgående opkald – Liste
Hent udgående opkald synkroniseret fra mobilenheden.
Slutpunkt
FÅ https://api.smsmobileapi.com/call/outgoing/list/
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). |
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). |
| 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. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian