Freigeben über

RSign (Vorschau)

RSign® ist eine sichere, rechtsverbindliche E-Signatur-Plattform, die Dokumentworkflows optimiert. Mit diesem Connector können Benutzer das Senden von Signaturanforderungen automatisieren, den Umschlagstatus in Echtzeit nachverfolgen und abgeschlossene signierte Dokumente und Signaturzertifikate abrufen. Es verbessert die Geschäftseffizienz, indem die Dokumentausführung digitalisiert und sichere, nachverfolgbare digitale Transaktionen sichergestellt werden.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Klasse Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name RSign-Unterstützung
URL https://rsign.com/contact/questions
E‑Mail support@rpost.com
Connectormetadaten
Herausgeber RPost US Inc
Herausgeber RPost US Inc
Webseite https://rpost.com/
Datenschutzrichtlinie https://rpost.com/legal-notices/privacy-notice
Kategorien Inhalt und Dateien; Produktivität

Übersicht über den benutzerdefinierten RSign-Connector

Connectorname: RSign Description: RSign® ist eine E-Signature- und digitale Transaktionsverwaltungsplattform für sichere, rechtsverbindliche und optimierte Dokumentworkflows. Verlag: RPost

1. Connectorfunktionen

Der RSign-Connector® bietet Zugriff auf E-Signature- und Dokumentverwaltungsfunktionen, sodass Benutzer RSign-Workflows direkt in ihre Power Platform-Lösungen (Power Automate, Power Apps und Logic Apps) integrieren können.

Wichtige Aktionen

Der Connector unterstützt derzeit die folgenden primären Vorgänge:

  • AuthToken abrufen: Authentifiziert den Benutzer basierend auf RSign-Anmeldeinformationen® und ruft ein erforderliches Token (AuthToken) ab, das für alle nachfolgenden API-Aufrufe erforderlich ist.
  • Briefumschlag mithilfe einer Vorlage senden: Sendet ein Dokument für die E-Signatur mithilfe einer vorkonfigurierten RSign-Vorlage®, Zuordnen von Vorlagenrollen zu bestimmten Empfängern.
  • Briefumschlag mithilfe einer Regel senden: Sendet ein Dokument für E-Signaturen mithilfe einer vorkonfigurierten RSign-Regel®, sodass Dokumente als Base64-Daten im Anforderungstext bereitgestellt werden können.
  • Vorlageninformationen abrufen: Ruft Details zu einer bestimmten RSign-Vorlage® oder Regel ab, einschließlich definierter Dokumente und Empfängerrollen (RoleID).
  • Umschlagstatus abrufen: Ruft den Status einer E-Signatur-Anforderung mithilfe des Umschlagcodes ab.
  • Umschlagdokumente abrufen: Lädt die Dokumente herunter, die einem Umschlagcode zugeordnet sind (originale und/oder endgültige signierte Dokumente).

2. Authentifizierungseinrichtung

Der RSign-Connector® verwendet ein benutzerdefiniertes Authentifizierungsschema, das einen erfolgreichen Aufruf der Get AuthToken Aktion erfordert, bevor eine andere Aktion ausgeführt wird.

Authentifizierungsaktion (Get AuthToken)

Für diese Aktion sind die folgenden Anmeldeinformationen erforderlich, die von der RSign-Plattform® abgerufen werden müssen:

Parametername Typ Description Sichtbarkeit
ReferenceKey Schnur Der Referenzschlüssel, der Ihrem RPost-Konto® zugeordnet ist. Von Bedeutung
EmailId Schnur Die E-Mail-Adresse Ihres RSign-Kontos®. Von Bedeutung
Password Kennwort Das Kennwort für Ihr RSign-Konto®. Von Bedeutung

Verwenden des AuthTokens

Die Get AuthToken Aktion gibt einen AuthToken Im Antworttext zurück. Dieses Token muss dann in nachfolgenden API-Aufrufen an alle anderen unterstützten Aktionen übergeben werden.

Hinweis: Der AuthToken Wert verfügt über eine Ablaufzeit (AuthTokenExpires) und sollte innerhalb des Ablaufs oder der Anwendungslogik verwaltet werden, um sicherzustellen, dass ein neues Token verwendet wird, wenn das vorhandene abläuft.

3. Voraussetzungen

