API

Obtenir le journal des SMS

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

Retourne le journal des SMS. Si download=yes, les résultats sont renvoyés sous forme de fichier CSV.

Autorisation

api-token + language + role

Paramètres de requête

date_fromstring

Exemple: 29/05/2024

date_tostring

Exemple: 30/05/2024

chain_idinteger
branch_idinteger
statusstring

Valeurs:completedstarted

page_numberinteger

Exemple: 1

phone_format_idinteger

Exemple: -1

phone_numberstring

Exemple: 9999999999

operator_name_idinteger
downloadstring

Transmettez yes pour télécharger l'échantillon au format CSV

Valeurs:yes

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringpeut être nul

Exemple: 2026-08-01 00:00:00

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_toobject (FilterDateTo)
valuestringpeut être nul

Exemple: 2026-08-31 23:59:59

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_rangeobject (FilterDateRange)

Périodes prédéfinies pour le filtre de date ; la limite inférieure est calculée selon le fuseau horaire de l'utilisateur. value — période correspondant aux valeurs actuelles de *_from et *_to ; null — période personnalisée. default — période que le serveur applique à une requête sans dates : elle est également utilisée lors du premier chargement de la section et lors de la réinitialisation. La limite supérieure de la période correspond toujours au jour actuel de l'utilisateur, c'est pourquoi option ne la contient pas : il n'est pas nécessaire de transmettre *_to pour une période prédéfinie, le serveur la définit automatiquement. Une période de plus d'un an est tronquée du côté de la limite la plus récente.

valuestring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

defaultstring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

typestringobligatoire

Exemple: select

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

optionarray of objectobligatoire
valuestring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

date_fromstringobligatoire

Exemple: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

statusobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

phone_numberobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

operator_name_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

downloadobject (FilterButtonDownloadCsv)

Bouton de téléchargement de la sélection : lors du clic, transmettez download=yes

valuestring

Exemple: Download

typestringobligatoire

Exemple: button_download_csv

listarray of object
idintegerobligatoire

Exemple: 1

datestring (DataTimeFormat) obligatoire

Exemple: 17:45 06/05/2024

phone_format_idinteger

Exemple: 1

phone_numberstring

Exemple: 9999999999

textstringobligatoire

Exemple: Your account has been blocked

statusstringobligatoire

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

Exemple: wrong_api_fields

phone_operator_namestring

Exemple: example

service_namestring

Exemple: SMSRU

city_namestring

Exemple: Kaliningrad

branch_namestring

Exemple: Don't touch | IikoDelivery

chain_namestring

Exemple: Green Basket | Kaliningrad

paginationobject (Pagination)
max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false