阿里旺旺互动平台 OPEN API 文档_第1页
阿里旺旺互动平台 OPEN API 文档_第2页
阿里旺旺互动平台 OPEN API 文档_第3页
阿里旺旺互动平台 OPEN API 文档_第4页
阿里旺旺互动平台 OPEN API 文档_第5页
已阅读5页,还剩21页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

1、阿里旺旺互动平台 OPEN API 文档photo 相片相关接口接口描述根据相册Id取获得某个用户的照片列表系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV

2、应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v string 可选 接口版本号,要调用该版本请指定为1.0 albumId string 必须 相册Id ownerLongId string 可选 被查看者的用户长Id,如果提供该参数,则查看该用户的照片列表,需要进行隐私策略控制。 正常返回信息<?xml version="1.0" encoding="utf-8"?><album_getPhotoListResponse> <photo> <photoId>46LSx7zJqkRAAK

3、Ehe5pbtC</photoId> <photoName>backoffice_user_commend.jpg</photoName> <photoPath></photoPath> <photoSize>213177</photoSize> </photo> <photo> <photoId>7Q8O3Zy2aoX9L2NSFtO3kz</photoId> <photoName>ConcetpDiagram.jpg</photoName&g

4、t; <photoPath></photoPath> <photoSize>64330</photoSize> </photo></album_getPhotoListResponse>错误时返回信息<?xml version="1.0" encoding="utf-8"?><errorResponse> <code>1001</code> <msg>unkown error</msg> <args>

5、 <arg> <key>apiname</key> <value></value> </arg> <arg> <key>userLongId</key> <value>longid</value> </arg> <arg> <key>albumId</key> <value>123</value> </arg> </args></errorResponse>

6、 接口描述获得某个用户的相册列表系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v

7、 string 可选 接口版本号,要调用该版本请指定为1.0 ownerLongId string 可选 被查看者的用户长Id,如果提供该参数,则查看该用户的相册列表,需要进行隐私策略控制。 正常返回信息<?xml version="1.0" encoding="utf-8"?><album_getAlbumListResponse> <album> <albumId>BEld1NmEqXO8bqTcGPimKU</albumId> <albumName>lh</albumNa

8、me> <description>的是地方撒</description> <coverPhotoPath></coverPhotoPath> </album> <album> <albumId>8GZsCJIuqTeBYQCVEWi8Y0</albumId> <albumName>测试7</albumName> <description>777</description> <coverPhotoPath></coverPhoto

9、Path> </album></album_getAlbumListResponse>错误返回信息<?xml version="1.0" encoding="utf-8"?><errorResponse> <code>1001</code> <msg>unknown error</msg> <args> <arg> <key>apiname</key> <value></value>

10、 </arg> </args></errorResponse> 接口描述上传照片到用户的相册系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid

11、 string 必须 在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v string 可选 接口版本号,要调用该版本请指定为1.0 albumId string 必须 相册ID,如果没有指明相册类型则需要指明相册id photo byte 必须 上传照片的二进制数组,采用http的multipart协议 photoName string 可选 照片名称 createFeed boolean 可选 true:上传完后生成Feed。false:上传完成不生成Feed。默认为true。 photoNumber string 可选 本次上传的照片数量:1、2、.100 调用返

12、回信息<?xml version="1.0" encoding="utf-8" ?><album_uploadPhotoResponse><uploadResult><photoId>93cS63KvKvQA0-q5S3LvM8</photoId><albumId>Dg1nlSzR4mx8x5G6yHNIEe</albumId><longId>longid</longId></uploadResult></album_upload

13、PhotoResponse>错误时返回信息<?xml version="1.0" encoding="utf-8"?><errorResponse><code>2001</code><msg>The longId must not be empty</msg><args><arg><key>createFeed</key><value>false</value></arg><arg>

14、<key>photoContentType</key><value>image/pjpeg</value></arg><arg><key>photoFileName</key><value>照片.jpg</value></arg><arg><key>albumId</key><value>Dg1nlSzR4mx8x5G6yHNIEe</value></arg><arg><ke

15、y>sip_apiname</key><value></value></arg></args></errorResponse>app 应用更新通知等     (优先级:2)描述:space导航菜单上的用户应用通知,包含一个图标和数字,此接口用于更新用户在该应用上的个性化数据。如下图示:  输入:  系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 si

16、p_apiname string 必须 服务名。 sip_timestamp string 必须服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须在ISV应用中用户会话唯一标识。 应用级参数应用级参数名称 类型 是否必须 描述 v string 必须 接口版本号,要调用该版本请指定为1.0 userLongId string 必须 需要修改数据的用户id title string 必须 个性化显示的内容(一般是数字)

