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

更新时间 2024-07-24 02:58:49

我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序申请「获取用户手机号」能力。

注意：平台针对授权小程序有不同的申请规则，包含以下方式：

•

条件一

◦

小程序已上线

◦

信用分大于（含等于）90分

•

条件二

◦

小程序未上线

◦

服务类目满足要求，服务类目详情见本文档底部

关于该接口作用以及该能力使用的更多说明，可以参考获取用户手机号开通规范。

请求

基本信息

基本
`HTTP URL`	`https://open.microapp.bytedance.com/openapi/v1/microapp/operation/phone_number_application`
`HTTP Method`	`POST`
`权限要求`	授权小程序授予运营管理权限

查询参数

参数名	参数类型	是否必须	备注
`component_appid`	`string`	是	第三方小程序应用 appid
`authorizer_access_token`	`string`	是	授权小程序接口调用凭据

请求体（json）

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

请求体示例

json复制
{
  "reason": 1,
  "scene": 1,
  "description": "xxx",
  "imagePaths": ["xxxx/xxxx"]
}

响应

响应体

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

响应体示例

json复制
{
  "errno": 0,
  "message": "success"
}

错误码

错误码	message
30001	未找到对应能力类型
30004	请勿重复申请
30005	不满足申请条件
30006	申请信息格式错误
30007	请填写完整申请信息
30008	未找到小程序
30009	请正确填写申请信息-场景描述
40001	参数错误
40003	找不到相关第三方小程序应用
40004	找不到相关授权小程序
40020	第三方小程序应用 authorizer_access_token 不正确或者已过期
40033	获取不到上传的材料，请确认文件路径正确
40036	授权小程序未授予该接口对应的权限

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

「获取用户手机号」能力申请审核结果出来之后，会自动触发消息发送，然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的「获取用户手机号」能力申请的审核结果。

POST 数据示例：

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

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

json复制
{
  "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：代表能力关闭

服务类目详情

服务一级类目名称	服务二级类目名称	服务(三级)类目名称
政务	政务民生	教育
政务	政务民生	医疗
物流服务	物流服务	货物运输
物流服务	物流服务	快递收寄件, 物流服务-物流服务-快递查件（含物流）
物流服务	物流服务	同城配送
物流服务	物流服务	快递收寄件
物流服务	物流服务	仓库管理
体育	体育	体育场馆服务
体育	体育	体育培训
商业服务	商业服务	广告/设计
商业服务	商业服务	律师事务所
商业服务	商业服务	法律服务
商业服务	商业服务	公关/推广/市场调查
商业服务	商业服务	招聘/求职（中介）
商业服务	商业服务	会展服务
商业服务	商业服务	供应链企业
IT 科技	IT 科技	电信业务代理商
IT 科技	IT 科技	硬件与设备
IT 科技	IT 科技	软件服务提供商
房地产	房地产	商品房预售
房地产	房地产	房屋中介
房地产	房地产	房地产开发商
房地产	房地产	房地产资讯
房地产	房地产	装修/建材
房地产	房地产	物业管理
汽车	汽车	车展服务
汽车	汽车	新车
汽车	汽车	汽车经销商/4S店
汽车	汽车	汽车资讯
汽车	汽车	二手车
汽车	汽车	养车/修车
汽车	汽车	汽车报价/比价