查询邀请任务

更新时间：2022-01-11 05:11:59

接口描述

对接方通过调用创建邀请任务接口获得邀请任务ID后，可通过本接口随时查询邀请任务详情。

注：自2022年1月12日起，邀请任务相关接口停止维护，e签宝不再允许再对接使用此接口。

接口

/v1/invitations/search

请求方式

POST

请求头

提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

请求头入参示例如下：

参数名称	类型	必选	参数说明	示例值
X-Tsign-Open-App-Id	string	是	项目ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	否	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
X-Tsign-Open-Token	string	是	通过获取鉴权Token接口返回
Content-Type	string	是	application/json; charset=UTF-8

请求参数

参数名称	类型	必选	参数类型	参数说明	示例值
invitationId	string	是	body	邀请任务id，请先调用创建邀请任务接口获得id
offset	int	否	body	偏移量
size	int	否	body	每页数量，默认20

公共响应参数

参数名称	类型	必选	参数说明	示例值
code	int	是	业务码，0表示成功
message	string	否	信息
data	object	否	业务信息

响应参数

展开全部参数参数名称			类型	必选	参数说明	示例值
inviteInfos			Array	否	邀请任务详情
	inviteType		string	否	邀请人类型；个人为PERSON，企业为ORGAN
	bizId		string	否	业务方id
	redirectUrl		string	否	重定向地址，会带上bizId参数
	callBacklUrl		string	否	回调接口地址
	status			否	实名状态；（1）0：代表账号已创建，且已在进行实名认证，尚未实名完成。（2）1：代表账号已创建，且已实名完成，进入邀请成功页面，但没有点击跳到配置的重定向地址。（3）2：代表账号已创建，且已实名完成，进入邀请成功页面，已点击跳到配置的重定向地址。（4）3、其他，暂无业务含义
	notifyType		string	否	“sms”表示短信，“email”表示邮件
	inviteeInfo		object	否	被邀请人信息
		mobile	string	否	被邀请人手机号
email		string	否	被邀请人邮箱
name		string	否	被邀请人姓名
idNumber		string	否	被邀请人证件号
certType		string	否	个人证件号类型 CRED_PSN_CH_IDCARD大陆身份证，默认值
organInfo		object	否	企业信息
	name	string	否	企业名称
	certNo	string	否	企业证件号
	certType	string	否	企业证件号类型 CRED_ORG_USCC统一社会信用代码，默认值CRED_ORG_CODE组织机构代码证
	legalName	string	否	企业法定代表人姓名
	legalNo	string	否	企业法定代表人证件号
total			int	否	总数

请求示例

POST /v1/invitations/search

{
  "invitationId":"iudi0989ad79",
  "offset":0,
  "size":"20"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "inviteInfos": [
            {
                "bizId": "123456",
                "notifyType": null,
                "redirectUrl": "https://www.baidu.com?bizId=123456",
                "callBackUrl": null,
                "status": "1",
                "inviteType": "PERSON",
                "inviteeInfo": {
                    "mobile": "xxxxxxx",
                    "email": null,
                    "name": "xxxxx",
                    "idNumber": "xxxxxxxx",
                    "certType": "CRED_PSN_CH_IDCARD"
                },
                "organInfo": null
            }
        ],
        "total": 1
    }
}

错误码

错误码	错误描述	解决方案