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

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	Адрес перенаправления после завершения подписания (длина 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-не включено
	accessCode		string	Пароль доступа к странице подписи
	signerStatus		int	Статус подписавшего 0-Ожидает подписи 1-В процессе подписания 2-Подписано
	signDate		timestamp	Время подписи
	declinedReason		string	Причина отказа в подписи, отображается, когда envelopeStatus имеет статус "отклонено"
canceledReason			string	Причина отмены, отображается, когда envelopeStatus имеет статус "отменено"

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

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "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"
}