Passer au contenu

Query SMS batches (HTTP QUERY method)

Requête

Lists SMS batches owned by the caller (or the caller's site), with cursor pagination.

This endpoint uses the HTTP QUERY method, not GET. OpenAPI cannot express the QUERY method, so it is shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch).

Sécurité
basicAuth
Requête
StatesArray of strings
Items Enum:"Draft""Submitted""Scheduled""Processing""Processed""Invalid""Failed"
Cursorstring
Limitinteger, [ 1 .. 100 ]obligatoire
SortBystring
Par défaut:"LastUpdated"
Enum:"None""LastUpdated""ScheduledFor""StartedOn"
SortOrderstring
Par défaut:"Ascending"
Enum:"None""Ascending""Descending"
Directionstring
Par défaut:"Forward"
Enum:"None""Forward""Backward"
TextSearchstring
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviSms/Batches?States=Draft&Cursor=string&Limit=1&SortBy=None&SortOrder=None&Direction=None&TextSearch=string'

Réponses

Query executed successfully.

Corpsapplication/json
Cursorstring
HasMoreResultsboolean
ResultsArray of objects(EviSmsBatchSummary)
Réponse
{ "Cursor": "string", "HasMoreResults": true, "Results": [ { … } ] }