API

Iegūt SMS žurnālu

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

Atgriež SMS žurnālu. Ja download=yes, atlase tiek atgriezta kā CSV fails.

Autorizācija

api-token + language + role

Vaicājuma parametri

date_fromstring

Piemērs: 29/05/2024

date_tostring

Piemērs: 30/05/2024

chain_idinteger
branch_idinteger
statusstring

Vērtības:completedstarted

page_numberinteger

Piemērs: 1

phone_format_idinteger

Piemērs: -1

phone_numberstring

Piemērs: 9999999999

operator_name_idinteger
downloadstring

Norādiet yes, lai lejupielādētu atlasi kā CSV failu

Vērtības:yes

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_rangeobject (FilterDateRange)

Gatavi datuma filtra periodi; apakšējā robeža tiek aprēķināta lietotāja laika joslā. value — periods, kuram atbilst pašreizējie *_from un *_to; null — patvaļīgs periods. default — periods, kuru serveris izmanto pieprasījumā bez datumiem: tas tiek piemērots arī sadaļas pirmajā ielādē un pie atiestatīšanas. Perioda augšējā robeža vienmēr ir vienāda ar lietotāja pašreizējo dienu, tāpēc option to nesatur: gatavam periodam nav jānosūta *_to, serveris to iestata pats. Periods, kas ir garāks par gadu, tiek apgriezts no svaigākās robežas puses.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

optionarray of objectobligāts
valuestring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

phone_numberobject (FilterInput)
valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: string

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

operator_name_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

downloadobject (FilterButtonDownloadCsv)

Lejupielādes poga: nospiežot, pārsūtiet download=yes

valuestring

Piemērs: Download

typestringobligāts

Piemērs: button_download_csv

listarray of object
idintegerobligāts

Piemērs: 1

datestring (DataTimeFormat) obligāts

Piemērs: 17:45 06/05/2024

phone_format_idinteger

Piemērs: 1

phone_numberstring

Piemērs: 9999999999

textstringobligāts

Piemērs: Your account has been blocked

statusstringobligāts

Vērtības: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

Piemērs: wrong_api_fields

phone_operator_namestring

Piemērs: example

service_namestring

Piemērs: SMSRU

city_namestring

Piemērs: Kaliningrad

branch_namestring

Piemērs: Don't touch | IikoDelivery

chain_namestring

Piemērs: Green Basket | Kaliningrad

paginationobject (Pagination)
max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false