API

Obter o log de SMS

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

Retorna o registro de SMS. Quando download=yes, a seleção é retornada como um arquivo CSV.

Autorização

api-token + language + role

Parâmetros de consulta

date_fromstring

Exemplo: 29/05/2024

date_tostring

Exemplo: 30/05/2024

chain_idinteger
branch_idinteger
statusstring

Valores:completedstarted

page_numberinteger

Exemplo: 1

phone_format_idinteger

Exemplo: -1

phone_numberstring

Exemplo: 9999999999

operator_name_idinteger
downloadstring

Envie yes para baixar a seleção como um arquivo CSV

Valores:yes

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_toobject (FilterDateTo)
valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_rangeobject (FilterDateRange)

Períodos prontos para filtro de data; o limite inferior é calculado no fuso horário do usuário. value — período correspondente aos atuais *_from e *_to; null — período personalizado. default — período que o servidor insere na requisição sem datas: também é aplicado no primeiro carregamento da seção e ao redefinir o filtro. O limite superior do período é sempre igual ao dia atual do usuário, por isso option não o inclui: não é necessário enviar *_to para um período pronto, o servidor define automaticamente. Períodos com duração superior a um ano são cortados no limite mais recente.

valuestring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

defaultstring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

typestringobrigatório

Exemplo: select

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

optionarray of objectobrigatório
valuestring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

date_fromstringobrigatório

Exemplo: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string
modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

phone_numberobject (FilterInput)
valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

operator_name_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botão de download da seleção: ao clicar, envie download=yes

valuestring

Exemplo: Download

typestringobrigatório

Exemplo: button_download_csv

listarray of object
idintegerobrigatório

Exemplo: 1

datestring (DataTimeFormat) obrigatório

Exemplo: 17:45 06/05/2024

phone_format_idinteger

Exemplo: 1

phone_numberstring

Exemplo: 9999999999

textstringobrigatório

Exemplo: Your account has been blocked

statusstringobrigatório

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

Exemplo: wrong_api_fields

phone_operator_namestring

Exemplo: example

service_namestring

Exemplo: SMSRU

city_namestring

Exemplo: Kaliningrad

branch_namestring

Exemplo: Don't touch | IikoDelivery

chain_namestring

Exemplo: Green Basket | Kaliningrad

paginationobject (Pagination)
max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false