接口说明

该接口会向用户发送人证核验的短信。

收到短信的用户可点击短信中的链接完成核验。
链接有效期为 2 个小时，核验的结果有效期为 72 个小时。

使用限制

每个小程序每天仅可发送 10 次核验短信。

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/apps/v1/icp_record/send_facial_recognition_notify/
HTTP Method	POST
Scope	ma.icp_record.facial_recognition
权限要求	授权小程序授予基本信息设置权限集

请求参数

请求头

access-token必填String

示例：isvact.0801121846735352506a356a6

调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token

content-type必填String

示例：application/json

固定值"application/json"

Body

app_incharge_people_phone必填String

小程序负责人手机号

province_code必填String

省份编码，通过查询区域信息接口获取

需要提交备案的省份编码保持一致

请求示例
curl --location 'https://open.douyin.com/api/apps/v1/icp_record/send_facial_recognition_notify' \
--header 'access-token: isvact.xxxx' \
--header 'Content-Type: application/json' \
--data '{
    "app_incharge_people_phone": "1xxxxxxxxxx",
    "province_code": "310000"
}'

响应参数

Body展开全部子属性

err_msg必填String

错误描述

err_no必填Int32

错误码

log_id必填String

标识请求的唯一id

dataStruct

展开子属性

响应示例
正常响应示例异常响应示例
{
  "err_msg": "",
  "err_no": 0,
  "log_id": "2023120718533575A5E8F8399C2143627D",
  "data": {
    "facial_recognition_token": "xxxxx"
  }
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述
200	6025	触发频控
200	9998	请求参数错误
200	9999	系统错误
200	28001008	access_token过期

人证核验结果通知

人证核验完成之后，会自动触发消息发送，然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的人证核验结果通知。

POST 数据示例：

{
    "Nonce": "4464221",
    "TimeStamp": "1535551395",
    "Encrypt": "Encrypt Message xxxxxxxx",
    "MsgSignature": "ba394c04acece6c2c0edee058c5dddf82474b8ee"
}

其中 Encrypt 字段需要解密，解密详情见消息推送及加解密说明部分。解密后消息格式如下：

{
        "AppId": "xxxx",
        "TpAppId": "xxxx",
        "Event": "ICP_RECORD_FACIAL_RRCOGNITION_RESULT",
        "EventTime": "2023-12-12 17:09:28",
        "EventContent": {
                "facial_recognition_token": "x",
                "facial_recognition_status": 2
        }
}

消息体字段含义如下：

名称		数据类型	描述
AppId		string	授权小程序 appid
TpAppId		string	授权小程序 appid
EventTime		string	推送事件时间
Event		string	推送事件类型，固定"ICP_RECORD_FACIAL_RRCOGNITION_RESULT"
EventContent		object	人证核验结果
	facial_recognition_token	string	人证核验token
	facial_recognition_status	number	人证核验状态

开发者文档

发送人证核验通知

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

人证核验结果通知

发送人证核验通知在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

人证核验结果通知

发送人证核验通知