API-documentatie voor gespreksbeheer
Met deze eindpunten kunt u uw gegevens ophalen. Gemiste oproepen, Inkomende beantwoordde oproepen, En Uitgaande gesprekken Gesynchroniseerd vanuit de SMSMobileAPI mobiele app naar uw dashboard + API.
Belangrijk: als de mobiele app op de achtergrond draait, kan het telefoonsysteem een vertraging (vaak tot wel 10 minuten) tussen synchronisaties veroorzaken. Je kunt de app altijd openen om handmatig te synchroniseren als dat nodig is.
Snelstart
Basis-URL
Voorbeelden
Authenticatie
Eindpunten voor gespreksbeheer authenticeren zich met behulp van de apikey queryparameter.
Gemeenschappelijke concepten
Paginering
Gebruik beperken En verschuiving om de resultaten te pagineren.
Tijdstempels
- oproepdatum_ms is een UNIX-tijdstempel in milliseconden.
- call_datetime_utc wordt opgeslagen als een UTC-datum/tijd-string (databaseveld).
- Voor gemiste oproepen retourneert de API een geformatteerd bericht. datum tekenreeks (afgeleid van een millisecondenwaarde).
Zoekopdracht
- Gemiste oproepen: zoekopdracht komt overeen met het nummer of de naam.
- Inkomend/Uitgaand: Q wedstrijden telefoonnummer of cached_name.
Sorteren (alleen inkomend/uitgaand)
Sortering wordt aangestuurd door sorteren_op + sorteer_map (Alleen velden op de whitelist). Gemiste oproepen worden altijd gesorteerd op meest recente.
Fouten
| HTTP | Voorbeeldfout | Betekenis |
|---|---|---|
| 400 | {"success":false,"errormissing_apikey"} | Ontbreekt of is leeg apikey. |
| 403 | {"success":false,"error:invalid_apikey"} | API-sleutel niet gevonden/niet herkend. |
| 403 | {"success":false,"error:api_expired"} | Je abonnement is verlopen (datumlimiet (voor vandaag). |
| 500 | {"success":false,"errorserver_errordetail..."} | Serverfout (database, SQL, uitzondering). |
Opmerking: het eindpunt voor gemiste oproepen kan ook berichten retourneren zoals API-sleutel ontbreekt of SQL-voorbereidingsfouten, afhankelijk van de situatie.
Gemiste oproepen - Lijst
Gemiste oproepen ophalen die vanaf het mobiele apparaat zijn gesynchroniseerd.
Eindpunt
Queryparameters
| Parameter | Type | Beschrijving |
|---|---|---|
| apikey | snaar | Vereist Je API-sleutel is gekoppeld aan de mobiele telefoon. |
| verschuiving | int | Optioneel Paginatie-offset (standaard: 0). |
| beperken | int | Optioneel Maximaal aantal rijen (standaard: 100, max: 500). |
| zoekopdracht | snaar | Optioneel Zoeken op nummer of naam (SQL LIKE). |
| datum_start | JJJJ-MM-DD | Optioneel Filteren vanaf deze dag (00:00:00). |
| datum_einde | JJJJ-MM-DD | Optioneel Filter tot en met vandaag (23:59:59). |
Inkomende oproepen – Lijst
Ontvang inkomende, beantwoordde oproepen die vanaf het mobiele apparaat zijn gesynchroniseerd.
Eindpunt
Queryparameters
| Parameter | Type | Beschrijving |
|---|---|---|
| apikey | snaar | Vereist Uw API-sleutel (gevalideerd aan de hand van uw abonnement). |
| beperken | int | Optioneel Rijen per pagina (standaard: 50, max: 200). |
| verschuiving | int | Optioneel Paginatie-offset (standaard: 0). |
| sorteren_op | snaar | Optioneel Toegestaan: oproepdatum_ms call_datetime_utc duur_sec telefoonnummer gemaakt_op cached_name geo_location |
| sorteer_map | oplopend|aflopend | Optioneel Standaard: beschrijving. |
| datum_van_ms | int (ms) | Optioneel Filter waar call_date_ms >= date_from_ms. |
| datum_naar_ms | int (ms) | Optioneel Filter waar call_date_ms <= date_to_ms. |
| Q | snaar | Optioneel Zoeken op telefoonnummer of cached_name (LEUK VINDEN). |
Uitgaande oproepen – Lijst
Uitgaande oproepen ophalen die vanaf het mobiele apparaat zijn gesynchroniseerd.
Eindpunt
Queryparameters
Dezelfde parameters en hetzelfde gedrag als inkomende oproepen.
| Parameter | Type | Beschrijving |
|---|---|---|
| apikey | snaar | Vereist Uw API-sleutel (gevalideerd aan de hand van uw abonnement). |
| beperken | int | Optioneel Rijen per pagina (standaard: 50, max: 200). |
| verschuiving | int | Optioneel Paginatie-offset (standaard: 0). |
| sorteren_op | snaar | Optioneel Toegestaan: oproepdatum_ms call_datetime_utc duur_sec telefoonnummer gemaakt_op cached_name geo_location |
| sorteer_map | oplopend|aflopend | Optioneel Standaard: beschrijving. |
| datum_van_ms | int (ms) | Optioneel Filter waar call_date_ms >= date_from_ms. |
| datum_naar_ms | int (ms) | Optioneel Filter waar call_date_ms <= date_to_ms. |
| Q | snaar | Optioneel Zoeken op telefoonnummer of cached_name (LEUK VINDEN). |
Gemiste oproepvelden
| Veld | Type | Beschrijving |
|---|---|---|
| succes | bool | Status van het verzoek. |
| verschuiving | int | De geretourneerde pagineringsoffset. |
| beperken | int | De pagineringslimiet is geretourneerd. |
| graaf | int | Aantal geretourneerde rijen in gegevens. |
| gegevens | array | Lijst met gemiste oproepen. |
| data[].nummer | snaar | Telefoonnummer van de beller. |
| data[].name | snaar | Opgeslagen contactnaam (kan leeg zijn). |
| data[].date | snaar | Geformatteerde datum- en tijdstring, afgeleid van een tijdstempel in milliseconden. |
Inkomende/uitgaande velden
| Veld | Type | Beschrijving |
|---|---|---|
| succes | bool | Status van het verzoek. |
| apikey | snaar | Teruggezonden door de API (uw sleutel). |
| beperken | int | Aantal rijen per pagina. |
| verschuiving | int | De geretourneerde pagineringsoffset. |
| sorteren_op | snaar | Toegepast sorteerveld. |
| sorteer_map | snaar | Toegepaste sorteerrichting. |
| filters | voorwerp | Weerkaatste filters (datum_van_ms, datum_naar_ms, Q). |
| graaf | int | Aantal geretourneerde rijen in rijen. |
| rijen | array | Lijst met oproepen. |
| rijen[].telefoonnummer | snaar | Telefoonnummer. |
| rijen[].cached_name | string|null | Opgeslagen contactnaam (kan null zijn). |
| rijen[].oproepdatum_ms | int | Tijdstempel van het gesprek in milliseconden. |
| rijen[].call_datetime_utc | snaar | UTC-datum/tijdveld (database). |
| rijen[].duur_sec | int | Duur in seconden. |
| rijen[].geo_locatie | string|null | Label voor geografische locatie (kan null/leeg zijn). |
| rijen[].gemaakt_op | snaar | Tijdstempel van invoeging op de server. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian