查看webhook列表
1.描述:查看用户webhook列表
2.接口地址:
请求路径：
/ws-rest/v1/users/{user-id}/webhooks?fields=event&filters=null&offset=0&limit=20&sortings=null请求头：
采用HMAC认证请求体：
{ }
3.请求方式
GET
4.请求参数说明
a.请求示例
curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Date: Wed, 02 Nov 2016 03:25:54 GMT" \
--header "User-Agent: SignIt RestAPI Client v1.0.0" \
--header "Host: api.signit.cn" \
--header "Authorization:HmacSHA512 a1S0H2-U0-v5I-0586-017-z6D-7B5-K0h-1o0-G0-9923G3Xm:53f7ae4a-937b-4ddc-8872-42dd094d56eb:NCMwvHfZS9ZzB2SgVbRzTuS/N5yDRM8Ak6tRvCavHD5T9nKjydc9ha+Rj48e0YIFC5V9IRtFL8Z1d0hvse7Ulg=="
"http://api.signit.cn/ws-rest/v1/users/1834/webhooks?fields=event%2Cmetadata&filters=null&sortings=null&limit=0&offset=20"
b.请求字段说明
| 字段 | 必填 | 类型 | 位置 | 长度 | 说明 |
|---|---|---|---|---|---|
| user-id | 是 | long | URL-PATH | 用户id | |
| fields | 否 | String | URL-PATH | 字段选择(webhookId,createDatetime,updateDatetime,status,webhookName,webhookUrl,event，metadata),默认(webhookId,createDatetime,updateDatetime,status,webhookName,webhookUrl) | |
| filters | 否 | String | URL-PATH | 过滤条件(webhookId,createDatetime,updateDatetime,status)组合，eg：filters=active=false | |
| offset | 否 | int | URL-PATH | 分页索引偏移量，默认为0 | |
| limit | 否 | int | URL-PATH | 分页索引个数，默认为20 | |
| sortings | 否 | String | URL-PATH | 排序(webhookId,createDatetime,updateDatetime) |
5.响应参数说明
a.响应示例
- 响应成功：
{ "resultStatusCode": "100700000", "resultCode": 0, "resultDesc": "webhook操作成功", "resultData": { "relLinks": { "self": { "href": "/ws-rest/v1/users/1834/webhooks?fields=user_id,create_datetime,update_datetime,name,id,url,status,event,metadata&filters=user_id=1834&offset=0&limit=20", "method": "GET" }, "first": { "href": "/ws-rest/v1/users/1834/webhooks?fields=user_id,create_datetime,update_datetime,name,id,url,status,event,metadata&filters=user_id=1834&offset=0&limit=20", "method": "GET" }, "last": { "href": "/ws-rest/v1/users/1834/webhooks?fields=user_id,create_datetime,update_datetime,name,id,url,status,event,metadata&filters=user_id=1834&offset=0&limit=20", "method": "GET" } }, "webhooks": [ { "userId": 1834, "createDatetime": 1487325636000, "updateDatetime": 1487325637000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeRevoke", "envelopeTimeout", "envelopeNotify", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "https://www.baidu.com" }, "webhookId": 7, "webhookName": "赵刚", "webhookUrl": "http://env.dl.signit.cn/ws-rest/v1/users/123/webhooks" }, { "userId": 1834, "createDatetime": 1494399887000, "updateDatetime": 1494399887000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeRevoke", "envelopeNotify", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 19, "webhookName": "webhook1", "webhookUrl": "http://callback1.url" }, { "userId": 1834, "createDatetime": 1494399912000, "updateDatetime": 1494399912000, "status": 1, "events": [ "envelopeStart", "envelopeReject", "envelopeRevoke", "envelopeNotify", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 20, "webhookName": "webhook2", "webhookUrl": "http://callback2.url" }, { "userId": 1834, "createDatetime": 1494399948000, "updateDatetime": 1494399948000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeRevoke", "envelopeNotify", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 21, "webhookName": "webhook3", "webhookUrl": "http://callback3.url" }, { "userId": 1834, "createDatetime": 1494399949000, "updateDatetime": 1494399950000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeNotify", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 22, "webhookName": "webhook4", "webhookUrl": "http://callback4.url" }, { "userId": 1834, "createDatetime": 1494399951000, "updateDatetime": 1494399951000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeRevoke", "envelopeNotify", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 23, "webhookName": "webhook5", "webhookUrl": "http://callback5.url" }, { "userId": 1834, "createDatetime": 1494399952000, "updateDatetime": 1494399952000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeRevoke", "recipientConfirm", "recipientReject" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 24, "webhookName": "webhook6", "webhookUrl": "http://callback6.url" }, { "userId": 1834, "createDatetime": 1494399952000, "updateDatetime": 1494399953000, "status": 1, "events": [ "envelopeStart", "envelopeCompleted", "envelopeReject", "envelopeRevoke", "envelopeNotify", "recipientConfirm" ], "notifyUrl": { "returnUrl": "www.register.com" }, "webhookId": 25, "webhookName": "webhook7", "webhookUrl": "http://callback7.url" } ] } }- 响应失败：
{ "resultStatusCode": "100700100", "resultCode": 1, "resultDesc": "webhook操作失败" }
b.响应字段说明
| 字段 | 是否必填 | 类型 | 位置 | 长度 | 说明 |
|---|---|---|---|---|---|
| X-Total-Count | 是 | int | HEADER | 总webhook数 | |
| self | 是 | object | BODY | 当前页资源链接 | |
| first | 是 | object | BODY | 第一页资源链接 | |
| last | 是 | object | BODY | 最后一页资源链接 | |
| prev | 是 | object | BODY | 上一页资源链接 | |
| next | 是 | object | BODY | 下一页资源链接 | |
| webhookId | 是 | long | BODY | webhookid | |
| webhookName | 是 | String | BODY | webhook名 | |
| webhookUrl | 是 | String | BODY | webhook调用url地址 | |
| events | 是 | array | BODY | webhook定义的事件，详见webhook事件 | |
| notifyUrl | 否 | Object | BODY | 回调数据封装 | |
| returnUrl | 是 | string | BODY | 未实名认证重定向地址 | |
| status | 是 | int | BODY | 是否启动webhook链接(0:不启动，1：启动) | |
| createDatetime | 是 | long | BODY | webhook创建时间 | |
| updateDatetime | 是 | long | BODY | webhook更新时间 | |
| resultStatusCode | 是 | String | BODY | 状态码 | |
| resultCode | 是 | int | BODY | 结果码 | |
| resultDesc | 是 | String | BODY | 状态描述 |