Um diesen benutzerdefinierten RSign-Connector® erfolgreich zu verwenden, müssen Benutzer die folgenden Anforderungen erfüllen:

  • Gültige RSign-Lizenz®: Benutzer müssen über eine aktive und gültige RSign-Benutzerlizenz® verfügen.
  • API-Zugriff: Das RSign-Konto®, das den bereitgestellten Anmeldeinformationen zugeordnet ist, muss das API-Zugriffsfeature aktiviert und bezahlt haben. Dieses Feature ist erforderlich, um den ReferenceKey RSign-Connector® zu generieren und erfolgreich zu nutzen.

Wenn Sie diese Anforderungen derzeit nicht erfüllen oder sich nicht sicher sind, dass Sie sich über Ihre aktuelle Einrichtung ihres RSign-Kontos® informieren, wenden Sie sich bitte an Ihren RPost-Vertreter®.

4. Wichtige Hinweise zur Integration

Vorlagen- und Regelverwendung

  • Vorlagencode/Regelcode: Für beide Send Envelope Aktionen ist ein TemplateCode (oder Regelcode) erforderlich, der das vorkonfigurierte Dokument und das Signieren von Feldern in RSign® identifiziert.
  • Rollenzuordnung: Beim Senden eines Umschlags muss das TemplateRoleRecipientMapping Array ausgefüllt werden. Der RoleID Für jeden Empfänger muss zuerst mithilfe der Retrieve Template Information Aktion abgerufen werden. Dadurch wird sichergestellt, dass Empfänger ordnungsgemäß den in der Vorlage definierten Signaturfeldern zugeordnet sind.

Dokumentverarbeitung

  • Briefumschlag mithilfe einer Regel senden: Für diese Aktion muss der Dokumentinhalt als base64-codierte Zeichenfolge (DocumentBase64Data) übergeben werden.
  • Umschlagdokumente abrufen: Die Dokumente werden im Antworttext als Base64-Zeichenfolgen (ByteArray) zurückgegeben. Der verbrauchende Fluss muss diese Zeichenfolge decodieren, um die Datei zu speichern.

Fehlerbehandlung

Alle Aktionen geben Statusinformationen im Antworttext zurück, einschließlich:

  • StatusCode (ganze Zahl)
  • StatusMessage (Zeichenfolge)
  • Message (Zeichenfolge)

Benutzer sollten die Fehlerüberprüfung basierend auf der StatusCode Sicherstellung der erfolgreichen Ausführung des Vorgangs implementieren.

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen von AuthToken

Gibt ein AuthToken zurück, das in allen anderen unterstützten RSign-Aktionen verwendet werden soll.
Abrufen von Vorlageninformationen

Ruft die Informationen zu einer Vorlage oder Regel basierend auf seinem Code ab. Zu den zurückgegebenen Informationen gehören der Name der Vorlage, Dokumente und Rollen.
Briefumschlag mithilfe einer Regel senden

Sendet eine eSign-Anforderung mithilfe der angegebenen RSign-Regel an ausgewählte Empfänger.
Briefumschlag mithilfe einer Vorlage senden

Sendet eine eSign-Anforderung mithilfe der angegebenen RSign-Vorlage an ausgewählte Empfänger.
Briefumschlagdokumente abrufen

Ruft den Dokumentteil eines Umschlags basierend auf seinem Umschlagcode ab. Je nach Umschlagstatus werden die originalen Dokumente und/oder die endgültigen signierten Dokumente abgerufen.
Umschlagstatus abrufen

Ruft den Status eines Umschlags basierend auf seinem Umschlagcode ab. Sie können einen detaillierten oder zusammengefassten Bericht auswählen.

Abrufen von AuthToken

Vorgangs-ID:
GetAuthToken

Gibt ein AuthToken zurück, das in allen anderen unterstützten RSign-Aktionen verwendet werden soll.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ReferenceKey
 ReferenceKey True string

Eindeutiger Bezeichner Ihres Unternehmenskontos.
EmailId
 EmailId True string

E-Mail-Adresse Ihres RSign-Kontos.
Kennwort
 Password True password

Kennwort Ihres RSign-Kontos.

Gibt zurück

Name Pfad Typ Beschreibung
Authentifizierungsnachricht
 AuthMessage string

Antwortstatusmeldung.
Authentifizierungstoken
 AuthToken string

Authentifizierungstoken, das in anderen RSign-Aktionen verwendet werden soll.
Aktualisierungstoken
 RefreshToken string

Aktualisierungstoken.
Aktualisierungstoken läuft ab
 RefreshTokenExpires string

