Add Phone Contact

<!-- ## uni.addPhoneContact(options) @addphonecontact -->

::: sourceCode

uni.addPhoneContact(options) @addphonecontact

GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-addPhoneContact

GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-addPhoneContact

:::

手机通讯录联系人和联系方式的增加

addPhoneContact 兼容性

Web	微信小程序	Android	iOS	HarmonyOS	HarmonyOS(Vapor)
<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	4.41	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	4.61	5.0

参数

名称	类型	必填	默认值	兼容性	描述
options	AddPhoneContactOptions	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -

options 的属性描述

名称	类型	必备	默认值	兼容性	描述
photoFilePath	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	头像本地文件路径
nickName	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	昵称
lastName	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	姓氏
middleName	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	中间名
firstName	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	名字
remark	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	备注
mobilePhoneNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	手机号
weChatNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	微信号
addressCountry	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	联系地址国家
addressState	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	联系地址省份
addressCity	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	联系地址城市
addressStreet	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	联系地址街道
addressPostalCode	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	联系地址邮政编码
organization	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	公司
title	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	职位
workFaxNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作传真
workPhoneNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作电话
hostNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	公司电话
email	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	电子邮件
url	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	网站
workAddressCountry	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作地址国家
workAddressState	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作地址省份
workAddressCity	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作地址城市
workAddressStreet	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作地址街道
workAddressPostalCode	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	工作地址邮政编码
homeFaxNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅传真
homePhoneNumber	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅电话
homeAddressCountry	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅地址国家
homeAddressState	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅地址省份
homeAddressCity	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅地址城市
homeAddressStreet	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅地址街道
homeAddressPostalCode	string	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	住宅地址邮政编码
success	(result: AddPhoneContactSuccess) => void	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	接口调用成功的回调函数
fail	(result: AddPhoneContactFail) => void	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	接口调用失败的回调函数
complete	(result: any) => void	否	-	Web: x; 微信小程序: 4.41; Android: x; iOS: x; HarmonyOS: -	接口调用结束的回调函数（调用成功、失败都会执行）

AddPhoneContactFail 的属性值 @addphonecontactfail-values

名称	类型	必备	默认值	兼容性	描述
errSubject	string	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	统一错误主题（模块）名称
errCode	number	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	统一错误码
errMsg	string	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	统一错误描述信息
data	any	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	错误信息中包含的数据
cause	Error	否	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -	源错误信息，可以包含多个错误，详见SourceError
name	string	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -
message	string	是	-	Web: x; 微信小程序: -; Android: x; iOS: x; HarmonyOS: -

<!-- UTSAPIJSON.addPhoneContact.example -->

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

<!-- UTSAPIJSON.addPhoneContact.example -->

通用类型

GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -	错误信息