Создать конверт

POST /esignglobal/v1/envelope/create

Описание интерфейса

Создает конверт в статусе черновика.

Параметры запроса

Название параметра		Тип	Обязательно	Описание
subject		string	true	Тема конверта, пример: «Offer Letter»
remark		string	false	Примечания к конверту, ограничение по длине 1000 символов
signerSettings		object	false	Действия, разрешенные для подписывающей стороны
	allowTransfer	boolean	false	Разрешено ли подписывающей стороне передавать этот конверт другим лицам для подписания, по умолчанию false true-Разрешает подписывающей стороне в конверте иметь право передавать конверт другим лицам; false-Запрещает подписывающей стороне в конверте иметь право передавать конверт другим лицам;
	allowModifyName	boolean	false	Разрешено ли подписывающей стороне изменять имя, действует только для подписи шаблона, по умолчанию false true-Разрешить подписывающей стороне изменить имя false- Подписанту не разрешено изменять имя
expireAfterSeconds		long	false	Время истечения срока действия конверта: через сколько секунд конверт истекает Диапазон истечения срока действия: от 86 400 секунд (1 день) до 7 776 000 секунд (90 дней).
redirectUrl		string	false	Адрес перенаправления после завершения подписания (длина 2048), должен быть действительным http-адресом
callBackUrl		string	false	Адрес обратного вызова (длина 500), должен соответствовать адресу протокола https /http

Пример запроса

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

Параметры ответа

Название параметра

Тип

Описание

envelopeId

string

ID конверта

envelopeStatus

int

Статус конверта

0 - Создан (черновик)

1 - В процессе подписания

2 - Завершен

3-Просрочено

5-Отозвано

Пример ответа

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