Pokaz docusign (wersja zapoznawcza)
Docusign umożliwia organizacjom tworzenie, zatwierdzanie umów i zarządzanie nimi w całym cyklu życia umowy. Klienci mogą przyspieszyć przychody, zmniejszyć ryzyko i odblokować wartość z umów, które prowadzą swoją działalność. Łącznik pokazowy docusign łączy się tylko ze środowiskami demonstracyjnymi docusign, ale oferuje takie same funkcje jak produkcyjny łącznik DocuSign. Żadne umowy w środowisku demonstracyjnym docusign nie są prawnie wiążące.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure regionach Chin - Departament Obrony USA (DoD) |
| Power Apps | Standard | Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Standard | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | docusign |
| adres URL | https://support.docusign.com |
| Metadane łącznika | |
|---|---|
| Publisher | DocuSign, Inc. |
| Witryna internetowa | https://www.docusign.com |
| Zasady ochrony prywatności | https://www.docusign.com/company/privacy-policy |
| Kategorie | Zawartość i pliki; Produktywność |
Title
Usługa DocuSign ułatwia organizacjom łączenie się i automatyzowanie sposobu przygotowywania, podpisywania, wykonywania działań i zarządzania umowami. Łącznik demonstracyjny DocuSign łączy się tylko ze środowiskami demonstracyjnymi DocuSign, ale oferuje takie same funkcje jak zwykły łącznik DocuSign. Wszystkie dokumenty w środowisku demonstracyjnym DocuSign nie są prawnie wiążące. W przypadku wszystkich zastosowań innych niż demo użyj zwykłego łącznika DocuSign.
Wymagania wstępne
Aby użyć wyzwalacza Connect w tej integracji, na koncie DocuSign Connect musi być włączona funkcja DocuSign Connect. Nie jest ona domyślnie włączona. Po włączeniu tej opcji można uzyskać dostęp do strony Ustawienia połączenia z poziomu aplikacji internetowej DocuSign Admin. Użycie wyzwalacza Connect w tej integracji spowoduje automatyczne zarejestrowanie elementu webhook.
Uzyskiwanie poświadczeń
Aby wypróbować łącznik, użyj konta DEMO:
- Przejdź do https://developers.docusign.com/
- Utwórz konto piaskownicy.
Różnią się one od bezpłatnych wersji próbnych, które nigdy nie wygasają, mają 90% naszych płatnych funkcji konta, a żadne dokumenty wysyłane za pośrednictwem wersji DEMO nie są prawnie wiążące (https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
Dokumentacja łącznika
Aby uzyskać szczegółową dokumentację dotyczącą łącznika, zapoznaj się z artykułem https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Znane problemy i ograniczenia
W przypadku problemów z aplikacją DocuSign spróbuj najpierw użyć tego linku: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Instrukcje dotyczące wdrażania
Użyj instrukcji aby wdrożyć ten łącznik jako łącznik niestandardowy w usłudze Microsoft Power Automate i Power Apps.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 250 | 60 sekund |
Akcje
| Aktualizowanie adresata na kopercie |
Aktualizowanie adresata na kopercie |
| Aktualizowanie kart wypełniania koperty |
Aktualizowanie wartości dla listy kart wstępnego wypełniania |
| Aktualizowanie pola niestandardowego koperty |
Aktualizowanie wartości określonego pola niestandardowego koperty |
| Aktualizowanie pól formularza generowania dokumentu z koperty |
Aktualizowanie pól formularza generowania dokumentu z koperty |
| Aktualizowanie wartości kart adresatów na kopercie |
Aktualizowanie wartości kart adresatów na kopercie |
| Dodawanie adresata do koperty (wersja 2) |
Dodaj adresata do koperty. |
| Dodawanie dokumentów do koperty |
Dodaj dokumenty do koperty. |
| Dodawanie kart adresata na kopercie |
Dodawanie kart adresata na kopercie |
| Dodawanie przypomnień dotyczących koperty |
Dodawanie przypomnień dotyczących koperty |
| Dodawanie typu weryfikacji do adresata |
Dodaj typ weryfikacji do adresata. |
| Generowanie osadzonego adresu URL nadawcy |
Generowanie osadzonego adresu URL nadawcy |
| Generowanie osadzonego adresu URL podpisywania (wersja 2) |
Generowanie osadzonego adresu URL podpisywania (wersja 2) |
| Generowanie osadzonego adresu URL podpisywania [PRZESTARZAŁE] |
Generowanie osadzonego adresu URL podpisywania |
| Listy kopert |
Ta akcja przywraca odpowiednie koperty Docusign na podstawie stanu koperty, zakresu dat, nazwy adresata, adresu e-mail adresata, tytułu koperty, nazwy dokumentu lub wartości pola niestandardowego koperty. Dane wyjściowe to tytuł, opis, identyfikator koperty, nazwy dokumentów, nazwy nadawcy, stan koperty, data wysłania i adres URL koperty, który może służyć jako link do wyświetlania koperty w docusign. |
| Opróżnij kopertę |
Opróżnij kopertę. |
| Pobieranie dokumentów z koperty |
Pobieranie dokumentów z koperty |
| Pobieranie informacji adresata z koperty |
Pobieranie informacji adresata z koperty |
| Pobieranie informacji dla karty adresata |
Zwraca wartość karty dla danego adresata |
| Pobieranie informacji o dokumencie z koperty |
Pobieranie informacji o dokumencie z koperty |
| Pobieranie kart adresatów z koperty |
Pobieranie kart adresatów z koperty |
| Pobieranie kart dokumentów z koperty |
Pobieranie kart dokumentów z koperty |
| Pobieranie kart dokumentów z szablonu |
Pobieranie kart dokumentów z szablonu |
| Pobieranie listy zdarzeń inspekcji |
Pobieranie listy zdarzeń inspekcji |
| Pobieranie pól formularza generowania dokumentu z koperty |
Pobieranie pól formularza generowania dokumentu z koperty |
| Pobieranie pól formularza generowania dokumentów z szablonu (tylko szablony wysyłania zbiorczego) |
Pobieranie pól formularza generowania dokumentów z szablonu (tylko szablony wysyłania zbiorczego) |
| Pobieranie pól niestandardowych dokumentu z koperty |
Pobieranie pól niestandardowych dokumentu z koperty |
| Pokaż numer kompilacji (tylko w przypadku odwołań. Nie dołączaj do przepływu do wykonania) |
Identyfikator aktualnie wdrożonej kompilacji. |
| PRZESTARZAŁE: Dodaj adresata do koperty (przestarzałe) [PRZESTARZAŁE] |
Dodaj adresata do koperty (przestarzałe). |
| PRZESTARZAŁE: Pobieranie dokumentów z koperty (przestarzałe) [PRZESTARZAŁE] |
Pobieranie dokumentów z koperty (przestarzałe) |
| PRZESTARZAŁE: Tworzenie koperty przy użyciu szablonu (przestarzałe) [PRZESTARZAŁE] |
Utwórz nową kopertę przy użyciu określonego szablonu (przestarzałe). |
| Stosowanie szablonu do dokumentów |
Stosowanie szablonu do dokumentów |
| Szablony list |
Wyświetlanie listy szablonów dla określonego konta. |
| Tworzenie koperty (wersja 2) |
Utwórz nową pustą kopertę. |
| Tworzenie koperty przy użyciu szablonu |
Utwórz nową kopertę przy użyciu określonego szablonu. |
| Tworzenie koperty przy użyciu szablonu z adresatami |
Utwórz nową kopertę przy użyciu określonego szablonu i określ adresatów. |
| Tworzenie koperty przy użyciu szablonu z adresatami i kartami |
Tworzenie koperty przy użyciu szablonu z adresatami i kartami |
| Tworzenie koperty przy użyciu szablonów złożonych |
Tworzenie koperty przy użyciu szablonów złożonych |
| Tworzenie listy wysyłania zbiorczego |
Tworzenie listy wysyłania zbiorczego |
| Uruchamianie przepływu pracy docusign |
Uruchamianie przepływu pracy docusign |
| Usuwanie adresata z koperty |
Usuwanie adresata z koperty |
| Uzyskiwanie informacji o polu niestandardowym koperty |
Pobierz informacje o polu niestandardowym koperty. |
| Wyślij kopertę |
Wyślij istniejącą kopertę. |
| Wyślij ponownie kopertę |
Ta akcja ponownie wysyła kopertę docusign lub wysyła przypomnienie do adresatów, którzy muszą podpisać umowę Docusign na podstawie podanego identyfikatora Koperty. |
| Wyświetlanie listy adresatów z koperty |
Wyświetlanie listy adresatów z koperty |
| Wyświetlanie listy dokumentów z koperty |
Wyświetlanie listy dokumentów z koperty |
| Wyświetlanie listy dokumentów z szablonu |
Wyświetlanie listy dokumentów z szablonu |
| Zaloguj się |
Zaloguj się |
| Zbiorcze wysyłanie koperty przy użyciu szablonu |
Zbiorcze wysyłanie koperty przy użyciu szablonu |
Aktualizowanie adresata na kopercie
Aktualizowanie adresata na kopercie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
recipientId | True | string |
Wprowadź identyfikator adresata. |
|
Typ podpisu
|
signatureType | string |
Typy sygnatur opartych na standardach (SBS) docuSign. |
|
|
Typ adresata
|
recipientType | True | string |
Typ adresata |
|
Identyfikator użytkownika klienta
|
clientUserId | string |
Identyfikator użytkownika klienta osadzonego logowania |
|
|
Adres URL rozpoczęcia osadzonego adresata
|
embeddedRecipientStartURL | string |
Ciąg adresu URL podany przez nadawcę na potrzeby przekierowywania osadzonego adresata. |
|
|
Kolejność podpisywania
|
routingOrder | string |
Kolejność podpisywania odbiorcy. |
|
|
Język powiadomień e-mail
|
emailNotificationLanguage | string |
Język powiadomienia e-mail. |
|
|
Temat powiadomienia e-mail
|
emailNotificationSubject | string |
Temat powiadomienia e-mail. |
|
|
Treść powiadomienia e-mail
|
emailNotificationBody | string |
Treść powiadomienia e-mail. |
|
|
Uwaga / Notatka
|
note | string |
Notatka niestandardowa dla adresata. |
|
|
Nazwa roli
|
roleName | string |
Nazwa roli skojarzona z adresatem. |
|
|
SMS Country Code
|
countryCode | string |
W przypadku powiadomień SMS kod kraju bez wiodącego znaku i znaku. |
|
|
Numer telefonu SMS
|
phoneNumber | string |
Wymagany jest adres e-mail logowania lub telefon SMS. Wyklucz kod kraju dla numeru telefonu. |
|
|
Grupa podpisywania
|
signingGroupId | string |
Grupa podpisywania |
|
|
szczegóły wybranego typu adresata
|
additionalRecipientParams | dynamic |
Szczegóły wybranego typu adresata. |
Zwraca
- Body
- Signer
Aktualizowanie kart wypełniania koperty
Aktualizowanie wartości dla listy kart wstępnego wypełniania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator dokumentu
|
documentId | True | string |
Wprowadź identyfikator dokumentu. |
|
Typ
|
tabType | string |
Typ |
|
|
identyfikator
|
tabId | string |
identyfikator |
|
|
Wartość
|
value | string |
Wartość |
Aktualizowanie pola niestandardowego koperty
Aktualizowanie wartości określonego pola niestandardowego koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator pola
|
fieldId | True | string |
Identyfikator pola niestandardowego |
|
Typ pola
|
fieldType | True | string |
Typ pola niestandardowego |
|
Name
|
name | True | string |
Nazwa pola niestandardowego |
|
Wartość
|
value | True | string |
Wartość pola niestandardowego |
Zwraca
Aktualizowanie pól formularza generowania dokumentu z koperty
Aktualizowanie pól formularza generowania dokumentu z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator GUID dokumentu
|
documentGuid | True | string |
Identyfikator GUID dokumentu |
|
Typ
|
fieldType | string |
Wybierz typ pola generowania dokumentu do zaktualizowania |
|
|
Name
|
name | string |
Wprowadź nazwę pola lub nazwę kolumny tabeli |
|
|
Wartość
|
value | string |
Wprowadź dane pola |
|
|
Etykieta
|
label | string |
Wymagane dla "Wiersza tabeli". Wprowadź etykietę pola docgen. |
|
|
: Nazwa tabeli
|
tableName | string |
Wymagane dla "Wiersza tabeli". Wprowadź nazwę tabeli. |
|
|
: Wiersz tabeli
|
rowNumber | string |
Wymagane dla "Wiersza tabeli". Wprowadź numer wiersza |
Aktualizowanie wartości kart adresatów na kopercie
Aktualizowanie wartości kart adresatów na kopercie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
recipientId | True | string |
Wprowadź identyfikator adresata. |
|
Typ
|
tabType | string |
Typ karty |
|
|
identyfikator
|
tabId | string |
identyfikator |
|
|
Wartość
|
value | string |
Wartość |
Dodawanie adresata do koperty (wersja 2)
Dodaj adresata do koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Typ adresata
|
recipientType | True | string |
Wprowadź lub wybierz typ adresata. |
|
Identyfikator użytkownika klienta
|
clientUserId | string |
Identyfikator użytkownika klienta osadzonego logowania |
|
|
Identyfikator adresata
|
recipientId | string |
Wprowadź identyfikator adresata. |
|
|
Adres URL rozpoczęcia osadzonego adresata
|
embeddedRecipientStartURL | string |
Ciąg adresu URL podany przez nadawcę na potrzeby przekierowywania osadzonego adresata. |
|
|
Kolejność podpisywania
|
routingOrder | string |
Kolejność podpisywania odbiorcy. |
|
|
Język powiadomień e-mail
|
emailNotificationLanguage | string |
Język powiadomienia e-mail. |
|
|
Temat powiadomienia e-mail
|
emailNotificationSubject | string |
Temat powiadomienia e-mail. |
|
|
Treść powiadomienia e-mail
|
emailNotificationBody | string |
Treść powiadomienia e-mail. |
|
|
Uwaga / Notatka
|
note | string |
Notatka niestandardowa dla adresata. |
|
|
Nazwa roli
|
roleName | string |
Nazwa roli skojarzona z adresatem. |
|
|
SMS Country Code
|
countryCode | string |
W przypadku powiadomień SMS kod kraju bez wiodącego znaku i znaku. |
|
|
Numer telefonu SMS
|
phoneNumber | string |
Wymagany jest adres e-mail logowania lub telefon SMS. Wyklucz kod kraju dla numeru telefonu. |
|
|
Grupa podpisywania
|
signingGroupId | string |
Grupa podpisywania |
|
|
Typ podpisu
|
signatureType | string |
Typy sygnatur opartych na standardach (SBS) docuSign. |
|
|
Przepływ pracy weryfikacji
|
workflowId | string |
W tym miejscu należy wybrać przepływy pracy idV z typami sygnatur pióra. |
|
|
szczegóły wybranego typu adresata
|
additionalRecipientParams | dynamic |
Szczegóły wybranego typu adresata. |
Zwraca
- Body
- Signer
Dodawanie dokumentów do koperty
Dodaj dokumenty do koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Dokument Base64 *
|
documentBase64 | True | string |
Base64 zawartości dokumentu |
|
Typ dokumentu *
|
fileExtension | True | string |
pdf, docx itp. |
|
Nazwa dokumentu *
|
name | True | string |
nazwa dokumentu |
|
Przekształcanie pól pdf
|
transformPdfFields | string |
Nieprawda |
|
|
Przypisywanie kart do adresata
|
assignTabsToRecipientId | string |
Identyfikator adresata |
Zwraca
- Body
- AddDocumentsResponse
Dodawanie kart adresata na kopercie
Dodawanie kart adresata na kopercie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
recipientId | True | string |
Wprowadź identyfikator adresata. |
|
Typ karty
|
tabType | True | string |
Typ karty |
|
szczegóły karty
|
tabDetails | True | dynamic |
Szczegóły wybranej karty zakotwiczenia. |
Zwraca
Dodawanie przypomnień dotyczących koperty
Dodawanie przypomnień dotyczących koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Przypomnienie włączone
|
reminderEnabled | True | boolean |
Po ustawieniu wartości false przypomnienia są wyłączone. Wartość domyślna to false |
|
Opóźnienie przypomnienia
|
reminderDelay | True | string |
Dodaj liczbę dni, po których odbiorca otrzymuje wiadomość e-mail z przypomnieniem. |
|
Częstotliwość przypomnienia
|
reminderFrequency | True | string |
Dodaj liczbę dni między wiadomościami e-mail z przypomnieniami. |
|
Wygaśnięcie po
|
expireAfter | string |
Dodaj liczbę dni przed wygaśnięciem. |
Zwraca
- Body
- AddRemindersResponse
Dodawanie typu weryfikacji do adresata
Dodaj typ weryfikacji do adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
recipientId | True | string |
Wprowadź identyfikator adresata. |
|
Typ adresata
|
recipientType | True | string |
Wprowadź lub wybierz typ adresata. |
|
Typ weryfikacji
|
verificationType | True | string |
Typ weryfikacji |
|
Dodatkowe dane adresata
|
additionalRecipientData | dynamic |
Dodatkowe dane adresata. |
Generowanie osadzonego adresu URL nadawcy
Generowanie osadzonego adresu URL nadawcy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Otwórz w
|
openIn | True | string |
Otwórz w |
|
Zwracany adres URL
|
returnUrl | True | string |
Zwracany adres URL |
|
Dodatkowy dodany adres URL
|
additionalURL | dynamic |
Dodatkowy dodany adres URL. |
Zwraca
Generowanie osadzonego adresu URL podpisywania (wersja 2)
Generowanie osadzonego adresu URL podpisywania (wersja 2)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Czy jest to osoba podpisjąca osobiście?
|
isInPersonSigner | True | string |
Yes/No |
|
Metoda uwierzytelniania
|
authenticationMethod | True | string |
Metoda uwierzytelniania |
|
Zwracany adres URL
|
returnUrl | True | string |
Zwracany adres URL |
|
Dodatkowy dodany adres URL
|
additionalURL | True | dynamic |
Dodatkowy dodany adres URL. |
Zwraca
Generowanie osadzonego adresu URL podpisywania [PRZESTARZAŁE]
Generowanie osadzonego adresu URL podpisywania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Nazwa osoby podpisającego
|
signerName | True | string |
Nazwa osoby podpisającego |
|
Adres e-mail sygnatariusza
|
signerEmail | True | string |
Adres e-mail sygnatariusza |
|
Identyfikator użytkownika klienta
|
clientUserId | string |
Wymagane, chyba że osoba podpisjąca jest osobiście. Pozostaw pole puste dla osób podpisujących osoby |
|
|
Metoda uwierzytelniania
|
authenticationMethod | True | string |
Metoda uwierzytelniania |
|
Zwracany adres URL
|
returnUrl | True | string |
Zwracany adres URL |
|
Dodatkowy dodany adres URL
|
additionalURL | dynamic |
Dodatkowy dodany adres URL. |
Zwraca
Listy kopert
Ta akcja przywraca odpowiednie koperty Docusign na podstawie stanu koperty, zakresu dat, nazwy adresata, adresu e-mail adresata, tytułu koperty, nazwy dokumentu lub wartości pola niestandardowego koperty. Dane wyjściowe to tytuł, opis, identyfikator koperty, nazwy dokumentów, nazwy nadawcy, stan koperty, data wysłania i adres URL koperty, który może służyć jako link do wyświetlania koperty w docusign.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Imię i nazwisko adresata
|
recipientName | string |
Ta akcja wyświetla koperty na podstawie nazwy adresata |
|
|
Adres e-mail adresata
|
recipientEmailId | string |
Filtruje koperty według wiadomości e-mail adresata |
|
|
Temat koperty
|
envelopeTitle | string |
Filtruje koperty według tematu koperty |
|
|
Nazwa pola niestandardowego
|
customFieldName | string |
Ta akcja wyświetla koperty na podstawie nazwy pól niestandardowych |
|
|
Wartość pola niestandardowego
|
customFieldValue | string |
Filtry według wartości pola niestandardowego |
|
|
Wyszukiwanie wyrazu
|
search_text | string |
Wprowadź jedno słowo kluczowe, aby znaleźć dopasowania w tematach kopert, adresatach i polach niestandardowych. |
|
|
Stan koperty
|
envelopeStatus | string |
Ta akcja wyświetla koperty na podstawie stanu koperty |
|
|
Folder
|
folder_ids | string |
Filtruje koperty według wybranego folderu |
|
|
Zamów według
|
order_by | string |
Sortuje koperty w wybranej kolejności |
|
|
Zwracane koperty
|
top | integer |
Określ liczbę kopert do zwrócenia (wartość domyślna to 10; wartość maksymalna to 1000) |
|
|
Pomiń koperty
|
skip | integer |
Określ liczbę kopert do pominięcia od początku |
|
|
Data rozpoczęcia
|
from_date | date-time |
Wprowadź datę rozpoczęcia w formacie UTC: 2017-05-02T01:44z |
|
|
Data zakończenia
|
to_date | date-time |
Wprowadź datę zakończenia w formacie UTC: 2017-05-02T01:44z. |
Zwraca
Opróżnij kopertę
Opróżnij kopertę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Przyczyna pustki
|
voidedReason | True | string |
Przyczyna unieważnienia |
Zwraca
- response
- object
Pobieranie dokumentów z koperty
Pobieranie dokumentów z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Format wyjściowy
|
documentId | True | string |
Wprowadź ciąg (identyfikator dokumentu)", aby uzyskać pojedynczy dokument, lub wybierz format. |
|
Certyfikat języka uzupełniania (opcjonalnie)
|
language | string |
Wybierz język |
Zwraca
- response
- GetDocumentsResponse
Pobieranie informacji adresata z koperty
Pobieranie informacji adresata z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Adres e-mail adresata
|
recipientEmail | string |
Adres e-mail adresata |
|
|
Kod obszaru
|
areaCode | string |
Kod obszaru odbiorcy |
|
|
Numer telefonu
|
phoneNumber | string |
Numer telefonu odbiorcy |
|
|
Identyfikator adresata
|
recipientId | string |
Wprowadź identyfikator adresata. |
Zwraca
- Body
- Signer
Pobieranie informacji dla karty adresata
Zwraca wartość karty dla danego adresata
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
recipientId | True | string |
Wprowadź identyfikator adresata. |
|
Etykieta karty
|
tabLabel | True | string |
Etykieta karty |
Zwraca
- Body
- Tab
Pobieranie informacji o dokumencie z koperty
Pobieranie informacji o dokumencie z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Nazwa dokumentu
|
documentName | True | string |
Nazwa pliku z rozszerzeniem |
Zwraca
- Body
- EnvelopeDocument
Pobieranie kart adresatów z koperty
Pobieranie kart adresatów z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
recipientId | True | string |
Wprowadź identyfikator adresata. |
Zwraca
Pobieranie kart dokumentów z koperty
Pobieranie kart dokumentów z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator dokumentu
|
documentId | True | string |
Wprowadź identyfikator dokumentu. |
Zwraca
- Body
- ListTabsResponse
Pobieranie kart dokumentów z szablonu
Pobieranie kart dokumentów z szablonu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
|
Identyfikator dokumentu
|
documentId | True | string |
Wprowadź identyfikator dokumentu. |
Zwraca
- Body
- ListTabsResponse
Pobieranie listy zdarzeń inspekcji
Pobieranie listy zdarzeń inspekcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
Zwraca
- response
- object
Pobieranie pól formularza generowania dokumentu z koperty
Pobieranie pól formularza generowania dokumentu z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
Zwraca
Pobieranie pól formularza generowania dokumentów z szablonu (tylko szablony wysyłania zbiorczego)
Pobieranie pól formularza generowania dokumentów z szablonu (tylko szablony wysyłania zbiorczego)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
Zwraca
Pola formularza generowania dokumentu z szablonu
- Pola szablonu DocGen
- object
Pobieranie pól niestandardowych dokumentu z koperty
Pobieranie pól niestandardowych dokumentu z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator dokumentu
|
documentId | True | string |
Wprowadź identyfikator dokumentu. |
Zwraca
Pokaż numer kompilacji (tylko w przypadku odwołań. Nie dołączaj do przepływu do wykonania)
Identyfikator aktualnie wdrożonej kompilacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer kompilacji
|
buildNumber | dynamic |
Zwraca
- response
- object
PRZESTARZAŁE: Dodaj adresata do koperty (przestarzałe) [PRZESTARZAŁE]
Dodaj adresata do koperty (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Identyfikator konta |
|
Koperta
|
envelopeId | True | string |
Identyfikator koperty |
|
Nazwa osoby podpisającego
|
AddRecipientToEnvelopeName | True | string |
Nazwa adresata. |
|
Adres e-mail sygnatariusza
|
AddRecipientToEnvelopeEmail | True | string |
Adres e-mail odbiorcy. |
|
Kolejność podpisywania
|
routingOrder | string |
Kolejność podpisywania adresata w dokumencie. |
|
|
Role
|
roleName | string |
Rola sygnatariusza. |
Zwraca
PRZESTARZAŁE: Pobieranie dokumentów z koperty (przestarzałe) [PRZESTARZAŁE]
Pobieranie dokumentów z koperty (przestarzałe)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Identyfikator konta |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Certyfikat ukończenia
|
certificate | True | boolean |
Po ustawieniu wartości false certyfikat podpisywania koperty zostanie usunięty z pobierania. |
Zwraca
- response
- GetDocumentsResponse
PRZESTARZAŁE: Tworzenie koperty przy użyciu szablonu (przestarzałe) [PRZESTARZAŁE]
Utwórz nową kopertę przy użyciu określonego szablonu (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
|
Stan koperty
|
status | True | string |
Stan koperty |
|
Pola niestandardowe
|
accountCustomFields | True | dynamic |
Pobierz pola niestandardowe ustawione na poziomie konta. |
Zwraca
Stosowanie szablonu do dokumentów
Stosowanie szablonu do dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
|
Zachowaj adresata szablonu
|
preserve_template_recipient | string |
Nieprawda |
|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
|
Strona początkowa dokumentu
|
documentStartPage | True | string |
Strona początkowa dokumentu |
|
Strona końcowa dokumentu
|
documentEndPage | True | string |
Strona końcowa dokumentu |
Szablony list
Wyświetlanie listy szablonów dla określonego konta.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
Zwraca
Tworzenie koperty (wersja 2)
Utwórz nową pustą kopertę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Email temat
|
emailSubject | True | string |
Temat wiadomości e-mail. |
|
body
|
body | dynamic |
Treść wiadomości e-mail i pola niestandardowe konta. |
Zwraca
Tworzenie koperty przy użyciu szablonu
Utwórz nową kopertę przy użyciu określonego szablonu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
|
Stan koperty
|
status | True | string |
Stan koperty |
Zwraca
Tworzenie koperty przy użyciu szablonu z adresatami
Utwórz nową kopertę przy użyciu określonego szablonu i określ adresatów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Stan koperty
|
status | True | string |
Stan koperty |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
|
Sygnatariuszy
|
signers | dynamic |
Osoby podpisające dokument. |
|
|
Email temat
|
emailSubject | string |
Email temat |
|
|
Treść wiadomości e-mail
|
emailBody | string |
Treść wiadomości e-mail |
Zwraca
Tworzenie koperty przy użyciu szablonu z adresatami i kartami
Tworzenie koperty przy użyciu szablonu z adresatami i kartami
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
|
Adresatów
|
recipients | dynamic |
Osoby podpisające dokument. |
|
|
Scalanie ról i usuwanie pustych adresatów
|
merge_roles_on_draft | string |
Scalanie ról i usuwanie pustych adresatów |
|
|
Email temat
|
emailSubject | string |
Email temat |
Zwraca
Tworzenie koperty przy użyciu szablonów złożonych
Tworzenie koperty przy użyciu szablonów złożonych
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Email temat
|
emailSubject | True | string |
Temat wiadomości e-mail. |
|
Treść wiadomości e-mail
|
emailBody | string |
Treść wiadomości e-mail. |
|
|
Stan koperty
|
status | True | string |
Stan koperty |
|
Scalanie ról i usuwanie pustych adresatów
|
merge_roles_on_draft | string |
Scalanie ról i usuwanie pustych adresatów |
|
|
body
|
body | dynamic |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Identyfikator koperty. |
|
Status
|
status | string |
Stan koperty. |
|
Data stanu i godzina
|
statusDateTime | string |
Data/godzina ustawienia stanu. |
|
URI
|
uri | string |
Identyfikator URI koperty w docuSign. |
Tworzenie listy wysyłania zbiorczego
Tworzenie listy wysyłania zbiorczego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Nazwa listy wysyłania zbiorczego
|
name | True | string |
Nazwa listy wysyłania zbiorczego |
|
Plik CSV
|
csv | string |
Przekazywanie pliku CSV |
|
|
Pola generowania dokumentów
|
rawOutput | object |
Pola generowania dokumentów |
Zwraca
- Body
- BulkSendListGuid
Uruchamianie przepływu pracy docusign
Uruchamianie przepływu pracy docusign
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
przepływ pracy
|
workflowId | True | string |
Wprowadź identyfikator przepływu pracy lub wybierz nazwę przepływu pracy z listy rozwijanej |
|
nazwa wystąpienia
|
instanceName | True | string |
Nazwa wystąpienia przepływu pracy |
|
zmienna
|
variable | dynamic |
Zwraca
TriggerMaestroFlowResponse
- response
- object
Usuwanie adresata z koperty
Usuwanie adresata z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Folder
|
folderId | True | string |
Identyfikator folderu |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Identyfikator adresata
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
Identyfikator adresata |
Zwraca
Uzyskiwanie informacji o polu niestandardowym koperty
Pobierz informacje o polu niestandardowym koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
|
Nazwa pola niestandardowego
|
fieldName | True | string |
Nazwa pola niestandardowego |
Zwraca
Wyślij kopertę
Wyślij istniejącą kopertę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
Zwraca
- response
- object
Wyślij ponownie kopertę
Ta akcja ponownie wysyła kopertę docusign lub wysyła przypomnienie do adresatów, którzy muszą podpisać umowę Docusign na podstawie podanego identyfikatora Koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
Zwraca
- response
- object
Wyświetlanie listy adresatów z koperty
Wyświetlanie listy adresatów z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
Zwraca
Wyświetlanie listy dokumentów z koperty
Wyświetlanie listy dokumentów z koperty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator koperty
|
envelopeId | True | string |
Wprowadź identyfikator koperty. |
Zwraca
Wyświetlanie listy dokumentów z szablonu
Wyświetlanie listy dokumentów z szablonu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator szablonu
|
templateId | True | string |
Wprowadź lub wybierz identyfikator szablonu. |
Zwraca
Zaloguj się
Zbiorcze wysyłanie koperty przy użyciu szablonu
Zbiorcze wysyłanie koperty przy użyciu szablonu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź lub wybierz identyfikator konta. |
|
Identyfikator GUID listy wysyłania zbiorczego
|
bulkSendListId | True | string |
Identyfikator GUID listy wysyłania zbiorczego |
|
Identyfikator szablonu
|
envelopeOrTemplateId | True | string |
Wprowadź identyfikator szablonu lub wybierz szablon z listy rozwijanej |
Zwraca
- Body
- BulkSendListGuid
Wyzwalacze
| Gdy wystąpi zdarzenie Docusign Connect (poziom konta) |
Wyzwala nowy przepływ po zmianie stanu koperty. |
| Gdy wystąpi zdarzenie Docusign Connect (poziom organizacji) |
Wyzwala nowy przepływ po zmianie stanu koperty. |
| PRZESTARZAŁE: Po zmianie stanu koperty (Connect) (przestarzałe) [PRZESTARZAŁE] |
Wyzwala nowy przepływ po zmianie stanu koperty (przestarzałe). |
| PRZESTARZAŁE: Po zmianie stanu koperty (Connect) (V2) (przestarzałe) [PRZESTARZAŁE] |
Wyzwala nowy przepływ po zmianie stanu koperty (przestarzałe). |
Gdy wystąpi zdarzenie Docusign Connect (poziom konta)
Wyzwala nowy przepływ po zmianie stanu koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
accountId | True | string |
Wprowadź identyfikator konta lub wybierz konto z listy rozwijanej. |
|
Nazwa konfiguracji połączenia
|
name | True | string |
Nadaj konfiguracji połączenia nazwę (na przykład "Zdarzenia koperty"). |
|
Zdarzenia wyzwalające
|
events | True | array of string |
Wybierz zdarzenie. Aby dołączyć inne zdarzenie, wybierz pozycję "Dodaj nowy element". |
Zwraca
Gdy wystąpi zdarzenie Docusign Connect (poziom organizacji)
Wyzwala nowy przepływ po zmianie stanu koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji
|
organizationId | True | string |
Wprowadź lub wybierz identyfikator organizacji. |
|
Nazwa konfiguracji połączenia
|
name | True | string |
Nadaj konfiguracji połączenia nazwę (na przykład "Zdarzenia koperty"). |
|
Zdarzenia wyzwalające
|
events | True | array of string |
Wybierz zdarzenie. Aby dołączyć inne zdarzenie, wybierz pozycję "Dodaj nowy element". |
Zwraca
PRZESTARZAŁE: Po zmianie stanu koperty (Connect) (przestarzałe) [PRZESTARZAŁE]
Wyzwala nowy przepływ po zmianie stanu koperty (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Identyfikator konta |
|
Nazwa połączenia
|
name | True | string | |
|
Zdarzenie koperty
|
envelopeEvents | True | string |
Zwraca
PRZESTARZAŁE: Po zmianie stanu koperty (Connect) (V2) (przestarzałe) [PRZESTARZAŁE]
Wyzwala nowy przepływ po zmianie stanu koperty (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Identyfikator konta |
|
Nazwa połączenia
|
name | True | string | |
|
Zdarzenie koperty
|
envelopeEvents | True | string |
Zwraca
Definicje
Element webhookEnvelopeResponseV2
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola niestandardowe koperty
|
data.envelopeSummary.customFields | object |
Pary klucz-wartość reprezentujące pola niestandardowe dla tej koperty (gdzie klucz jest nazwą pola, a wartość jest wartością pola). |
|
Utworzona koperta Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Identyfikator koperty
|
data.envelopeSummary.envelopeId | string | |
|
Date-Time wysłane koperty
|
data.envelopeSummary.sentDateTime | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Stan koperty
|
data.envelopeSummary.status | string | |
|
Temat wiadomości e-mail
|
data.envelopeSummary.emailSubject | string | |
|
kopertaDokumenty
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Identyfikator dokumentu
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Identyfikator GUID dokumentu
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Nazwa dokumentu
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Nazwa nadawcy
|
data.envelopeSummary.sender.userName | string | |
|
Identyfikator użytkownika nadawcy
|
data.envelopeSummary.sender.userId | string | |
|
Identyfikator konta nadawcy
|
data.envelopeSummary.sender.accountId | string | |
|
Adres e-mail nadawcy
|
data.envelopeSummary.sender.email | string | |
|
Sygnatariuszy
|
data.envelopeSummary.recipients.signers | array of object | |
|
Karty
|
data.envelopeSummary.recipients.signers.tabs | object |
Pary klucz-wartość reprezentujące karty dla tego adresata (gdzie klucz jest nazwą pola, a wartość jest wartością pola). |
|
Adres e-mail adresata
|
data.envelopeSummary.recipients.signers.email | string | |
|
Identyfikator adresata
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Kolejność routingu
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Adresat wysłany Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Stan adresata
|
data.envelopeSummary.recipients.signers.status | string |
Stan odbiorcy. |
|
Typ adresata
|
data.envelopeSummary.recipients.signers.recipientType | string |
Typ adresata. |
|
Typ weryfikacji
|
data.envelopeSummary.recipients.signers.verificationType | string |
Typ weryfikacji. |
|
Nazwa adresata
|
data.envelopeSummary.recipients.signers.name | string |
Nazwa adresata. |
Element webhookOrganizacjaResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator organizacji
|
data.organizationId | string |
Identyfikator organizacji. |
|
Pola niestandardowe koperty
|
data.envelopeSummary.customFields | object |
Pary klucz-wartość reprezentujące pola niestandardowe dla tej koperty (gdzie klucz jest nazwą pola, a wartość jest wartością pola). |
|
Utworzona koperta Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Identyfikator koperty
|
data.envelopeSummary.envelopeId | string | |
|
Date-Time wysłane koperty
|
data.envelopeSummary.sentDateTime | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Stan koperty
|
data.envelopeSummary.status | string | |
|
Temat wiadomości e-mail
|
data.envelopeSummary.emailSubject | string | |
|
kopertaDokumenty
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Identyfikator dokumentu
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Identyfikator GUID dokumentu
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Nazwa dokumentu
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Nazwa nadawcy
|
data.envelopeSummary.sender.userName | string | |
|
Identyfikator użytkownika nadawcy
|
data.envelopeSummary.sender.userId | string | |
|
Identyfikator konta nadawcy
|
data.envelopeSummary.sender.accountId | string | |
|
Adres e-mail nadawcy
|
data.envelopeSummary.sender.email | string | |
|
Sygnatariuszy
|
data.envelopeSummary.recipients.signers | array of object | |
|
Karty
|
data.envelopeSummary.recipients.signers.tabs | object |
Pary klucz-wartość reprezentujące karty dla tego adresata (gdzie klucz jest nazwą pola, a wartość jest wartością pola). |
|
Adres e-mail adresata
|
data.envelopeSummary.recipients.signers.email | string | |
|
Identyfikator adresata
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Kolejność routingu
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Adresat wysłany Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Stan adresata
|
data.envelopeSummary.recipients.signers.status | string |
Stan odbiorcy. |
|
Typ adresata
|
data.envelopeSummary.recipients.signers.recipientType | string |
Typ adresata. |
|
Typ weryfikacji
|
data.envelopeSummary.recipients.signers.verificationType | string |
Typ weryfikacji. |
|
Nazwa adresata
|
data.envelopeSummary.recipients.signers.name | string |
Nazwa adresata. |
Element webhookEnvelopeResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola niestandardowe koperty
|
customFields | object |
Pary klucz-wartość reprezentujące pola niestandardowe dla tej koperty (gdzie klucz jest nazwą pola, a wartość jest wartością pola). |
|
Utworzona koperta Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Adres e-mail nadawcy
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
Identyfikator koperty
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
Adres IP nadawcy
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Date-Time wysłane koperty
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Stan koperty
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Temat
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Nazwa nadawcy
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
Stan adresata
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Karty
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Pary klucz-wartość reprezentujące karty dla tego adresata (gdzie klucz jest nazwą pola, a wartość jest wartością pola). |
|
Przyczyna odrzucenia
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
Adres e-mail adresata
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
Identyfikator adresata
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Kolejność routingu
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Adresat wysłany Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
rrrr-MM-ddTHH:mm:ss.fffZ |
|
Stan adresata
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
Stan odbiorcy. |
|
Typ adresata
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
Typ adresata. |
|
Nazwa adresata
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
Nazwa adresata. |
|
Strefa czasowa
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Przesunięcie strefy czasowej
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Zawartość pliku
- binary
AddRemindersResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przypomnienie włączone
|
reminderEnabled | string |
Przypomnienie włączone |
FiltrowaneEnvelopes
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Title
|
title | string |
Tytuł koperty |
|
Description
|
description | string |
Opis działania koperty |
|
Identyfikator koperty
|
envelopeId | string |
Identyfikator koperty |
|
Documents
|
documents | string |
Lista nazw dokumentów |
|
Nazwy adresatów
|
recipients | string |
Lista nazw adresatów |
|
Nazwa nadawcy
|
sender | string |
Nazwa nadawcy |
|
Status
|
status | string |
Stan koperty |
|
Data stanu
|
statusDate | string |
Ostatnia aktualizacja stanu działania |
|
Data wysłania
|
dateSent | date-time |
Data wysłania koperty |
|
adres URL
|
url | string |
Adres URL koperty |
EmbeddedSenderResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adres URL osadzonego nadawcy
|
url | string |
Adres URL osadzonego widoku nadawcy. |
EmbeddedSigningResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
adres URL
|
url | string |
Adres URL osadzonego widoku podpisywania. |
FilteredEnvelopeListResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Filtrowane koperty
|
value | array of FilteredEnvelopes |
Filtrowane koperty |
|
Więcej wyników kopert
|
hasMoreResults | boolean |
Pokazuje, czy koperty przekraczają określoną liczbę w polu Koperty zwrotne |
CreateEnvelopeResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Identyfikator koperty. |
|
Identyfikator szablonu
|
templateId | string |
Identyfikator szablonu. |
|
Status
|
status | string |
Stan koperty. |
|
Data stanu i godzina
|
statusDateTime | string |
Data/godzina ustawienia stanu. |
|
URI
|
uri | string |
Identyfikator URI koperty w docuSign. |
ListRecipientsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string | |
|
Sygnatariuszy
|
signers | array of Signer |
Sygnatariuszy |
Zakładka
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa karty
|
name | string |
Nazwa karty. |
|
Typ karty
|
tabType | string |
Typ karty. |
|
Etykieta karty
|
tabLabel | string |
Etykieta karty. |
|
Wartość karty
|
value | string |
Wartość karty. |
|
Identyfikator karty
|
tabId | string |
Identyfikator karty. |
|
Identyfikator dokumentu
|
documentId | string |
Identyfikator dokumentu. |
|
Identyfikator adresata
|
recipientId | string |
Identyfikator odbiorcy. |
|
Jest wstępnie wypełniane
|
prefill | boolean |
Wskazuje, czy karta ma typ wstępnego wypełniania. |
|
Wybrany
|
selected | string |
Jeśli karty są zaznaczone, wskazuje, czy karta jest zaznaczona. |
AdresaciTabsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Karta Adresata:
|
recipientTabs | array of Tab |
Karta Adresat |
Osoby podpisującej
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kolejność podpisywania
|
routingOrder | string |
Kolejność podpisywania adresata w dokumencie. |
|
Role
|
roleName | string |
Rola sygnatariusza. |
|
Identyfikator adresata
|
recipientId | string |
Identyfikator adresata. |
|
Name
|
name | string |
Nazwa adresata. |
|
Email
|
string |
Adres e-mail odbiorcy. |
|
|
Typ adresata
|
recipientType | string |
Wpisz adresata. |
|
Typ weryfikacji
|
verificationType | string |
Typ weryfikacji. |
|
Identyfikator GUID odbiorcy
|
recipientIdGuid | string |
Identyfikator GUID odbiorcy. |
GetLoginAccountsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Konta logowania
|
loginAccounts | array of LoginAccount |
Konta logowania |
LoginAccount
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa konta. |
|
Identyfikator konta guid
|
accountIdGuid | string |
Identyfikator GUID konta. |
ListTabsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Karty
|
tabs | array of Tab |
Karty |
ListEnvelopeDocumentFieldsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pole niestandardowe
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Pola niestandardowe dokumentu |
DocGenFormFieldsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola programu Docgen
|
docgenFields | array of DocGenFormField |
Pola programu Docgen |
DocGenFormField
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | string |
Identyfikator dokumentu. |
|
Etykieta
|
label | string |
Etykieta. |
|
Typ
|
type | string |
Typ. |
|
Name
|
name | string |
Nazwa. |
|
Wartość
|
value | string |
Wartość. |
ListTemplatesResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Szablony kopert
|
envelopeTemplates | array of EnvelopeTemplate |
Dostępne szablony kopert. |
KopertaTemplate
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator szablonu
|
templateId | string |
Identyfikator szablonu. |
|
Name
|
name | string |
Nazwa szablonu. |
BulkSendListGuid
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator GUID listy wysyłania zbiorczego
|
listId | string |
Identyfikator GUID listy wysyłania zbiorczego |
KopertaCustomFieldResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator pola
|
fieldId | string |
Identyfikator pola niestandardowego koperty. |
|
Typ pola
|
fieldType | string |
Typ pola niestandardowego koperty. |
|
Name
|
name | string |
Nazwa pola niestandardowego koperty. |
|
Wartość
|
value | string |
Wartość pola niestandardowego koperty. |
UpdateEnvelopeCustomFieldResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator pola
|
fieldId | string |
Identyfikator pola niestandardowego koperty. |
|
Typ pola
|
fieldType | string |
Typ pola niestandardowego koperty. |
|
Name
|
name | string |
Nazwa pola niestandardowego koperty. |
|
Wartość
|
value | string |
Wartość pola niestandardowego koperty. |
ListDocumentsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dokumenty koperty
|
envelopeDocuments | array of EnvelopeDocument |
Dokumenty dołączone do koperty. |
ListTemplateDocumentsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dokumenty szablonów
|
templateDocuments | array of EnvelopeDocument |
Dokumenty dołączone do szablonu. |
AddDocumentsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Identyfikator koperty. |
|
Dokumenty koperty
|
envelopeDocuments | array of EnvelopeDocument |
Dokumenty dołączone do koperty. |
AddRecipientTabsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Karty adresatów
|
recipientTabs | array of RecipientTab |
Karty dodane do adresata. |
KopertaDokument
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa dokumentu. |
|
Identyfikator dokumentu
|
documentId | string |
Identyfikator dokumentu. |
|
Identyfikator GUID dokumentu
|
documentIdGuid | string |
Identyfikator GUID dokumentu. |
Tab adresata
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator karty
|
tabId | string |
Identyfikator karty. |
|
Typ karty
|
tabType | string |
Typ karty. |
KopertaDokumentPole
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa pola niestandardowego. |
|
Wartość
|
value | string |
Wartość pola niestandardowego. |
DeclineReasonWithoutType
obiekt
Jest to typ 'obiekt'.