DocuSign

使用说明

Create and send envelopes for e-signature, use templates, check signing status, download signed documents, and manage recipients with DocuSign.

工具

`docusign_send_envelope`

Create and send a DocuSign envelope with a document for e-signature

输入

参数	类型	必填	描述
`emailSubject`	string	是	Email subject for the envelope
`emailBody`	string	否	Email body message
`signerEmail`	string	是	Email address of the signer
`signerName`	string	是	Full name of the signer
`ccEmail`	string	否	Email address of carbon copy recipient
`ccName`	string	否	Full name of carbon copy recipient
`file`	file	否	Document file to send for signature
`status`	string	否	Envelope status: "sent" to send immediately, "created" for draft (default: "sent")

输出

参数	类型	描述
`envelopeId`	string	Created envelope ID
`status`	string	Envelope status
`statusDateTime`	string	Status change datetime
`uri`	string	Envelope URI

`docusign_create_from_template`

Create and send a DocuSign envelope using a pre-built template

输入

参数	类型	必填	描述
`templateId`	string	是	DocuSign template ID to use
`emailSubject`	string	否	Override email subject (uses template default if not set)
`emailBody`	string	否	Override email body message
`templateRoles`	string	是	JSON array of template roles, e.g. [{"roleName":"Signer","name":"John","email":"john@example.com"}]
`status`	string	否	Envelope status: "sent" to send immediately, "created" for draft (default: "sent")

输出

参数	类型	描述
`envelopeId`	string	Created envelope ID
`status`	string	Envelope status
`statusDateTime`	string	Status change datetime
`uri`	string	Envelope URI

`docusign_get_envelope`

Get the details and status of a DocuSign envelope

输入

参数	类型	必填	描述
`envelopeId`	string	是	The envelope ID to retrieve

输出

参数	类型	描述
`envelopeId`	string	Envelope ID
`status`	string	Envelope status (created, sent, delivered, completed, declined, voided)
`emailSubject`	string	Email subject line
`sentDateTime`	string	When the envelope was sent
`completedDateTime`	string	When all recipients completed signing
`createdDateTime`	string	When the envelope was created
`statusChangedDateTime`	string	When the status last changed
`voidedReason`	string	Reason the envelope was voided
`signerCount`	number	Number of signers
`documentCount`	number	Number of documents

`docusign_list_envelopes`

List envelopes from your DocuSign account with optional filters

输入

参数	类型	必填	描述
`fromDate`	string	否	Start date filter (ISO 8601). Defaults to 30 days ago
`toDate`	string	否	End date filter (ISO 8601)
`envelopeStatus`	string	否	Filter by status: created, sent, delivered, completed, declined, voided
`searchText`	string	否	Search text to filter envelopes
`count`	string	否	Maximum number of envelopes to return (default: 25)

输出

参数	类型	描述
`envelopes`	array	Array of DocuSign envelopes
↳ `envelopeId`	string	Unique envelope identifier
↳ `status`	string	Envelope status (created, sent, delivered, completed, declined, voided)
↳ `emailSubject`	string	Email subject line
↳ `sentDateTime`	string	ISO 8601 datetime when envelope was sent
↳ `completedDateTime`	string	ISO 8601 datetime when envelope was completed
↳ `createdDateTime`	string	ISO 8601 datetime when envelope was created
↳ `statusChangedDateTime`	string	ISO 8601 datetime of last status change
`totalSetSize`	number	Total number of matching envelopes
`resultSetSize`	number	Number of envelopes returned in this response

`docusign_void_envelope`

Void (cancel) a sent DocuSign envelope that has not yet been completed

输入

参数	类型	必填	描述
`envelopeId`	string	是	The envelope ID to void
`voidedReason`	string	是	Reason for voiding the envelope

输出

参数	类型	描述
`envelopeId`	string	Voided envelope ID
`status`	string	Envelope status (voided)

`docusign_download_document`

Download a signed document from a completed DocuSign envelope

输入

参数	类型	必填	描述
`envelopeId`	string	是	The envelope ID containing the document
`documentId`	string	否	Specific document ID to download, or "combined" for all documents merged (default: "combined")

输出

参数	类型	描述
`base64Content`	string	Base64-encoded document content
`mimeType`	string	MIME type of the document
`fileName`	string	Original file name

`docusign_list_templates`

List available templates in your DocuSign account

输入

参数	类型	必填	描述
`searchText`	string	否	Search text to filter templates by name
`count`	string	否	Maximum number of templates to return

输出

参数	类型	描述
`templates`	array	Array of DocuSign templates
↳ `templateId`	string	Template identifier
↳ `name`	string	Template name
↳ `description`	string	Template description
↳ `shared`	boolean	Whether template is shared
↳ `created`	string	ISO 8601 creation date
↳ `lastModified`	string	ISO 8601 last modified date
`totalSetSize`	number	Total number of matching templates
`resultSetSize`	number	Number of templates returned in this response

`docusign_list_recipients`

Get the recipient status details for a DocuSign envelope

输入

参数	类型	必填	描述
`envelopeId`	string	是	The envelope ID to get recipients for

输出

参数	类型	描述
`signers`	array	Array of DocuSign recipients
↳ `recipientId`	string	Recipient identifier
↳ `name`	string	Recipient name
↳ `email`	string	Recipient email address
↳ `status`	string	Recipient signing status (sent, delivered, completed, declined)
↳ `signedDateTime`	string	ISO 8601 datetime when recipient signed
↳ `deliveredDateTime`	string	ISO 8601 datetime when delivered to recipient
`carbonCopies`	array	Array of carbon copy recipients
↳ `recipientId`	string	Recipient ID
↳ `name`	string	Recipient name
↳ `email`	string	Recipient email
↳ `status`	string	Recipient status

DocuSign

On this page