Skip to content

Query certified SMS messages (GET)

Request

Security
basicAuth
Query
WithUniqueIdsstring
WithLookupKeysstring
WithLinkedIdstring, (uuid)

Filter by linked ID. Leave affidavit and attachment data disabled. The legacy implementation uses deployment settings for omitted blob flags, with both defaults declared enabled. On legacy deployments, explicitly send IncludeAffidavitBlobs=false and IncludeAttachmentBlobs=false. The attachment flag applies only to legacy Query.

OnStatestring

Filters results by the current EviSMS state. Replied is not part of the current public EviSMS lifecycle.

Enum:"Draft""New""Ready""Sent""Dispatched""Delivered""Read""Closed""Failed"
WithOutcomestring
Enum:"None""Certified""Sent""Delivered""Read""Accepted""Rejected""Failed"
OrderResultsBystring
Value:"CreationDate"
Limitinteger, [ 1 .. 100 ]

Default and maximum are 100 for messages alone, 25 with affidavit metadata, and 1 with affidavit blobs.

Offsetinteger
IncludeAffidavitsboolean

Include affidavit entries. Set IncludeAffidavitBlobs to false for metadata-only results.

IncludeAffidavitBlobsbooleandeprecated

When true with IncludeAffidavits, returns Base64 PDFs and limits the query to one message. ASP.NET defaults to false. Legacy uses a deployment setting whose declared default is true. Set false explicitly for metadata-only results and use /AffidavitsDownload for PDFs.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v1/EviSms/Query?WithUniqueIds=string&WithLookupKeys=string&WithLinkedId=497f6eca-6276-4993-bfeb-53cbbbba6f08&OnState=Draft&WithOutcome=None&OrderResultsBy=CreationDate&Limit=1&Offset=0&IncludeAffidavits=true&IncludeAffidavitBlobs=true'

Responses

Query executed successfully

Bodyapplication/json
totalMatchesinteger
resultsArray of objects(EviSmsQueryResult)
Response
{ "totalMatches": 0, "results": [ { … } ] }