EviSMSQuery

app.ecertia.comThis operation allows the consultation of existing EviSMS in the system by the following fields:

WithUniqueIds[optional]: List of identifiers (Evild) for evidences for query.
WithLookupKeys[optional]: List of locators (LookupKey) for evidences for query.
OnState[optional]: t returns only those messages that are in the specified processing state. Contact support to use this parameter (Draft, New, Ready, Sent, Dispatched, Delivered, Read Replied ,Closed, Failed).
WithOutcome[optional]: Return only those messages that have obtained the specified result. Contact support to use this parameter (New, Certified, Retry, Dispatched, Sent, Delivered, Failed).
Limit[optional]: Number of items to be returned. (Default=100).
Offset[optional]: It allows to page the results and only those results from the specified result will be returned.
IncludeAffidavits [optional] (True (1) o False (0)): It specifies whether your list of affidavits should be included in the result delivered.
- True o 1: The list of affidavits must be included in the result.
- False o 0: The list of affidavits must not be included in the resultat.
IncludeAffidavitBlobs [optional] (True (1) o False (0): It specifies whether the bytes of Affidavits should be included in the result. Default value FALSE:
- True o 1: The bytes of the affidavits must be included in the result.
- False o 0: The bytes of the affidavits must not be included in the result.
IncludeAttachments [optional] (True (1) o False (0)): It specifies whether your list of attachments should be included in the result delivered:
- True o 1: The list of attachments must be included in the result
- False o 0: The list of attachments must not be included in the result.
IncludeAttachmentBlobs [optional] (True (1) o False (0): It specifies whether the bytes of attachments should be included in the result. Default value FALSE:
- True o 1: The bytes of the attachments must be included in the result.
- False o 0: The bytes of the attachments must not be included in the result.

Example of request

GET https://app.ecertia.com/api/EviSms/Query?WithUniqueIds=17cd5814c89c423dacedaba301357793&IncludeAffidavits=true&includeAffidavitBlobs=false&IncludeAttachments=true&includeAttachmentBlobs=false
Content-Type: application/json
Accept: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.ecertia.com

The result of this operation will include the following data:

TotalMatches: Number of logs (total) matching the query.
Results: List of EviSms included in the response (depending on the Limit/Offset parameters of the original request):
- UniqueId: Unique identifier (Evild) allocated to the evidence.
- LookupKey: Locator allocated to the evidence by user at the time of submit.
- Text: Content of SMS sent.
- State: Refers to the processing state of messages.
  - Draft: The message has not been sent yet, but it is stored on the server, thereby enabling its subsequent modification and/or delivery.
  - New: The message has been admitted for certification, remaining to be processed by the system.
  - Ready: The message has been locally processed. It will be subsequently sent
  - Sent: The message has been sent to the server or the operator that manages the mailbox or device of recipient: from now on the system will manage the process of reception.
  - Dispatched: The messaging service serving the recipient has accepted of the message and will then try to send it to the final recipient.
  - Delivered: The message has been delivered to the final recipient, but the content still has not been opened/read.
  - Read: The message has been opened/read by the final recipient.
  - Replied: The recipient has answered accepting or rejecting the message
  - Closed: End of the tracking of status, for which reason no more notifications or answers are expected and the notarial deposit will follow.
  - Failed: An error has occurred that makes it impossible to send the message.
- Outcome: Outcome of the processing of evidence generation:
  - New: The message has been admitted for certification, remaining to be processed by the system.
  - Certified: The message was locally processed, producing the certification of its content. Subsequently, the message will be sent.
  - Retry: A temporary failure has occurred and new attempts to send or process the message will be made.
  - Dispatched: The message was dispatched by a third messaging service or operator in order to be sent.
  - Sent: The message has been sent to the server or the operator that manages the mailbox or device of recipient: subsequently the system manages the process of reception.
  - Delivered: The message or the notification with the link were delivered to the final recipient, but the content still has not been opened/read.
  - Failed: An unrecoverable error has occurred or the limit of reattempts has been reached, which makes it impossible to send the message.
- CreationDate: Creation time/date of the message.
- LastStateChangeDate: Date/time of last status change.
- Affidavits: List of affidavits associated to the message:
  - UniqueId: Unique identifier associated to the affidavit.
  - Date: Creation time/date of affidavit.
  - EvidenceUniqueId: Unique identifier of the evidence to which this affidavit belongs.
  - Description: Description of affidavit.
  - Bytes: Data (bytes) of affidavit.
  - Kind: Type identifier of the generated affidavit. Kinds of Affidavits.
- Issuer: Data about the message’s issuer:
  - LegalName: Name of message’s issuer.
  - PhoneNumber: Sender’s mobile phone number of the message.
- Recipient: Data about the message’s recipient:
  - LegalName: Name or corporate name of the recipient of the email.
  - PhoneNumber: Message recipient’s mobile phone number.
- TimeToLive (minutes): Time (in minutes) that the message/contract will be available before proceeding to close the tracking of the message. In those cases in which the notification/contract is accessible via a link, once that period has elapsed and if it has never been accessed, this link is no longer available.
- OnlineRetentionPeriod: Time (in years) of online retention.
- NotaryRetentionPeriod: Time (in years) of retention at the notary's office.
- NotaryProfile: Notary’s identifier who will carry out custody at the notary’s office
- SourceChannel: Indicates the channel through which the message was submitted (Web, Api, Smtp).
- AllowRefusal: Indicates whether the receiver can refuse to read the message.
- AffidavitKinds: Displays the types of affidavits selected in the issue. Kinds of Affidavits.

Example of answer in JSON

{
	"totalMatches": 1,
	"results": [
		{
			"uniqueId": "dbef5ae5-5760-47ad-bf1c-a341000f9f97",
			"text": "Hi This is a certified SMS",
			"outcome": "Delivered",
			"creationDate": "2014-06-05T00:56:52.99675+02:00",
			"lastStateChangeDate": "2014-06-05T00:57:01+02:00",
			"issuer":
			{
				"legalName": "JGM",
				"phoneNumber": "karlafdemo"
			},
			"recipient":
			{
				"legalName": "Karla Fernandez",
				"phoneNumber": "+50689217437"
			},
		}
	]
}

Page tree

EviSMSQuery