Τεκμηρίωση API διαχείρισης κλήσεων
Αυτά τα τελικά σημεία σάς επιτρέπουν να ανακτήσετε τα δεδομένα σας Αναπάντητες κλήσεις, Εισερχόμενες Απαντημένες Κλήσεις, και Εξερχόμενες κλήσεις συγχρονισμένο από την εφαρμογή SMSMobileAPI για κινητά στον πίνακα ελέγχου + το API σας.
Σημαντικό: εάν η εφαρμογή για κινητά εκτελείται στο παρασκήνιο, το τηλεφωνικό σύστημα ενδέχεται να επιβάλει καθυστέρηση (συχνά έως και ~10 λεπτά) μεταξύ των συγχρονισμών. Μπορείτε πάντα να ανοίξετε την εφαρμογή για να συγχρονίσετε χειροκίνητα, εάν χρειάζεται.
Γρήγορη εκκίνηση
Βασική διεύθυνση URL
Παραδείγματα
Πιστοποίηση
Τα τελικά σημεία διαχείρισης κλήσεων ελέγχουν τον έλεγχο ταυτότητας χρησιμοποιώντας το apikey παράμετρος ερωτήματος.
Κοινές έννοιες
Σελιδοποίηση
Χρήση όριο και όφσετ για την σελιδοποίηση των αποτελεσμάτων.
Χρονικές σημάνσεις
- call_date_ms είναι μια χρονική σήμανση UNIX στο χιλιοστά του δευτερολέπτου.
- ημερομηνία_κλήσης_ώρα_utc αποθηκεύεται ως συμβολοσειρά ημερομηνίας/ώρας UTC (πεδίο βάσης δεδομένων).
- Για τις αναπάντητες κλήσεις, το API επιστρέφει μια μορφοποιημένη ημερομηνία συμβολοσειρά (που προκύπτει από μια τιμή χιλιοστών του δευτερολέπτου).
Ερευνα
- Αναπάντητες κλήσεις: έρευνα ταιριάζει με τον αριθμό ή το όνομα.
- Εισερχόμενες/Εξερχόμενες: q αγώνες αριθμός_τηλεφώνου ή προσωρινά αποθηκευμένο_όνομα.
Ταξινόμηση (Μόνο εισερχόμενες/εξερχόμενες)
Η ταξινόμηση ελέγχεται από ταξινόμηση_κατά + ταξινόμηση_κατάλογος (μόνο πεδία στη λίστα επιτρεπόμενων). Οι αναπάντητες κλήσεις ταξινομούνται πάντα με βάση τις νεότερες.
Σφάλματα
| HTTP | Παράδειγμα σφάλματος | Εννοια |
|---|---|---|
| 400 | {"επιτυχία":false,"σφάλμα":"missing_apikey"} | Λείπει ή είναι κενό apikey. |
| 403 | {"επιτυχία":false,"σφάλμα":"invalid_apikey"} | Το κλειδί API δεν βρέθηκε / δεν αναγνωρίστηκε. |
| 403 | {"επιτυχία":false,"σφάλμα":"api_expired"} | Η συνδρομή σας έχει λήξει (Όριο ημερομηνίας είναι πριν από σήμερα). |
| 500 | {"επιτυχία":false,"σφάλμα":"σφάλμα_διακομιστή","λεπτομέρεια":"..."} | Σφάλμα διακομιστή (βάση δεδομένων, SQL, εξαίρεση). |
Σημείωση: το τελικό σημείο Αναπάντητων Κλήσεων μπορεί επίσης να επιστρέψει μηνύματα όπως Λείπει το apikey ή σφάλματα προετοιμασίας SQL ανάλογα με την περίπτωση.
Αναπάντητες κλήσεις – Λίστα
Ανάκτηση αναπάντητων κλήσεων που έχουν συγχρονιστεί από την κινητή συσκευή.
Τελικό σημείο
Παράμετροι ερωτήματος
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
| apikey | σειρά | Υποχρεούμαι Το κλειδί API σας συνδέεται με το κινητό τηλέφωνο. |
| όφσετ | εσωτ. | Προαιρετικός Μετατόπιση σελιδοποίησης (προεπιλογή: 0). |
| όριο | εσωτ. | Προαιρετικός Μέγιστος αριθμός γραμμών (προεπιλογή: 100, μέγ.: 500). |
| έρευνα | σειρά | Προαιρετικός Αναζήτηση με αριθμό ή όνομα (SQL LIKE). |
| ημερομηνία_έναρξης | ΕΕΕΕ-ΜΜ-ΗΗ | Προαιρετικός Φιλτράρισμα από αυτήν την ημέρα (00:00:00). |
| ημερομηνία_τέλους | ΕΕΕΕ-ΜΜ-ΗΗ | Προαιρετικός Φιλτράρισμα έως και σήμερα (23:59:59). |
Εισερχόμενες κλήσεις – Λίστα
Ανάκτηση εισερχόμενων απαντημένων κλήσεων που έχουν συγχρονιστεί από την κινητή συσκευή.
Τελικό σημείο
Παράμετροι ερωτήματος
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
| apikey | σειρά | Υποχρεούμαι Το κλειδί API σας (επικυρωμένο με συνδρομή). |
| όριο | εσωτ. | Προαιρετικός Γραμμές ανά σελίδα (προεπιλογή: 50, μέγ.: 200). |
| όφσετ | εσωτ. | Προαιρετικός Μετατόπιση σελιδοποίησης (προεπιλογή: 0). |
| ταξινόμηση_κατά | σειρά | Προαιρετικός Επιτρέπονται: call_date_ms ημερομηνία_κλήσης_ώρα_utc διάρκεια_δευτερόλεπτο αριθμός_τηλεφώνου δημιουργήθηκε_στις προσωρινά αποθηκευμένο_όνομα γεωγραφική_τοποθεσία |
| ταξινόμηση_κατάλογος | αύξουσα|περιστροφή | Προαιρετικός Αθέτηση: περιγραφή. |
| ημερομηνία_από_ms | ακέραιος αριθμός (ms) | Προαιρετικός Φιλτράρισμα πού call_date_ms >= date_from_ms. |
| ημερομηνία_έως_ms | ακέραιος αριθμός (ms) | Προαιρετικός Φιλτράρισμα πού call_date_ms <= date_to_ms. |
| q | σειρά | Προαιρετικός Αναζήτηση σε αριθμός_τηλεφώνου ή προσωρινά αποθηκευμένο_όνομα (ΣΑΝ). |
Εξερχόμενες κλήσεις – Λίστα
Ανάκτηση εξερχόμενων κλήσεων που έχουν συγχρονιστεί από την κινητή συσκευή.
Τελικό σημείο
Παράμετροι ερωτήματος
Ίδιες παράμετροι και συμπεριφορά όπως και στις εισερχόμενες κλήσεις.
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
| apikey | σειρά | Υποχρεούμαι Το κλειδί API σας (επικυρωμένο με συνδρομή). |
| όριο | εσωτ. | Προαιρετικός Γραμμές ανά σελίδα (προεπιλογή: 50, μέγ.: 200). |
| όφσετ | εσωτ. | Προαιρετικός Μετατόπιση σελιδοποίησης (προεπιλογή: 0). |
| ταξινόμηση_κατά | σειρά | Προαιρετικός Επιτρέπονται: call_date_ms ημερομηνία_κλήσης_ώρα_utc διάρκεια_δευτερόλεπτο αριθμός_τηλεφώνου δημιουργήθηκε_στις προσωρινά αποθηκευμένο_όνομα γεωγραφική_τοποθεσία |
| ταξινόμηση_κατάλογος | αύξουσα|περιστροφή | Προαιρετικός Αθέτηση: περιγραφή. |
| ημερομηνία_από_ms | ακέραιος αριθμός (ms) | Προαιρετικός Φιλτράρισμα πού call_date_ms >= date_from_ms. |
| ημερομηνία_έως_ms | ακέραιος αριθμός (ms) | Προαιρετικός Φιλτράρισμα πού call_date_ms <= date_to_ms. |
| q | σειρά | Προαιρετικός Αναζήτηση σε αριθμός_τηλεφώνου ή προσωρινά αποθηκευμένο_όνομα (ΣΑΝ). |
Πεδία αναπάντητων κλήσεων
| Πεδίο | Τύπος | Περιγραφή |
|---|---|---|
| επιτυχία | βουλ | Κατάσταση αιτήματος. |
| όφσετ | εσωτ. | Επιστράφηκε μετατόπιση σελιδοποίησης. |
| όριο | εσωτ. | Επιστράφηκε όριο σελιδοποίησης. |
| κόμης | εσωτ. | Αριθμός γραμμών που επιστράφηκαν σε δεδομένα. |
| δεδομένα | παράταξη | Λίστα αναπάντητων κλήσεων. |
| δεδομένα[].αριθμός | σειρά | Αριθμός τηλεφώνου καλούντος. |
| δεδομένα[].όνομα | σειρά | Όνομα επαφής που έχει αποθηκευτεί στην προσωρινή μνήμη (μπορεί να είναι κενό). |
| δεδομένα[].ημερομηνία | σειρά | Μορφοποιημένη συμβολοσειρά ημερομηνίας/ώρας που προέρχεται από χρονική σήμανση χιλιοστών του δευτερολέπτου. |
Πεδία εισερχόμενων/εξερχόμενων
| Πεδίο | Τύπος | Περιγραφή |
|---|---|---|
| επιτυχία | βουλ | Κατάσταση αιτήματος. |
| apikey | σειρά | Επαναλαμβάνεται από το API (το κλειδί σας). |
| όριο | εσωτ. | Επιστρεφόμενες γραμμές ανά σελίδα. |
| όφσετ | εσωτ. | Επιστράφηκε μετατόπιση σελιδοποίησης. |
| ταξινόμηση_κατά | σειρά | Εφαρμόστηκε πεδίο ταξινόμησης. |
| ταξινόμηση_κατάλογος | σειρά | Εφαρμόστηκε η κατεύθυνση ταξινόμησης. |
| φίλτρα | αντικείμενο | Φίλτρα με ηχώ (ημερομηνία_από_ms, ημερομηνία_έως_ms, q). |
| κόμης | εσωτ. | Αριθμός γραμμών που επιστράφηκαν σε σειρές. |
| σειρές | παράταξη | Λίστα κλήσεων. |
| γραμμές[].αριθμός_τηλεφώνου | σειρά | Αριθμός τηλεφώνου. |
| γραμμές[].cached_name | συμβολοσειρά|null | Όνομα επαφής που έχει αποθηκευτεί στην προσωρινή μνήμη (μπορεί να είναι null). |
| γραμμές[].call_date_ms | εσωτ. | Χρονική σήμανση κλήσης σε χιλιοστά του δευτερολέπτου. |
| γραμμές[].call_datetime_utc | σειρά | Πεδίο ημερομηνίας/ώρας UTC (βάση δεδομένων). |
| γραμμές[].διάρκεια_δευτ. | εσωτ. | Διάρκεια σε δευτερόλεπτα. |
| γραμμές[].geo_location | συμβολοσειρά|null | Ετικέτα γεωγραφικής τοποθεσίας (μπορεί να είναι κενή/μηδενική). |
| γραμμές[].created_at | σειρά | Χρονική σήμανση εισαγωγής διακομιστή. |