17、 icon string 必须 个性化内容的图标 成功返回 ID<?xml version="1.0" encoding="utf-8" ?><app_updateCustomDataResponse>2NSCU9NZKYb9baJq9Zprxz</app_updateCustomDataResponse> 错误时返回信息<error>     <errorCode></errorCode>    <

18、;errorMsg></errorMsg><error>错误码说明:101:参数不完整102:会话过期(session无效)msg 消息相关接口   1、app发送消息。app发送消息。  系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_si

19、gn string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v string 可选 接口版本号,要调用该版本请指定为1.0 type string 必须 消息类型 1-留言 2-动一下 3-好友邀请 4-应用消息 5-系统消息 content string 必须 内容 。只支持<a><img>两个html元素,其他的html元素及内容将被过虑。内容长度为2KB  to String 必须 消息接受

20、者  调用返回信息<?xml version="1.0" encoding="utf-8"?><msg_publishResponse>guisednessrqeisawxr3gyrgte</msg_publishResponse>错误时返回信息<?xml version="1.0" encoding="utf-8" ?><errorResponse>  <code>1004</code>  <m

21、sg>service invalid</msg>  <args>   <arg>  <key>sip_appkey</key>  <value>1002</value>  </arg>  <arg>  <key>sip_username</key>  <value>alicntaobao</value>  </arg>

22、60; <arg>  <key>sip_apiname</key>  <value></value>  </arg>  </args></errorResponse>2、更新用户的应用状态更新用户的应用状态  系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp st

23、ring 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV应用中用户会话唯一标识。   应用级参数名称 类型 是否必须 描述 v string 必须 接口版本号,要调用该版本请指定为1.0 content string 必须 app自定义的文本内容 ,最多100字符 appCmd string 可选 app自定义命令行(或URL) iconFile string 可选 显示插件开发商提供

24、的图片 ,只支持png格式 appType string 必须 app应用类型 1.音乐 2.影音视频 3.游戏 4.博客 5.书刊杂志 6.通用  调用返回信息 成功返回0<?xml version="1.0" encoding="utf-8" ?><app_updateUserStatusResponse/>错误时返回信息<?xml version="1.0" encoding="utf-8" ?> <errorResponse> 

25、<code>2003</code>  <msg>seesion is outdate or invalid</msg> <args>  <arg>       <key>sip_appkey</key>       <value>16116</value>  </arg>- <ar

26、g>      <key>appId</key>      <value>16116</value>  </arg>- <arg>      <key>apiName</key>      <value> </value>  </arg>&#

27、160; <arg>      <key>userLongId</key>      <value>cnalichnpwtest0006</value>  </arg>  <arg>       <key>sessionId</key>      <val

28、ue>d1a788902a2a83e5bd666e81a82aca2b</value>  </arg>  <arg>       <key>sip_apiname</key>      <value></value>   </arg>   <arg>    <key&g

29、t;v</key>    <value>1.0</value>    </arg>   </args></errorResponse> user  用户相关接口   查询space用户基本信息,当前提供以下内容:字段 说明 longID 包含有所属网站信息在内的用户旺旺ID username 用户姓名 sex 性别 age 年龄 birthday 生日 constellation 星座 interest 兴趣、爱好

30、 icons 用户头像(4种尺寸) 系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v st

31、ring 必须 接口版本号,要调用该版本请指定为1.0 queryLongId string 可选 如果不为空,查询该longId的信息  调用返回信息返回的信息字段要受用户设置的隐私控制。<?xml version="1.0" encoding="utf-8" ?> - <user_getProfileResponse>  <sex>M</sex> - <icons>  <icon_48></icon_48>  <icon_

32、120></icon_120>  <icon_64></icon_64>   <icon_24></icon_24>  </icons>  <userName>奎跃翔hqzy</userName>  <age>109</age><favorites><favorite>  <favoriteType>01</favoriteType> 

33、; <favoriteTagValue>体育</favoriteTagValue>  </favorite>- <favorite>  <favoriteType>02</favoriteType>  <favoriteTagValue>音乐</favoriteTagValue>  </favorite>- <favorite>  <favoriteType>04</favoriteType> 

34、; <favoriteTagValue>有意义的书</favoriteTagValue>  </favorite>- <favorite>  <favoriteType>05</favoriteType>  <favoriteTagValue>石狮市石狮市</favoriteTagValue>  </favorite>- <favorite>  <favoriteType>07</favoriteType&g

35、t;  <favoriteTagValue>石狮市</favoriteTagValue>  </favorite></favorites>  <constellation>11</constellation>  <longId>cnalichn0312hqzy</longId>  <birthday>1900-01-02 00:00:00</birthday></user_getProfileResponse>se

