Запрос деталей конверта

GET /esignglobal/v1/envelope/envelopeDetail

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

Запрос подробной информации об конверте, включая прогресс подписания, статус конверта и т.д.

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

Название параметра	Тип	Обязательно	Описание
envelopeId	string	true	ID конверта

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

GET https://……/esignglobal/v1/envelope/envelopeDetail?envelopeId=flow1234567890

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

Название параметра				Тип	Описание
envelopeId				string	ID конверта
envelopeStatus				int	Статус конверта 0 - Создано (черновик) 1 - В процессе подписания 2 - Завершено 3 - Срок действия истек 4 - Отклонено 5 - Отозвано
envelopeEndTime				timestamp	Время окончания конверта
envelopeCreateTime				timestamp	Время начала конверта
subject				string	Тема конверта
remark				string	Примечания к конверту (длина 1000)
redirectUrl				string	URL-адрес перенаправления после завершения подписания (длина 500)
CCInfos				array	Коллекция информации о получателях копий
	userEmail			string	Адрес электронной почты получателя копии
	userName			string	Имя получателя копии
initiatorInfo				object	Коллекция информации об отправителе
	userName			string	Имя отправителя, по умолчанию имя создателя, которому принадлежит APPID открытого приложения
signFiles				array	Набор информации о подписываемых файлах
	fileKey			string	FileKey подписываемого файла
attachments				array	Набор вложений конверта
	fileKey			string	FileKey конверта
signerInfos				array	Информация о подписывающем
	businessId			string	Определенный разработчиком номер бизнес-операции (длина 500)
	userName			string	Имя подписывающего
	userEmail			string	Адрес электронной почты подписывающего
	phoneNumber			object	Адрес SMS для получения подписывающим
		countryCode		string	Международный код страны/региона
		number		string	Номер мобильного телефона подписывающего для получения сообщений о подписании
	signOrder			int	Порядок подписания подписывающим, минимум 1.
	digitalSignature			boolean	Включить ли цифровую подпись, по умолчанию false true - включить, false - не включать
	authConfig			object	Способ проверки
		accessCode		object	Пароль доступа
			accessCode	string	Пароль доступа
			promptInfo	string	Подсказка для пароля доступа
		sms		object	SMS OTP-верификация
			countryCode	string	Международный код страны/региона
			number	string	Номер мобильного телефона для аутентификации
		idVerification		object	Аутентификация личности
			name	string	Полное имя, указанное в удостоверении личности подписавшего
		emailAuth		object	Email OTP-верификация
			authEmail	string	Адрес электронной почты для аутентификации личности подписавшего
		digitalId		object	Электронная аутентификация личности
			authApp	string	Приложение, используемое для электронной аутентификации личности
			idNumber	string	Номер удостоверения личности подписавшего, ожидающий проверки
		whatsappAuth		object	WhatsApp OTP-верификация
			countryCode	string	Международный код страны/региона
			number	string	Номер мобильного телефона для аутентификации личности
	signerStatus			int	Статус подписавшего 0 - Ожидает подписания 1 - В процессе подписания 2 - Подписано
	signDate			timestamp	Время подписания
	declinedReason			string	Причина отказа в подписи, отображается, когда envelopeStatus имеет статус "отклонено"
canceledReason				string	Причина отзыва, отображается, когда envelopeStatus имеет статус "отозвано"

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

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "authConfig": {
                    "accessCode": {
                        "accessCode": "1234567",
                        "promptInfo": "test"
                    }
                },
                "accessCode": null,
                "userEmail": "muyantest2@tsign.cn",
                "userName": "muyantest2222",
                "signDate": null,
                "signOrder": "1"
            },
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyan@tsign.cn",
                "userName": "muyant",
                "signDate": null,
                "signOrder": "1"
            }
        ],
        "envelopeExpireTime": 1724055000193,
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "envelopeCreateTime": null,
        "redirectUrl": "https://www.baidu.com",
        "attachments": [

        ],
        "canceledReason": null,
        "subject": "api create envelope hxqibLJpBD",
        "envelopeEndTime": null,
        "remark": "api remark",
        "CCInfos": null,
        "initiatorInfo": {
            "userName": "muyantest2"
        },
        "expireTime": 1724055000193,
        "envelopeId": "4a97d269d48642bb8b9d4878cde843a3",
        "envelopeStatus": 0
    },
    "message": "success"
}