返回顶部

get_tenpay_addr

特别声明

出于信息安全的考虑,本接口仅对可信赖的合作网站开放。

已经成功接入“QQ登录”的网站需提交申请以获取访问OpenAPI的权限。

1 接口说明

获取财付通用户的收货地址。
一个用户可能设置了多条收货地址信息。

查询的用户必须为财付通用户,否则查询将返回失败。

1.1 URL

OAuth2.0协议: https://graph.qq.com/cft_info/get_tenpay_addr

1.2 格式

JSON,XML

1.3 HTTP请求方式

POST

1.4 输入参数说明

各个参数请进行URL 编码,编码时请遵守 RFC 1738

(1)通用参数

-OAuth2.0协议必须传入的通用参数,详见这里

(2)私有参数

参数名称 是否必须 类型 描述
offset string 表示查询收货地址的偏移量,一般情况下offset可以不传值或传入0,表示从第一条开始读取。 

offset参数是为一种特殊情况准备的,即该收货人有很多条收获地址,需要分页展示,则offset可设置为该页显示的条数。例如如果offset为10,则会跳过第10条收货地址,从第11条收货地址开始读取。

limit string 表示查询收货地址的返回限制数(即最多期望返回几个收货地址)。 

limit不传默认按照5来处理。

ver string 用于接口版本控制。固定填1。
format string 定义API返回的数据格式。 

取值说明:为xml时表示返回的格式是xml;为json时表示返回的格式是json。

注意:json、xml为小写,否则将不识别。format不传或非xml,则返回json格式数据。

1.5 请求示例

1. 请求参数以OAuth2.0协议为例(敏感信息都用*号进行了处理,实际请求中需要替换成真实的值):

access_token=**********

oauth_consumer_key=000001

openid=*******************************

offset=0

limit=4

ver=1

format=xml

2. 对参数进行URL编码后拼接出的POST请求包:

POST /cft_info/get_tenpay_addr HTTP/1.1

Host: graph.qq.com

Content-Length: 340

Connection: Keep-Alive

Cache-Control: no-cache

access_token=**********&
oauth_consumer_key=000001&
openid=*******************************&
offset=0&
limit=4&
ver=1&
format=xml

 

1.6 返回参数说明

参数名称 描述
ret 返回码。
msg 如果ret不为0,会有相应的错误信息提示,返回数据全部用UTF-8编码
ret_num 该用户财付通收货地址的个数
Fname_x 第x条收货信息的收货人姓名。例如Fname_2表示第二条收货信息中的收货人姓名。
Ftel_x 第x条收货信息的收货人固定电话
Fzipcode_x 第x条收货信息的邮编
Fmobile_x 第x条收货信息的收货人移动电话
Faddrstreet_x 第x条收货信息的收货地址
FUsedCount_x 第x条收货信息被使用过的次数
Flastuse_time_x 第x条收货信息上一次被使用的时间
Fmod_time_x 第x条收货信息上一次被修改的时间
Fcreate_time_x 第x条收货信息的创建时间
FRegionId_x 第x条收货信息的地区编号
Findex_x 第x条收货信息的索引编号

1.7 返回码说明

0: 正确返回

其它: 失败。公共错误码说明详见:公共返回码说明

本接口私有返回码解释如下:

3000 – 30033005-3099:系统繁忙,请尝试隔段时间后再次调用。如果多次调用失败,请通过企业QQ(800030681)联系QQ登录OpenAPI支持。

3004:该用户为非财付通用户,无法获取其收货地址信息。

1.8 正确返回示例

XML示例:

1.9 错误返回示例

XML示例: