Documentation détaillée
Généralités
Authentification
Étapes de création d'un envoi e-mail
Étapes de création d'un envoi SMS
Nouveautés
administration du compte
contacts
abonnements
consentements
groupes d'intérêts
intérêts
champs
imports - mapping
imports
variables
ciblages
lois ciblages
critères ciblages
plannings
e-mail - adresses d'expéditeurs
e-mail - adresses de réponses
e-mail - liens de messages
e-mail - messages
e-mail - envois
e-mail - envois transactionnels
sms - expéditeurs
sms - messages
sms - envois transactionnels
exports - mappings
exports - colonnes
exports - filtres
exports
statistiques
hébergement
webhooks
connexions distantes
consentements - dépréciées
Powered by Stoplight
post

/sms/sendings/search

Cette méthode renvoie l’ensemble des envois SMS correspondant aux critères de recherche spécifiés.

Dans l’objet SearchQuery les propriétés suivantes sont obligatoires :

  • SearchValue (chaîne d’au moins 1 caractère)
  • Channel (All, Email, Mobile)

Le moteur de recherche permet également de filtrer tous les envois :

  • par l’identifiant du message
  • par type (BAT = test, Classic = envoi unitaire, CTM = envoi récurrent)
  • par période de création (Datetime au format ISO 8601 - 2019-11-22T13:47:48.680Z)
  • par période d’envoi (Datetime au format ISO 8601 - 2019-11-22T13:47:48.680Z)
  • par statut d’envoi (CreationInProgress, Created, Planned, SendInProgress, Finished, PendingStandby, Standby, PendingStop, Stopped, Archived, Refused)
Dernière mise à jour : Janvier 2020

Authorization

apiKey - X-API-Key

Request Parameters

1 Query Parameter
1 Header

Request Body

1 Example
Schema
object

Sending management

SearchQuery
object

SmsSendingSearch

Responses

Message sendings retrieved.

Schema
object

DetailedList

Count
integer

Returned elements.

2 validations + required
Total
integer

Total elements (without filters).

2 validations + required
ItemList
array[object]

Items.

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
X-API-Key