36、x:M 男 F 女错误时返回信息<?xml version="1.0" encoding="utf-8" ?><errorResponse>  <code>1004</code>  <msg>service invalid</msg>  <args>   <arg>  <key>sip_appkey</key>  <value>1002</value

37、>  </arg>  <arg>  <key>queryAppId</key>  <value>1002</value>  </arg>  <arg>  <key>sip_username</key>  <value>alicntaobao</value>  </arg>  <arg>  <key&

38、gt;sip_apiname</key>  <value></value>  </arg>  </args></errorResponse>2、批量查询space用户信息,当前提供以下内容:批量查询space用户信息,当前提供以下内容:字段 说明 username 用户姓名 sex 性别 constellation 星座 icons 用户头像(4种尺寸) 系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一

39、编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v string 必须 接口版本号,要调用该版本请指定为1.0 longIds string 必须 取longIds 的用户信息列表 ,多个以逗号","分隔,最

40、多50个 正常返回信息<user_getProfileResponse>     <sex>M</sex>     <icons>      <icon_48></icon_48>      <icon_120></icon_120>      <icon_64></icon_64&g

41、t;      <icon_16></icon_16>     </icons>     <userName>yuanwb</userName>     <constellation>2</constellation>     <longId>cnalichnyuanwb</longId></user_g

42、etProfileResponse>sex:M 男 F 女错误时返回信息<?xml version="1.0" encoding="utf-8" ?><errorResponse>  <code>1004</code>  <msg>service invalid</msg>  <args>   <arg>  <key>sip_appkey</key>  <

43、value>1002</value>  </arg>  <arg>  <key>queryAppId</key>  <value>1002</value>  </arg>  <arg>  <key>sip_username</key>  <value>alicntaobao</value>  </arg>  <

44、;arg>  <key>sip_apiname</key>  <value></value>  </arg>  </args></errorResponse>feed   Feed相关接口发布一个Feed,该接口发布的Feed将保存在数据库中,如果wwFeedType不为空,则会发送客户端Feed更新的通知。系统级参数名称类型是否必须描述sip_appkeystring必须ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。sip_

45、apinamestring必须服务名。sip_timestampstring必须服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。sip_signstring必须请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。sip_sessionidstring必须在ISV应用中用户会话唯一标识。应用级参数名称类型是否必须描述vstring必须接口版本号,要调用该版本请指定为1.0appIconstring可选应用图标文件名,放到SNSWEB,同一个应用多个ICONappIconLinkstring可选应用图标上的连接participatorstring可选如果

46、Feed的内容描述的是两人之间发生的关系,则用这个参数指明被参与的一方。注:Feed的发起方不需要指定,默认为当前用户。titlestring必须feed标题在title里可以使用$ actor和$participator模板变量,其中$actor 表示产生Feed的人,$ participator表示动态的参与者,如果要使用这个模板变量需要传递participator参数。使用示例: $actor踢了$participator 一下。 在例子中,动态展示时,系统会将$ actor及$participator替换成相应的人名。没有链接。html元素将被过滤掉。 titleLinkstring可

47、选标题链接bodystring必须动态显示的内容数据。在body里可以使用$actor和$participator模板变量,其中$actor表示产生Feed的人,$participator 表示动态的参与者,如果要使用这个模板变量需要传递participator参数。使用示例:$actor踢了$participator一下。 在例子中,动态展示时,系统会将$actor及$participator替换成相应的人名,并加上对应主页的连接地址。 只支持两个html元素<a>和<img>,其他的html元素将被过滤掉。 script、style、head、select标签的内容

48、被去掉。其他的标签保留内容 如:<script>alert</script>和<font>红色</font> 结果为:红色appFeedTypestring可选应用自己定义的Feed类型,应用可以根据这个类型自己对Feed进行分类。mediasstring可选媒体对象的数据,用json格式表示。 mediaType:0:图片,1:音频,2:flash 。 其中media是媒体对象的图片地址,mediaLink是点击媒体对象 时候的目标URL 。 "mediaName":"baobei","medi

49、a":"media src","mediaLink":"mdedia link","mediaDesc":"","mediaType":"0" , "mediaName":"baobei","media":"media src","mediaLink":"mdedia link","mediaDesc":&q

50、uot;","mediaType":"0" wwOnlyNotifystring可选是否只通知ww但不保存数据。true:通知旺旺,不保存。false:保存Feed,如果wwFeedTypes不为空,则同时通知旺旺。默认是false。wwTitlestring可选在旺旺中显示动态时的标题数据,不能包含html文件。wwTitleLinkstring可选在旺旺中显示的标题连接。wwFeedTypesstring可选动态在旺旺上的显示类型,如果多个则用逗号分隔。0:主窗口Feed,1:聊天窗口Feed,2:联系人头像前的Feed。 -,3:签名区F

