Description

Retrieves a list of all the messages that are sent for the given document. Remark: if using Json, a GUID must not contain dashes (-), unlike XML.

HTTP method: GET
URI: https://api.signere.no/api/Message/Document/{DocumentId}
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document offline" or "Sign document online" or "Sign document on the portal"
Parameters
  • DocumentId: The ID (GUID) of the document from which you want to fetch messages (FromUri)
Response example
[
    {
        "Id": "113ae477c8054404927ea08a00d4d3af",
        "DocumentID": "ea522127d971420595efa08a00d4d3ae",
        "EmailTopic": "Updated information",
        "EmailMessage": "You have received an update on the transaction status. Please check your profile on signere.no",
        "RecipientEmailAddress": "customer1@hotmail.com",
        "SMSText": "You have a new email from signere.no please check your email.",
        "RecipientMobileNumber": "+4799887766",
        "SentTime": "2013-01-01T00:00:00.0000000",
        "MessageReceiverType": "SigneeRef",
        "ReceiverName": "+4799887766",
        "SenderSignature": "Ola Nordmann",
        "Status": "SENDT"
    },
    {
        "Id": "113ae477c8054404927ea08a00d4d3af",
        "DocumentID": "ea522127d971420595efa08a00d4d3ae",
        "EmailTopic": "Updated information",
        "EmailMessage": "You have received an update on the transaction status. Please check your profile on signere.no",
        "RecipientEmailAddress": "customer1@hotmail.com",
        "SMSText": "You have a new email from signere.no please check your email.",
        "RecipientMobileNumber": "+4799887766",
        "SentTime": "2013-01-01T00:00:00.0000000",
        "MessageReceiverType": "SigneeRef",
        "ReceiverName": "+4799887766",
        "SenderSignature": "Ola Nordmann",
        "Status": "SENDT"
    }
]
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfDocumentMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <DocumentMessageResponse>
      <DocumentID>ea522127-d971-4205-95ef-a08a00d4d3ae</DocumentID>
      <EmailMessage>You have received an update on the transaction status. Please check your profile on signere.no</EmailMessage>
      <EmailTopic>Updated information</EmailTopic>
      <Id>113ae477-c805-4404-927e-a08a00d4d3af</Id>
      <MessageReceiverType>SigneeRef</MessageReceiverType>
      <ReceiverName>+4799887766</ReceiverName>
      <RecipientEmailAddress>customer1@hotmail.com</RecipientEmailAddress>
      <RecipientMobileNumber>+4799887766</RecipientMobileNumber>
      <SMSText>You have a new email from signere.no please check your email.</SMSText>
      <SenderSignature>Ola Nordmann</SenderSignature>
      <SentTime>2013-01-01T00:00:00</SentTime>
      <Status>SENDT</Status>
   </DocumentMessageResponse>
   <DocumentMessageResponse>
      <DocumentID>ea522127-d971-4205-95ef-a08a00d4d3ae</DocumentID>
      <EmailMessage>You have received an update on the transaction status. Please check your profile on signere.no</EmailMessage>
      <EmailTopic>Updated information</EmailTopic>
      <Id>113ae477-c805-4404-927e-a08a00d4d3af</Id>
      <MessageReceiverType>SigneeRef</MessageReceiverType>
      <ReceiverName>+4799887766</ReceiverName>
      <RecipientEmailAddress>customer1@hotmail.com</RecipientEmailAddress>
      <RecipientMobileNumber>+4799887766</RecipientMobileNumber>
      <SMSText>You have a new email from signere.no please check your email.</SMSText>
      <SenderSignature>Ola Nordmann</SenderSignature>
      <SentTime>2013-01-01T00:00:00</SentTime>
      <Status>SENDT</Status>
   </DocumentMessageResponse>
</ArrayOfDocumentMessageResponse>
Response is list of:
Name Type Description Example value Nullable Enum
DocumentID Guid The ID (GUID) of the document for which a message is to be distributed EA522127D971420595EFA08A00D4D3AE False False
EmailMessage String The message body in the e-mail You have received an update on the transaction status. Please check your profile on signere.no False False
EmailTopic String Topic field in the e-mail Updated information False False
Id Guid The ID (GUID) of the message. 113AE477C8054404927EA08A00D4D3AF False False
MessageReceiverTypes The recipient of the message. SigneeRef False True
ReceiverName String The recipient's mobile phone number +4799887766 False False
RecipientEmailAddress String The recipient's e-mail address customer1@hotmail.com False False
RecipientMobileNumber String The recipient's mobile phone number +4799887766 False False
SenderSignature String Fullname or username for the user that sendt the message Ola Nordmann False False
SentTime DateTime The date and time witch the message was sent. 2013-01-01T00:00:00.0000000 False False
SMSText String The text of the sms if one was sent. You have a new email from signere.no please check your email. False False
SendingStatus The sending status of the message, have the message been sendt, or have the mail been reported as spam. SENDT False True