Datum, an dem das aktuelle Aktualisierungstoken abläuft.
Authentifizierungstoken läuft ab
 AuthTokenExpires string

Datum, an dem das aktuelle Authentifizierungstoken abläuft.
E-Mail-ID
 EmailId string

E-Mail des authentifizierten Benutzers.
API-ID
 ApiId string

API-ID.

Abrufen von Vorlageninformationen

Vorgangs-ID:
GetTemplateInfo

Ruft die Informationen zu einer Vorlage oder Regel basierend auf seinem Code ab. Zu den zurückgegebenen Informationen gehören der Name der Vorlage, Dokumente und Rollen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorlagencode
 TemplateCode True string

Code der abzurufenden Vorlage.
Authentifizierungstoken
 AuthToken True string

AuthToken, das aus der Aktion "AuthToken abrufen" abgerufen wurde.

Gibt zurück

Name Pfad Typ Beschreibung
Statuscode
 StatusCode integer

Antwortstatuscode.
Statusmeldung
 StatusMessage string

Antwortstatusmeldung.
Nachricht
 Message string

Beschreibung des Antwortstatus.
Vorlagen-ID
 TemplateId string

Vorlagen-ID.
Vorlagen-ID
 TemplateBasicInfo.TemplateId string

Vorlagen-ID.
Vorlagencode
 TemplateBasicInfo.TemplateCode integer

Vorlagencode, der in anderen Aktionen verwendet werden soll.
Benutzer-E-Mail
 TemplateBasicInfo.UserEmail string

E-Mail des Benutzerbesitzers der Vorlage.
Vorlagenname
 TemplateBasicInfo.TemplateName string

Name der Vorlage.
Vorlagenbeschreibung
 TemplateBasicInfo.TemplateDescription string

Beschreibung der Vorlage.
Ist statisch
 TemplateBasicInfo.IsStatic string

Gibt an, ob die Vorlage geändert werden kann.
Ablaufdatum
 TemplateBasicInfo.ExpiryDate string

Datum, an dem die Vorlage abläuft.
Erstellt am
 TemplateBasicInfo.CreatedDate string

Datum, an dem die Vorlage erstellt wurde.
Datum der letzten Änderung
 TemplateBasicInfo.LastModifiedDate string

Datum, an dem die Vorlage zuletzt geändert wurde.
Betreff
 TemplateBasicInfo.Subject string

Betreff der E-Mail-Vorlage.
Body
 TemplateBasicInfo.Body string

E-Mail-Vorlage "Textkörper". HTML-codiert.
Typname
 TemplateBasicInfo.TypeName string

Typ der Vorlage (mögliche Werte: Vorlage, Regel).
Dokumentliste
 TemplateBasicInfo.DocumentList array of object

Liste der Dokumente.
Dokument-ID
 TemplateBasicInfo.DocumentList.DocumentId string

ID des Dokumentteils der Vorlage.
Dokumentname
 TemplateBasicInfo.DocumentList.DocumentName string

Name des Dokumentteils der Vorlage.
Bestellung
 TemplateBasicInfo.DocumentList.Order integer

Reihenfolge des Dokumentteils der Vorlage in der Dokumentliste.
Dokumentinhaltsdetails
 TemplateBasicInfo.DocumentList.documentContentDetails array of object

Dokumentinhaltsdetails.
Steuerungs-ID
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlID string

Interne ID des steuerelements, das im Dokument verwendet wird.
Name des Steuerelements
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlName string

Name des steuerelements, das im Dokument verwendet wird.
HTML-ID des Steuerelements
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID string

HTML-ID des steuerelements, das im Dokument verwendet wird.
Gruppenname
 TemplateBasicInfo.DocumentList.documentContentDetails.GroupName string

Name der Gruppe, die das Steuerelement enthält.
Etikett
 TemplateBasicInfo.DocumentList.documentContentDetails.Label string

Name des Steuerelements, das im Dokument angezeigt werden soll.
Seite Nein
 TemplateBasicInfo.DocumentList.documentContentDetails.PageNo integer

Seite im Dokument, in dem sich das Steuerelement befindet.
Erforderlich
 TemplateBasicInfo.DocumentList.documentContentDetails.Required boolean

Gibt an, ob das Steuerelement erforderlich ist oder nicht.
Steuerelementwert
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue string

