API

Get SMS log

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

Returns the SMS log. If download=yes, the data is returned as a CSV file.

Authorization

api-token + language + role

Query parameters

date_fromstring

Example: 29/05/2024

date_tostring

Example: 30/05/2024

chain_idinteger
branch_idinteger
statusstring

Values:completedstarted

page_numberinteger

Example: 1

phone_format_idinteger

Example: -1

phone_numberstring

Example: 9999999999

operator_name_idinteger
downloadstring

Pass yes to download the selection as a CSV file

Values:yes

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringcan be null

Example: 2026-08-01 00:00:00

typestringrequired

Example: date

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

date_toobject (FilterDateTo)
valuestringcan be null

Example: 2026-08-31 23:59:59

typestringrequired

Example: date

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

date_rangeobject (FilterDateRange)

Predefined date filter ranges; the lower boundary is calculated in the user's timezone. value is the range corresponding to the current *_from and *_to; null means a custom range. default is the range the server uses when a request has no dates: it is also applied on the first section load and when resetting. The upper boundary of the range always matches the user's current day, so option does not include it: you do not need to send *_to for a predefined range, the server sets it automatically. Ranges longer than one year are trimmed from the most recent boundary.

valuestring (DateRange) can be null

Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.

Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Example: today

defaultstring (DateRange) required

Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.

Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Example: today

typestringrequired

Example: select

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

optionarray of objectrequired
valuestring (DateRange) required

Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.

Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Example: today

date_fromstringrequired

Example: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

statusobject (FilterEnum)

Filter enumeration — a flat list of enumeration values

valuestring

Example: example

typestringrequired

Example: select

optionarray of string
modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

phone_numberobject (FilterInput)
valuestring

Example: example

typestringrequired

Example: integer or string

placeholderstring

Example: string

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

operator_name_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

downloadobject (FilterButtonDownloadCsv)

Download selection button: on click, pass download=yes

valuestring

Example: Download

typestringrequired

Example: button_download_csv

listarray of object
idintegerrequired

Example: 1

datestring (DataTimeFormat) required

Example: 17:45 06/05/2024

phone_format_idinteger

Example: 1

phone_numberstring

Example: 9999999999

textstringrequired

Example: Your account has been blocked

statusstringrequired

Values: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

Example: wrong_api_fields

phone_operator_namestring

Example: example

service_namestring

Example: SMSRU

city_namestring

Example: Kaliningrad

branch_namestring

Example: Don't touch | IikoDelivery

chain_namestring

Example: Green Basket | Kaliningrad

paginationobject (Pagination)
max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false