第三方平台
第三方平台概述
创建第三方平台
常见问题排查指南

申请「获取用户手机号」能力

为授权小程序申请「获取用户手机号」能力

请求地址

POST   https://open.microapp.bytedance.com/openapi/v1/microapp/operation/phone_number_application

 

Query 参数

参数名参数类型是否必须备注
component_appidstring第三方平台的 appid
authorizer_access_tokenstring授权小程序的接口调用令牌

Body 参数(json)

参数名参数类型是否必须备注
reasonint申请原因
1:用于必要登录场景,2:用于收货联系方式
sceneint使用场景
1:账号下信息内容同步,2:网络购物,3:票务预订,4:业务办理,5:信息查询(如社保、公积金查询),6:预约,7:其他
descriptionstring场景描述
字数限制:10~200
imagePathsArray<string>场景示例图列表
注意:
1. 需要使用 上传图片材料 接口返回的路径才可以,否则报错。
2. 目前仅支持传入 1 张图片的路径。若有多张场景示例图,请将它们拼接为 1 张图片后上传并在此处传入长度为 1 的场景示例图路径列表。

Body 参数示例

{
  "reason": 1,
  "scene": 1,
  "description": "xxx",
  "imagePaths": ["thirdparty/${tpAppId}/${prefix}/${hash}"]
}

 

返回值

参数名参数类型备注
errnoint错误码
messagestring错误信息

返回值示例

{
  "errno": 0,
  "message": "success"
}

错误码

参数名参数类型
30001未找到对应能力类型
30004请勿重复申请
30005不满足申请条件
30006申请信息格式错误
30007请填写完整申请信息
30008未找到小程序
30009请正确填写申请信息-场景描述
40033获取不到上传的图片材料,请确认文件路径正确

 

「获取用户手机号」能力申请审核结果通知

「获取用户手机号」能力申请审核结果出来之后,会自动触发消息发送,然后第三方应用会收到由第三方服务器推送的相应授权小程序的「获取用户手机号」能力申请的审核结果。

POST 数据示例:

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

其中 Encrypt 参数需要解密,解密详情见第三方平台消息加密解密部分:

{
  "AppId": 授权小程序的appid,
  "TpAppId": 第三方平台appid,
  "EventTime": "2019-01-14 12:45:10",
  "Event": "APPLY_PHONE_NUMBER_CAPABILITY",
  "ApplyPhoneNumberCapabilityResults": {
    "status": 0,
    "reason": "xxx"
  }
}

消息体字段含义如下:

参数名参数类型备注
AppIdstring授权小程序的 appid
TpAppIdstring第三方平台的 appid
EventTimestring推送事件时间
Eventstring推送事件类型
ApplyPhoneNumberCapabilityResultsobject「获取用户手机号」能力申请的审核结果
reasonstring如果被拒,被拒原因
statusint0:代表不通过,1:代表通过,2:代表能力关闭
点击纠错
评价此篇文档