Vorgefüllter Wert des Steuerelements.
Rollen-ID
 TemplateBasicInfo.DocumentList.documentContentDetails.RoleId string

ID der Rolle, die das Steuerelement ausfüllen muss.
Rollenname
 TemplateBasicInfo.DocumentList.documentContentDetails.RoleName string

Name der Rolle, die das Steuerelement ausfüllen muss.
Auswählen von Steuerelementoptionen
 TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions array of string

Wählen Sie "Steuerelementoptionen" aus.
Vorlagenrollenliste
 TemplateBasicInfo.TemplateRoleList array of object

Liste der Empfänger.
Rollen-ID
 TemplateBasicInfo.TemplateRoleList.RoleID string

ID des Rollenteils dieser Vorlage.
Rollenname
 TemplateBasicInfo.TemplateRoleList.RoleName string

Name des Rollenteils dieser Vorlage.
Bestellung
 TemplateBasicInfo.TemplateRoleList.Order integer

Reihenfolge, in der die Rolle (Empfänger) die Vorlage abschließen muss.
Empfänger-E-Mail
 TemplateBasicInfo.TemplateRoleList.RecipientEmail string

Vorab ausgefüllte E-Mails des Empfängerteils dieser Vorlage.
Name des Empfängers
 TemplateBasicInfo.TemplateRoleList.RecipientName string

Vorgefüllter Name des Empfängerteils dieser Vorlage.
Empfängertyp-ID
 TemplateBasicInfo.TemplateRoleList.RecipientTypeID string

Interne ID des Empfängertyps.
Empfänger-ID
 TemplateBasicInfo.TemplateRoleList.RecipientID string

ID des Empfängerteils dieser Vorlage.
Empfängertyp
 TemplateBasicInfo.TemplateRoleList.RecipientType string

Empfängertyp.
Cc-Signierertyp
 TemplateBasicInfo.TemplateRoleList.CcSignerType string

CC-Empfängertyp.
Kulturinformationen
 TemplateBasicInfo.TemplateRoleList.CultureInfo string

Es ist die Dienstsprache des Benutzers zum Zeitpunkt der Erstellung der Vorlage/Regel.
Übermittlungsmodus
 TemplateBasicInfo.TemplateRoleList.DeliveryMode integer

Gibt den Kanal an, über den die Signaturanforderung und der Zugriffscode an den Empfänger gesendet wurden.
Wählcode
 TemplateBasicInfo.TemplateRoleList.DialCode string

Wählnummer des Landes, in dem die Signaturanforderung und der Zugriffscode gesendet wurden.
Ländercode
 TemplateBasicInfo.TemplateRoleList.CountryCode string

Code des Landes, in dem die Signaturanforderung und der Zugriffscode gesendet wurden.
Handynummer
 TemplateBasicInfo.TemplateRoleList.Mobile string

Mobiltelefonnummer des Empfängers.
Mobiler Modus
 TemplateBasicInfo.TemplateRoleList.MobileMode integer

Gibt den mobilen Kanal an, über den die Signaturanforderung und der Zugriffscode an den Empfänger gesendet wurden.
E-Mail-Adresse
 TemplateBasicInfo.TemplateRoleList.EmailAddress string

E-Mail-Adresse des Empfängers.
Aktivieren von "Nachricht auf Mobile"
 TemplateBasicInfo.EnableMessageToMobile boolean

Aktivieren sie "Nachricht auf Mobilgeräte".
Ablaufdatum für statische Verknüpfungen
 TemplateBasicInfo.StaticLinkExpiryDate string

Ablaufdatum für statische Verknüpfungen.
Vorlagenliste
 TemplateList string

Vorlagenliste.

Briefumschlag mithilfe einer Regel senden

Vorgangs-ID:
SendEnvelopeFromRule

Sendet eine eSign-Anforderung mithilfe der angegebenen RSign-Regel an ausgewählte Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Authentifizierungstoken
 AuthToken True string

AuthToken, das aus der Aktion "AuthToken abrufen" abgerufen wurde.
TemplateCode
 TemplateCode True string

ID der zu verwendenden Regel.
Name
 Name True string

Dokumentname. Schließen Sie die Erweiterung ein (Beispiel: Agreement.docx).
DocumentBase64Data
 DocumentBase64Data True string

Dokument, das im Base64-Format gesendet werden soll.
App-Schlüssel
 AppKey string

Eindeutiger Bezeichner eines Systems mithilfe des Connectors. Bitte fordern Sie sie an den RPost-Support® an.
RoleID
 RoleID True string

