创建邀请任务(需账号)

接口描述:创建邀请任务,被邀请人收到通知后需要注册并完成实名认证方可开通电子签名服务。

接口地址:/v1/invitations

请求方式: POST

请求参数:

参数名 参数类型 必选 类型 说明
inviteeOid POST string 被邀请人账号id,请先调用创建账号接口获取id,支持个人和机构
redirectURL POST string 结束后重定向地址(需加前缀https:// 或 http:// ),默认停留在当前页面
callbackURL POST string 回调接口地址,默认为空,不回调
bizId POST string 业务方id,重定向和回调时都回传这个id
notifyType POST string 默认为空,传入“sms”表示短信,“email”表示邮件,若两者都传入,则只发送短信

请求示例

POST /v1/invitations
{
  "bizId": "123456",
  "callbackURL": "https://www.baidu.com",
  "inviteeOid": "123456789",
  "notifyType": "sms",
  "redirectURL": "http://127.0.0.1"
}

响应参数

参数名称 说明 类型
invitationId 邀请任务id string
invitationURL 邀请链接 string

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "invitationId": "d07b82c59a534681a6dd34a692ac53f1",
        "invitationURL": "https://ttapi.tsign.cn/account-webserver/redirect/invite/init?contextId=d07b82c59a534681a6dd34a692ac53f1&inviteId=6490589a430b498fb3aed2281432ad1f"
    }
}

错误码

错误码 错误信息 错误原因
1000022 缺少参数: inviteeOid 必须指定被邀请人账号id

results matching ""

    No results matching ""