# uni.addPhoneContact(options)

添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式,写入手机系统通讯录。

# addPhoneContact 兼容性 ?

Web 微信小程序 支付宝小程序 Android iOS HarmonyOS
x 4.41 x 5.08 5.08 4.61

# 参数

名称 类型 必填 兼容性 描述
options AddPhoneContactOptions 是
添加手机通讯录联系人的参数
名称 类型 必备 兼容性 描述
photoFilePath string 否
头像本地文件路径
nickName string 否
昵称
lastName string 否
姓氏
middleName string 否
中间名
firstName string 否
名字
remark string 否
备注
mobilePhoneNumber string 否
手机号
weChatNumber string 否
即时消息账号
addressCountry string 否
联系地址国家
addressState string 否
联系地址省份
addressCity string 否
联系地址城市
addressStreet string 否
联系地址街道
addressPostalCode string 否
联系地址邮政编码
organization string 否
公司
title string 否
职位
workFaxNumber string 否
工作传真
workPhoneNumber string 否
工作电话
hostNumber string 否
公司电话
email string 否
电子邮件
url string 否
网站
workAddressCountry string 否
工作地址国家
workAddressState string 否
工作地址省份
workAddressCity string 否
工作地址城市
workAddressStreet string 否
工作地址街道
workAddressPostalCode string 否
工作地址邮政编码
homeFaxNumber string 否
住宅传真
homePhoneNumber string 否
住宅电话
homeAddressCountry string 否
住宅地址国家
homeAddressState string 否
住宅地址省份
homeAddressCity string 否
住宅地址城市
homeAddressStreet string 否
住宅地址街道
homeAddressPostalCode string 否
住宅地址邮政编码
success (result: AddPhoneContactSuccess) => void 否
接口调用成功的回调函数
fail (result: AddPhoneContactFail) => void 否
接口调用失败的回调函数
complete (result: AddPhoneContactSuccess | AddPhoneContactFail) => void 否
接口调用结束的回调函数(调用成功、失败都会执行)

# AddPhoneContactFail 的属性值

名称 类型 必备 兼容性 描述
errCode number 是
合法值 兼容性
601
602
603
errSubject string 是
统一错误主题(模块)名称
data any 否
错误信息中包含的数据
cause Error 否 源错误信息,可以包含多个错误,详见SourceError
errMsg string 是

# 参见

# uni.chooseContact(options)

拉起手机通讯录,选择联系人

# chooseContact 兼容性 ?

Web 微信小程序 支付宝小程序 Android iOS HarmonyOS
x 4.41 x 5.08 5.08 4.61

# 参数

名称 类型 必填 兼容性 描述
options ChooseContactOptions 是
拉起手机通讯录的参数
名称 类型 必备 兼容性 描述
success (result: ChooseContactSuccess) => void 否
接口调用成功的回调函数
fail (result: ChooseContactFail) => void 否
接口调用失败的回调函数
complete (result: ChooseContactSuccess | ChooseContactFail) => void 否
接口调用结束的回调函数(调用成功、失败都会执行)

# ChooseContactSuccess 的属性值

名称 类型 必备 兼容性 描述
displayName string 是
联系人姓名
phoneNumber string 是
当前选中的手机号
phoneNumberList Array<string> 是
联系人的所有手机号
errMsg string 是
接口调用结果

# ChooseContactFail 的属性值

名称 类型 必备 兼容性 描述
errCode number 是
合法值 兼容性
601
602
603
errSubject string 是
统一错误主题(模块)名称
data any 否
错误信息中包含的数据
cause Error 否 源错误信息,可以包含多个错误,详见SourceError
errMsg string 是

# 参见

# 通用类型

# GeneralCallbackResult

名称 类型 必备 描述
errMsg string 是 错误信息