Rollen-ID für den Empfänger. Abgerufen aus der Aktion "Vorlageninformationen abrufen".
RecipientEmail
 RecipientEmail True string

E-Mail-Adresse des Empfängers.
RecipientName
 RecipientName True string

Name des Empfängers.
Mobiltelefon
 Mobile string

Mobiltelefonnummer des Empfängers. Wenn Ihre Regel sie nicht benötigt, lassen Sie es leer.

Gibt zurück

Name Pfad Typ Beschreibung
Umschlagcode
 EnvelopeCode string

ID des Umschlags.
Meldung "Transparenz geändert"
 TransparencyChangedMessage string

Transparenz geänderte Nachricht.
Sprachbasierte API-Nachricht
 LanguageBasedApiMessge string

Sprachbasierte API-Nachricht.
Empfänger-ID vorab ausfüllen
 PrefillRecipientId string

Empfänger-ID vorab ausfüllen.
Navigationsseite nach dem Senden
 PostSendingNavigationPage string

Website, zu der der Empfänger umgeleitet wird, sobald er die Signatur des Umschlags abgeschlossen hat.
Ist die Benutzeroberfläche für neue Signierer aktiviert
 IsNewSignerUIEnabled boolean

Ist die Benutzeroberfläche für neue Signierer aktiviert.
Statuscode
 StatusCode integer

Antwortstatuscode.
Statusmeldung
 StatusMessage string

Antwortstatusmeldung.
Nachricht
 Message string

Beschreibung des Antwortstatus.
Umschlag-ID
 EnvelopeId string

Interne ID des generierten Umschlags.
Signieren der Dokument-URL
 SignDoumentUrl string

Globale URL für die Signatur des Umschlags.
Empfängerliste
 RecipientList array of object

Empfängerdetails
Name des Empfängers
 RecipientList.RecipientName string

Name des Empfängers.
Empfänger-E-Mail
 RecipientList.RecipientEmail string

E-Mail-Adresse des Empfängers.
Bestellung
 RecipientList.Order integer

Reihenfolge, in der der Empfänger darauf zugreifen muss, um den Umschlag abzuschließen.
Typ
 RecipientList.Type string

Typ des Empfängerteils des vorliegenden Umschlags. Mögliche Werte sind: Signierer und Prefill.
Übermittlungsmodus
 RecipientList.DeliveryMode integer

Gibt den Kanal an, über den die Signaturanforderung und der Zugriffscode an den Empfänger gesendet wurden.
Wählcode
 RecipientList.DialCode string

Wählnummer des Landes, in dem die Signaturanforderung und der Zugriffscode gesendet wurden.
Ländercode
 RecipientList.CountryCode string

Code des Landes, in dem die Signaturanforderung und der Zugriffscode gesendet wurden.
Handynummer
 RecipientList.Mobile string

Mobiltelefonnummer des Empfängers.
Mobiler Modus
 RecipientList.MobileMode integer

Gibt den mobilen Kanal an, über den die Signaturanforderung und der Zugriffscode an den Empfänger gesendet wurden.
Signatur-URL
 RecipientList.SigningUrl string

URL, die vom Empfänger verwendet werden soll, um auf den Umschlag zuzugreifen und zu signieren.
Dropdownliste für Wählcode
 DialCodeDropdownList string

Dropdownliste für Wählcode.
Aktivieren von "Nachricht auf Mobile"
 EnableMessageToMobile string

Aktivieren sie "Nachricht auf Mobilgeräte".

Briefumschlag mithilfe einer Vorlage senden

Vorgangs-ID:
SendEnvelopeFromTemplate

Sendet eine eSign-Anforderung mithilfe der angegebenen RSign-Vorlage an ausgewählte Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Authentifizierungstoken
 AuthToken True string

AuthToken, das aus der Aktion "AuthToken abrufen" abgerufen wurde.
TemplateCode
 TemplateCode True string

ID der zu verwendenden Vorlage.
App-Schlüssel
 AppKey string

Eindeutiger Bezeichner eines Systems mithilfe des Connectors. Bitte fordern Sie sie an den RPost-Support® an.
RoleID
 RoleID True string

Rollen-ID für den Empfänger. Abgerufen aus der Aktion "Vorlageninformationen abrufen".
RecipientEmail
 RecipientEmail True string

