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

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

请求地址

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

Query 参数

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

Body 参数（json）

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

Body 参数示例

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

返回值

参数名	参数类型	备注
`errno`	`int`	错误码
`message`	`string`	错误信息

返回值示例

{
  "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"
  }
}

消息体字段含义如下：

参数名	参数类型	备注
`AppId`	`string`	授权小程序的 appid
`TpAppId`	`string`	第三方平台的 appid
`EventTime`	`string`	推送事件时间
`Event`	`string`	推送事件类型
`ApplyPhoneNumberCapabilityResults`	`object`	「获取用户手机号」能力申请的审核结果
`reason`	`string`	如果被拒，被拒原因
`status`	`int`	0：代表不通过，1：代表通过，2：代表能力关闭

点击纠错

评价此篇文档

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