Briefumschlag erstellen

POST /esignglobal/v1/envelope/create

Schnittstellenbeschreibung

Erstellt einen Entwurfsumschlag.

Anfrageparameter

Parametername		Typ	Ist erforderlich	Beschreibung
subject		string	true	Betreff des Umschlags, Beispiel: „Angebotsschreiben“
remark		string	false	Umschlagnotizen, Längenbeschränkung 1000 Zeichen
signerSettings		object	false	Aktionen, die Unterzeichnern erlaubt sind
	allowTransfer	boolean	false	Ob Unterzeichnern erlaubt ist, diesen Umschlag an andere zur Unterzeichnung weiterzuleiten, standardmäßig false true-Ermöglicht es dem Unterzeichner im Umschlag, den Umschlag an andere zu übertragen; false-Erlaubt dem Unterzeichner im Umschlag nicht, den Umschlag an andere zu übertragen;
	allowModifyName	boolean	false	Ob die Partei, die unterzeichnet, den Namen ändern darf, gilt nur für die Vorlagensignatur, standardmäßig false true-Erlaubt dem Unterzeichner, den Namen zu ändern false- Unterzeichner dürfen den Namen nicht ändern
expireAfterSeconds		long	false	Ablaufzeit des Umschlags: Nach wie vielen Sekunden läuft der Umschlag ab? Ablaufbereich: 86.400 Sekunden (1 Tag) ~ 7.776.000 Sekunden (90 Tage).
redirectUrl		string	false	Weiterleitungsadresse nach Abschluss der Unterzeichnung (Länge 2048), muss eine gültige http-Adresse sein
callBackUrl		string	false	Callback-Adresse (Länge 500), muss eine https-/http-Protokolladresse sein

Beispielanfrage

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Antwortparameter

Parametername

Typ

Beschreibung

envelopeId

string

Umschlag-ID

envelopeStatus

int

Umschlagstatus

0 - Erstellt (Entwurf)

1 - In Bearbeitung

2 - Abgeschlossen

3-Abgelaufen

5-Widerrufen

Beispielantwort

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}