E-Mail-Adresse des Empfängers.
RecipientName
 RecipientName True string

Name des Empfängers.
Mobiltelefon
 Mobile string

Mobiltelefonnummer des Empfängers. Wenn die Vorlage nicht erforderlich ist, lassen Sie sie leer.

Gibt zurück

Name Pfad Typ Beschreibung
Umschlagcode
 EnvelopeCode string

ID des Umschlags.
Meldung "Transparenz geändert"
 TransparencyChangedMessage string

Transparenz geänderte Nachricht.
Sprachbasierte API-Nachricht
 LanguageBasedApiMessge string

Sprachbasierte API-Nachricht.
Empfänger-ID vorab ausfüllen
 PrefillRecipientId string

Empfänger-ID vorab ausfüllen.
Navigationsseite nach dem Senden
 PostSendingNavigationPage string

Website, zu der der Empfänger umgeleitet wird, sobald er die Signatur des Umschlags abgeschlossen hat.
Ist die Benutzeroberfläche für neue Signierer aktiviert
 IsNewSignerUIEnabled boolean

Ist die Benutzeroberfläche für neue Signierer aktiviert.
Statuscode
 StatusCode integer

Antwortstatuscode.
Statusmeldung
 StatusMessage string

Antwortstatusmeldung.
Nachricht
 Message string

Beschreibung des Antwortstatus.
Umschlag-ID
 EnvelopeId string

Interne ID des generierten Umschlags.
Signieren der Dokument-URL
 SignDoumentUrl string

Globale URL für die Signatur des Umschlags.
Empfängerliste
 RecipientList array of object

Empfängerdetails
Name des Empfängers
 RecipientList.RecipientName string

Name des Empfängerteils des aktuellen Umschlags.
Empfänger-E-Mail
 RecipientList.RecipientEmail string

E-Mail-Adresse des Empfängerteils des aktuellen Umschlags.
Bestellung
 RecipientList.Order integer

Reihenfolge, in der der Empfänger darauf zugreifen muss, um den Umschlag abzuschließen.
Typ
 RecipientList.Type string

Typ des Empfängerteils des vorliegenden Umschlags. Mögliche Werte sind: Signierer und Prefill.
Übermittlungsmodus
 RecipientList.DeliveryMode integer

Gibt den Kanal an, über den die Signaturanforderung und der Zugriffscode an den Empfänger gesendet wurden.
Wählcode
 RecipientList.DialCode string

Wählnummer des Landes, in dem die Signaturanforderung und der Zugriffscode gesendet wurden.
Ländercode
 RecipientList.CountryCode string

Code des Landes, in dem die Signaturanforderung und der Zugriffscode gesendet wurden.
Handynummer
 RecipientList.Mobile string

Mobiltelefonnummer des Empfängers.
Mobiler Modus
 RecipientList.MobileMode integer

Gibt den mobilen Kanal an, über den die Signaturanforderung und der Zugriffscode an den Empfänger gesendet wurden.
Signatur-URL
 RecipientList.SigningUrl string

URL, die vom Empfänger verwendet werden soll, um auf den Umschlag zuzugreifen und zu signieren.
Dropdownliste für Wählcode
 DialCodeDropdownList string

Dropdownliste für Wählcode.
Aktivieren von "Nachricht auf Mobile"
 EnableMessageToMobile string

Aktivieren sie "Nachricht auf Mobilgeräte".

Briefumschlagdokumente abrufen

Vorgangs-ID:
DownloadEnvelopeDocuments

Ruft den Dokumentteil eines Umschlags basierend auf seinem Umschlagcode ab. Je nach Umschlagstatus werden die originalen Dokumente und/oder die endgültigen signierten Dokumente abgerufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlagcode
 EnvelopeCode True string

Code des Umschlags, der abgerufen werden soll.
Authentifizierungstoken
 AuthToken True string

AuthToken, das aus der Aktion "AuthToken abrufen" abgerufen wurde.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 Status boolean

Statuserfolgskennzeichnung.
Statuscode
 StatusCode integer

Antwortstatuscode.
Nachricht
 Message string

Beschreibung des Antwortstatus.
Statusmeldung
 StatusMessage string

Antwortstatusmeldung.
Umschlagcode
 Data.EnvelopeCode string

Umschlagcode, der als Parameter übergeben wird.
Dokumentliste
 Data.DocumentList array of object

Liste der Dokumente.
Dokumenttyp
 Data.DocumentList.DocumentType string

