Read Message Statistics

Pobranie systemowych wiadomości

GET /message

Query Parameters

Możliwe parametry w URL:

Parametr	Domyślnie	Przykład	Opis
limit	100	100	Limit pobranych rekordów, maksymalna wartość to 100
offset	0	50	Od którego rekordu
from_id	NULL	608bdd875141c0758ca83971	Identyfikator, od którego szukamy kolejnych konwersacji
before_id	NULL	608bdd875141c0758ca83971	Identyfikator, od którego szukamy poprzednich konwersacji
filter	NULL	[{"property": "date", "operator": "gt", "value": "2021-12-05 14:00:00"}]	Filtrowanie po parametrach, kazdy obiekt musi posiadać kluczproperty i value. Możliwy parametr "operator"

Dostępne parametry dla filter:

• project_id_list <LIST<INTEGER>>
• tenant_user_id_list <LIST<INTEGER>>
• date <STRING> — Data w UTC w formacie YYYY-MM-DD HH:mm:ss, dostępny parametr operator który przyjmuje wartości:
  • gte — więcej lub równo
  • gt — więcej niż
  • lte — mniej lub równo
  • lt — mniej niż
• system_date <STRING> — Data w UTC w formacie YYYY-MM-DD HH:mm:ss, dostępny parametr operator który przyjmuje wartości:
  • gte — więcej lub równo
  • gt — więcej niż
  • lte — mniej lub równo
  • lt — mniej niż
• message_type_list <LIST<STRING>> — Listę dostępnych wartości znajdziesz w Message
• channel_identifier <STRING> — Identyfikator kanału używanego przez system
• peer_identifier <STRING> — Identyfikator klienta
• direction <STRING> — Kierunek wiadomości; listę dostępnych wartości znajdziesz w Message

Parametr filter musi być listą obiektów przekształconą w ciąg JSON zakodowany w UTF-8.

Przykład przekształcenia:

encodeURI(JSON.stringify([{"property": "date", "operator": "gt", "value": "2021-12-05 14:00:00"}]))

Przekształcona wartość:

%5B%7B%22property%22:%22date%22,%22operator%22:%22gt%22,%22value%22:2021-12-05 14:00:00%7D%5D

Response file

{
    "data": <LIST<Message>>
}

Nazwa	Rodzaj	Opis	Zasób
data	<LIST<Message>>	Lista obiektów	Message

Response Code

Status	Opis
200	Rekordy zostały pobrane pomyślnie

Example

CURLPYTHONPHP

curl -X GET \
$CONPEEK_URL/message \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json'

import requests
import os
from urllib import parse

url = parse.urljoin(os.environ["CONPEEK_URL"], "/message")

headers = {
    'Content-Type': "application/json",
    'Authorization': os.environ["CONPEEK_KEY"]
}

response = requests.request("GET", url, headers=headers)
print(response.text)

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/message",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: ".getenv("CONPEEK_KEY"),
        "Content-Type: application/json"
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}