API

Pobierz dziennik SMS

GET/api/crm/v2/log_smsv2
operationId: logSms.default

Zwraca dziennik SMS. Gdy download=yes, wynik jest zwracany jako plik CSV.

Autoryzacja

api-token + language + role

Parametry zapytania

date_fromstring

Przykład: 29/05/2024

date_tostring

Przykład: 30/05/2024

chain_idinteger
branch_idinteger
statusstring

Wartości:completedstarted

page_numberinteger

Przykład: 1

phone_format_idinteger

Przykład: -1

phone_numberstring

Przykład: 9999999999

operator_name_idinteger
downloadstring

Przekaż yes, aby pobrać dane jako plik CSV

Wartości:yes

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_toobject (FilterDateTo)
valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_rangeobject (FilterDateRange)

Gotowe okresy filtrowania według daty; dolna granica jest obliczana w strefie czasowej użytkownika. value — okres, któremu odpowiadają bieżące *_from i *_to; null — dowolny okres. default — okres, który serwer ustawia w zapytaniu bez dat: jest stosowany przy pierwszym ładowaniu sekcji oraz po resecie. Górna granica okresu zawsze odpowiada bieżącemu dniu użytkownika, dlatego option jej nie zawiera: nie trzeba przekazywać *_to dla gotowego okresu, serwer ustawia ją samodzielnie. Okres dłuższy niż rok jest obcinany od najnowszej granicy.

valuestring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

defaultstring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

typestringwymagane

Przykład: select

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

optionarray of objectwymagane
valuestring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

date_fromstringwymagane

Przykład: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

statusobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string
modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

phone_numberobject (FilterInput)
valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

operator_name_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

downloadobject (FilterButtonDownloadCsv)

Przycisk pobierania wyników: po kliknięciu przekaż download=yes

valuestring

Przykład: Download

typestringwymagane

Przykład: button_download_csv

listarray of object
idintegerwymagane

Przykład: 1

datestring (DataTimeFormat) wymagane

Przykład: 17:45 06/05/2024

phone_format_idinteger

Przykład: 1

phone_numberstring

Przykład: 9999999999

textstringwymagane

Przykład: Your account has been blocked

statusstringwymagane

Wartości:errorsuccessempty_fieldswrong_phonewrong_api_fieldsserver_not_availablenot_enough_moneywaitingneed_phoneoperators_not_connected_to_botsunsupported_sms_serviceapi_disabledwrong_sender_namein_worksending_via_botssend_via_bots_failedsent_via_telegramsent_via_botssent_via_max

Przykład: wrong_api_fields

phone_operator_namestring

Przykład: example

service_namestring

Przykład: SMSRU

city_namestring

Przykład: Kaliningrad

branch_namestring

Przykład: Don't touch | IikoDelivery

chain_namestring

Przykład: Green Basket | Kaliningrad

paginationobject (Pagination)
max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false