Typ der Anlage.
Dateiname
 Data.DocumentList.FileName string

Name der Datei.
Description
 Data.DocumentList.Description string

Beschreibung des Dokuments.
Bytearray
 Data.DocumentList.ByteArray string

Datei im Base64-Format.
Zusätzliche Info
 Data.DocumentList.AdditionalInfo string

Zusätzliche Informationen.
Anlagenbeschreibung
 Data.DocumentList.AttachmentDescription string

Informative Beschreibung des Dateiinhalts.
Lesen Sie mich
 Data.ReadMe string

Textdatei im Base64-Format, die den Namen des signierten Dokuments und der Originaldatei angibt.
Kombinierter Zip-Zip
 Data.CombinedZip string

Zip-Datei mit allen Dokumenten des Umschlags.
Gesamtanzahl
 TotalCount integer

Gesamtanzahl.
Ist Anlagenuploads vorhanden
 IsAttachmentUploadsExist string

Ist Anlagenuploads vorhanden.

Umschlagstatus abrufen

Vorgangs-ID:
GetEnvelopeStatusInfo

Ruft den Status eines Umschlags basierend auf seinem Umschlagcode ab. Sie können einen detaillierten oder zusammengefassten Bericht auswählen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Authentifizierungstoken
 AuthToken True string

AuthToken, das aus der Aktion "AuthToken abrufen" abgerufen wurde.
EnvelopeCode
 EnvelopeCode True string

Umschlagcode.
DetailOrSummary
 DetailOrSummary True string

Wählen Sie den gewünschten Berichtstyp aus.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 Status boolean

Status der Anforderung.
Statuscode
 StatusCode integer

Antwortstatuscode.
Nachricht
 Message string

Beschreibung des Antwortstatus.
Statusmeldung
 StatusMessage string

Antwortstatusmeldung.
Briefumschlagdatenliste
 Data array of object
Umschlagcode
 Data.EnvelopeCode string

ID des Umschlags.
Umschlag-ID
 Data.EnvelopeID string

Interne ID des Umschlags.
Betreff
 Data.Subject string

E-Mail-Betreff des Umschlags.
Umschlagstatus
 Data.Status string

Status des angeforderten Umschlags.
IsEnvelopeComplete
 Data.IsEnvelopeComplete boolean

Gibt an, ob der Umschlag abgeschlossen ist.
Sendedatum
 Data.SentDate string

Datum, an dem der Umschlag gesendet wurde.
Letztes Änderungsdatum
 Data.LastModifiedDate string

Datum der letzten Änderung.
SenderName
 Data.SenderName string

Name des Absenders.
SenderEmail
 Data.SenderEmail string

E-Mail des Absenders.
Empfängerdetails
 Data.RecipientDetails array of object
Empfänger-ID
 Data.RecipientDetails.RecipientID string

ID des Empfängerteils des vorliegenden Umschlags.
Empfängertyp-ID
 Data.RecipientDetails.RecipientTypeID string

Typ-ID des Empfängerteils des vorhandenen Umschlags.
Empfängertyp
 Data.RecipientDetails.RecipientType string

Typ des Empfängerteils des vorliegenden Umschlags. Mögliche Werte sind: Signierer und Prefill.
Name des Empfängers
 Data.RecipientDetails.RecipientName string

Name des Empfängers.
E‑Mail
 Data.RecipientDetails.Email string

E-Mail-Adresse des Empfängers.
Bestellung
 Data.RecipientDetails.Order integer

Reihenfolge, in der der Empfänger darauf zugreifen muss, um den Umschlag abzuschließen.
StatusID
 Data.RecipientDetails.StatusId string

Status-ID.
Signaturstatus
 Data.RecipientDetails.SigningStatus string

Status der Signatur für den Empfänger des Umschlags.
Datum der letzten Änderung
 Data.RecipientDetails.LastModifiedDate string

Datum der letzten Änderung.
Referenzcode
 Data.ReferenceCode string

Referenzcodeteil des vorhandenen Umschlags.
Referenz-E-Mail
 Data.ReferenceEmail string

Verweisen Sie auf den E-Mail-Teil des aktuellen Umschlags.
TotalCount
 TotalCount integer

Die Gesamtmenge der Umschläge, die den angeforderten Kriterien entsprechen.
IsAttachmentUploadsExist
 IsAttachmentUploadsExist string

Ist Anlagenuploads vorhanden.