51、eed-.  当wwFeedTypes 不为空,titleLink 不能为空。调用返回信息feedId<?xml version="1.0" encoding="utf-8" ?><feed_publishResponse>9JYECM-raSNBS22MR-gtQr</feed_publishResponse>查询Feed接口,返回符合条件的feed列表。 系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV应用的唯一编

52、号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须在ISV应用中用户会话唯一标识。   应用级参数名称 类型 是否必须 描述 v string 可选 接口版本号,要调用该版本请指定为1.0 appFeedType string 可选 feed类型 queryAppId string 可选 产生feed的

53、app,如果查多个以逗号分隔如1001,1002 queryUserLongId string 可选 查询目标用户的longId,默认为查询当前用户的。根据用户的隐私控制策略,返回相应的Feed。 gmtStart string 可选 查询feed的开始时间。格式为:yyyy-mm-dd hi24:mi:ss gmtEnd string 可选 查询feed的结束时间 。格式为:yyyy-mm-dd hi24:mi:ss start int 可选 查询开始条数,默认是0 pageCount int 可选 需要返回的条数。默认是10条。 最大50  调用返回信息   

54、<?xml version="1.0" encoding="utf-8" ?> <feed_queryResponse><feed>  <feedId>2KtiruZNKE-87WwnZMvfT_</feedId>  <site />  <longId>alicntaobao</longId>  <participator />  <appId>1002</appId&g

55、t;  <appIcon />  <appIconLink />  <appFeedType />  <title><a href="" ></a>donglewoyixia</title>  <body />  <mediaList />  <gmtCreate>2009-05-19 14:59:14</gmtCreate>  <wwTitle />&

56、#160; <wwTitleLink />  <wwFeedType />  </feed><feed>  <feedId>9DfgrNpzKQr9ExcqPmQvfx</feedId>  <site />  <longId>alicntaobao</longId>  <participator />  <appId>1001</appId>  <appIcon /&

57、gt;  <appIconLink />  <appFeedType />  <title><a href="" ></a>donglewoyixia</title>  <body />  <mediaList />  <wwTitle />  <wwTitleLink />  <wwFeedType />  </feed>  <

58、;/feed_queryResponse>错误时返回信息<?xml version="1.0" encoding="utf-8" ?><errorResponse>  <code>1004</code>  <msg>service invalid</msg>  <args>   <arg>  <key>sip_appkey</key>  <value>

59、;1002</value>  </arg>  <arg>  <key>queryAppId</key>  <value>1002</value>  </arg>  <arg>  <key>sip_username</key>  <value>alicntaobao</value>  </arg>  <arg>

60、  <key>sip_apiname</key>  <value></value>  </arg>  </args></errorResponse>错误码说明:101:参数不完整102:会话过期(session无效)friends   - 好友相关接口    获取好友列表  系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软件互联平台分配给ISV

61、应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v string 必须 接口版本号,要调用该版本请指定为1.0  调用返回信息<?xml version="1.0" encoding=&

62、quot;utf-8"?><friends_getFriendListResponse>  <friend>    <userId>cnalichn000037</userId>    <spaceUserName>000037</spaceUserName>  </friend>  <friend>    <userId>cnalichn000037&

63、lt;/userId>    <spaceUserName>000037</spaceUserName>  </friend></friends_getFriendListResponse>poke -"动一下"动作接口      1、获得默认的动作列表接口描述获得默认的动作列表,如果列表为空,只返回根节点系统级参数名称 类型 是否必须 描述 sip_appkey string 必须 ISV应用的appkey为软

64、件互联平台分配给ISV应用的唯一编号。 sip_apiname string 必须 服务名。 sip_timestamp string 必须 服务请求时间戳(yyyy-mm-dd hh:mm:ss.xxx),支持毫秒。 sip_sign string 必须 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 sip_sessionid string 必须 在ISV应用中用户会话唯一标识。 应用级参数名称 类型 是否必须 描述 v string 可选 接口版本号,要调用该版本请指定为1.0 正常返回信息<?xml version="1.0" encod

65、ing="utf-8"?><poke_getPokeInfoListResponse><pokeInfo><pokeInfoId>1</pokeInfoId><pokeName>弹鸡鸡</pokeName><pokeImgPath>/module/face_1.gif</pokeImgPath></pokeInfo><pokeInfo><pokeInfoId>2</pokeInfoId><pokeName>偷吻&l

66、t;/pokeName><pokeImgPath>/module/face_1.gif</pokeImgPath></pokeInfo></poke_getPokeInfoListResponse>错误返回信息<?xml version="1.0" encoding="utf-8"?><errorResponse><code>1001</code><msg>unkown error</msg><args><arg><key>apiname</key>&l

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论