API

Hangi SMS logi

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

Tagastab SMS-i logi. Kui download=yes, tagastatakse valik CSV-failina.

Autoriseerimine

api-token + language + role

Päringu parameetrid

date_fromstring

Näide: 29/05/2024

date_tostring

Näide: 30/05/2024

chain_idinteger
branch_idinteger
statusstring

Väärtused:completedstarted

page_numberinteger

Näide: 1

phone_format_idinteger

Näide: -1

phone_numberstring

Näide: 9999999999

operator_name_idinteger
downloadstring

Edastage yes, et laadida valim alla CSV-failina

Väärtused:yes

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_toobject (FilterDateTo)
valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_rangeobject (FilterDateRange)

Valmis kuupäevafiltri perioodid; alumine piir arvutatakse kasutaja ajavööndi järgi. value — periood, millele vastavad praegused *_from ja *_to; null — suvaline periood. default — periood, mille server lisab päringusse ilma kuupäevadeta: seda kasutatakse ka jaotise esmasel laadimisel ning lähtestamisel. Perioodi ülemine piir on alati kasutaja tänane päev, seetõttu option seda ei sisalda: valmisperioodi puhul pole vaja *_to edastada, server määrab selle ise. Üle aasta pikkune periood kärbitakse uuema piiri poolt.

valuestring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

defaultstring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

typestringkohustuslik

Näide: select

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

optionarray of objectkohustuslik
valuestring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

date_fromstringkohustuslik

Näide: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string
modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

phone_numberobject (FilterInput)
valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

operator_name_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

downloadobject (FilterButtonDownloadCsv)

Allalaadimisnupp: vajutamisel edastage download=yes

valuestring

Näide: Download

typestringkohustuslik

Näide: button_download_csv

listarray of object
idintegerkohustuslik

Näide: 1

datestring (DataTimeFormat) kohustuslik

Näide: 17:45 06/05/2024

phone_format_idinteger

Näide: 1

phone_numberstring

Näide: 9999999999

textstringkohustuslik

Näide: Your account has been blocked

statusstringkohustuslik

Väärtused: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

Näide: wrong_api_fields

phone_operator_namestring

Näide: example

service_namestring

Näide: SMSRU

city_namestring

Näide: Kaliningrad

branch_namestring

Näide: Don't touch | IikoDelivery

chain_namestring

Näide: Green Basket | Kaliningrad

paginationobject (Pagination)
max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false