7/31/2019 Srs Wap Rev3.2
1/30
1Detail Design Specifications: WAP_Rev3.2
FWAP Specification
Author: Prapaporn Lertsomporn
Date: 11/6/2555
Project: WAP
Document: WAP Specification
Version: 3.2
Project Manager:
Date
Approved By :
Date
Approved By:
Date
Please note that the signoff and approval of the SRS needs to occur before development commences as this is
an essential milestone in Trues internal process flow consistent with ISO training and certification.
7/31/2019 Srs Wap Rev3.2
2/30
2Detail Design Specifications: WAP_Rev3.2
WAP API Specification
Project: WAP
Prepared Date:11 2555By
Prapaporn Lertsomporn
Version Number:3.2
ATTENTION! DO NOT REMOVE THIS NOTICE!
This material was originated by personnel performing work related to Utility Business Alliance. Part or all of this
information may constitute sensitive client confidential and/or proprietary material. All use of the information
contained within must conform to the True Code of Professional Ethics.
True reserves the right to use and continue to use Documentation created in the performance of this Agreement.
mailto:[email protected]:[email protected]:[email protected]7/31/2019 Srs Wap Rev3.2
3/30
3Detail Design Specifications: WAP_Rev3.2
Revision History
Revision Date Description of Change Author1 29/5/2555 Create API doc Prapaporn Lertsomporn
1.1 31/5/2555 Add Social,setStatus Prapaporn Lertsomporn
2 1/6/2555 Update doc follow requirement Prapaporn Lertsomporn
2.1 1/6/2555 Delete Group Prapaporn Lertsomporn
2.2 6/6/2555 Add Client ip field Prapaporn Lertsomporn
3 8/6/2555 Add PM Prapaporn Lertsomporn
3.1 11/6/2555 Add URL of PM Prapaporn Lertsomporn
3.2 11/6/2555 Add MultilsFriend Prapaporn Lertsomporn
Please note that each EXTERNAL update will change the revision increment by 1.0 as this is an essential
milestone in Trues internal process flow consistent with ISO training and certification.
7/31/2019 Srs Wap Rev3.2
4/30
4Detail Design Specifications: WAP_Rev3.2
Table of Contents
WAP API ....................................................................................................................................................................................... 5
1. Setting Page ..................................................................................................................................................................... 5
2. Social Page .................................................................................................................................................................... 11
3. My Stuff ......................................................................................................................................................................... 14
4. Friend ............................................................................................................................................................................. 17
5. Comment ....................................................................................................................................................................... 21
6. Like ................................................................................................................................................................................ 23
7. PM .................................................................................................................................................................................. 26
7/31/2019 Srs Wap Rev3.2
5/30
5Detail Design Specifications: WAP_Rev3.2
WAP API
1. Setting Page1.1 Profile Feed
Method : get
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
user_id None None Ids user
access_token None None Access tokens user
Remark : user_id user_id = {user-id},{user-id}
1.2 ProfileRequest URL : http://api.mylife.truelife.com/users/profile/profile.xml?user_id= {user-id}
{user-id} = id wall
output
http://api.mylife.truelife.com/users/profile/profile.xml?user_id=%7buser-id%7dhttp://api.mylife.truelife.com/users/profile/profile.xml?user_id=%7buser-id%7dhttp://api.mylife.truelife.com/users/profile/profile.xml?user_id=%7buser-id%7dhttp://api.mylife.truelife.com/users/profile/profile.xml?user_id=%7buser-id%7d7/31/2019 Srs Wap Rev3.2
6/30
6Detail Design Specifications: WAP_Rev3.2
7/31/2019 Srs Wap Rev3.2
7/30
7Detail Design Specifications: WAP_Rev3.2
1.3 updateProfileHTTP :
http://api.uprofile.truelife.com/apis/rest/users?method=updateProfile&apiKey= {apiKey}&uid={uid}&access_
token={access_token}&first_name={first_name}&lastname={last_name}&gender={gender}&birthday={bi
rthday}&ip={ip}
Parameters :
Varname Type Description required
apiKey text Api key *
client_ip Int IP addresss client *
uid int Ids user *
access_token text Access token *
first_name text First name *
last_name text Last name *
gender text Gender *
birthday text Birthday *
ip text IP Address *
displayname text Display name
avatar text Avatar
mobile_contact text Mobile number
1.4 setStatusHTTP :
http://api.sfeature.truelife.com/apis/rest/status?method=setStatus&apiKey= {apiKey}&user_id={user_id}&fri
end_id={friend_id}&msg={message}&status_type=text&share_content={share_content}
Parameters :
Varname Type Description required Default
apiKey text Api Key *
client_ip int IP addresss client *
user_id int User id *
friend_id int Ids user which post *
7/31/2019 Srs Wap Rev3.2
8/30
8Detail Design Specifications: WAP_Rev3.2
msg text Message *
privacy_id int Privacy id 1
allow_comment int Allow comment 3
parent_id int Status id of shared data 0
link_url text Detail url link
link_type text Link type
link_own_url text Detail of own link
link_thumb_url text Detail of thumb link
link_resource text Detail of resource link
link_title text Detail of title link
link_content text Detail content link
tag text Tag
cate_id text Life style id 0
sub_cate_id text Sub life style id 0
content_group int Content group id 0
lat float Latitude 0.00
lon float Longitude 0.00
place_id int Place id 0
share_content text Post by fb=1 or tw=2
separate bypipe
null
status_type text text,link,location text
activity_log_data text Log record (data is
json format and more
detail in json format
below)
Output Variable
Varname Type Description
id int Inserted status id
user_id int User id
7/31/2019 Srs Wap Rev3.2
9/30
9Detail Design Specifications: WAP_Rev3.2
channel_type text Channel type
create_date text Crate date
friend_id int User id of poster
msg text Message
tag text Tag
status int Status
status_type text Status type
privacy_id int Privacy id
allow_comment int Permission to comment
attach int If link_url and link_type have value will return 1 else 0
parent_id int Ids status which shared
link_url text Detail url link
link_type text Link type
link_own_url text Detail of own link
link_thumb_url text Detail of thumb link
link_resource text Detail of resource link
link_title text Detail of title link
link_content text Detail content link
cate_id int Life style id
sub_cate_id int Sub life style id
content_group int Content group id
lat float Latitude
lon float Longitude
place_id int Place id
theone_link text Link back to theone
7/31/2019 Srs Wap Rev3.2
10/30
10Detail Design Specifications: WAP_Rev3.2
output
1.5 SocialHTTP: http://api.mylife.truelife.com/setting/setting.xml?group=social&user_id={user_id}
{user_id} = id wall
output
7/31/2019 Srs Wap Rev3.2
11/30
11Detail Design Specifications: WAP_Rev3.2
2. Social Page2.1 Wall
HTTP Method : get
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type home home, profile,
group, nearest
user_id none
access_token none
start 0
limit 0
Remark : type : group Parameters
Fields Default Value Options Description
group_id none none
Remark : type : nearest Parameters
Fields Default Value Options Description
lat 0 none
lon 0 none
7/31/2019 Srs Wap Rev3.2
12/30
12Detail Design Specifications: WAP_Rev3.2
2.2 Wall Request URL :
http://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token= {access_token}&type={type}
{user-id} = id wall output
http://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token=%7baccess_token%7d&type=%7btype%7dhttp://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token=%7baccess_token%7d&type=%7btype%7dhttp://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token=%7baccess_token%7d&type=%7btype%7dhttp://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token=%7baccess_token%7d&type=%7btype%7dhttp://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token=%7baccess_token%7d&type=%7btype%7dhttp://api.mylife.truelife.com/wall/wall.xml?user_id=392001&access_token=%7baccess_token%7d&type=%7btype%7d7/31/2019 Srs Wap Rev3.2
13/30
13Detail Design Specifications: WAP_Rev3.2
2.3 Wall Request URL :
http://api.mylife.truelife.com/wall/wall.xml?user_id= {user_id}&access_token={access_token}&type={type}
7/31/2019 Srs Wap Rev3.2
14/30
14Detail Design Specifications: WAP_Rev3.2
3. My Stuff3.1 Content
Method : get
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type none status, link, article,
media, photo_albums,
photos, product,
custom
access_token none none
Remark : List Parameters (type : status,link)
Fields Default Value Options Description
user_id none none
start 0 none
limit 0 none
Remark : Detail Parameters
Fields Default Value Options Description
id 0 none
Remark : Bulk Detail Parameters type : custom
Fields Default Value Options Description
type_direct 0 0, 1 type
convert type wrapper
multivalue none Status:13442,photo:334 Format Multi value
7/31/2019 Srs Wap Rev3.2
15/30
15Detail Design Specifications: WAP_Rev3.2
Remark : Photos List Parameters type : photos
Fields Default Value Options Description
album_id 0 none
3.2 Content Photos List By AlbumRequest URL :http://api.mylife.truelife.com/content/content.xml?type=photos&album_id= {album_id}&user_id={user_id}&access_token=
{access_token} output
http://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/content/content.xml?type=photos&album_id=%7balbum_id%7d&user_id=%7buser_id%7d&access_token=%7baccess_token%7d7/31/2019 Srs Wap Rev3.2
16/30
16Detail Design Specifications: WAP_Rev3.2
3.3 Request URL :http://api.sfeature.truelife.com/apis/rest/socialnetwork?method=setPublishSocialNetwork&apiKey= {apiKey}&ref_type={ref
_type}&ref_id={ref_id}&social_network_id={social_network_id}
Parameters :
output
Varname Type Description Required Default
apiKey text Api Key *
client_ip int IP addresss client *
ref_type text Reference type *
ref_id text Reference id *
social_network_id int See look up : Social
network
*
user_id int User id 0
activity_log_data text Log record (data is
json format and
more detail in json
format below)
7/31/2019 Srs Wap Rev3.2
17/30
17Detail Design Specifications: WAP_Rev3.2
4. Friend4.1 My Friend
Method : get
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type my my, profile, search,
suggest, request
access_token none none
page 0 none
limit 0 none
Remark : type : profile Parameters
Fields Default Value Options Description
user_id none none
Remark : type : search Parameters
Fields Default Value Options Description
channel mylife email, mylife,
friend
Remark : type : search channel : email Parameters
Fields Default Value Options Description
email none none
password none none
provider none none
7/31/2019 Srs Wap Rev3.2
18/30
18Detail Design Specifications: WAP_Rev3.2
Remark : type : search channel : mylife Parameters
Fields Default Value Options Description
email none none
gender none none
birth none none
age_min none none
age_max none none
Request URL : http://api.mylife.truelife.com/friends/friend.xml?type={type}&access_token={access_token}&channel={e-
mail}
output
7/31/2019 Srs Wap Rev3.2
19/30
19Detail Design Specifications: WAP_Rev3.2
4.2 Add FriendMethod : post
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type add add, accept, ignore
user_id none none User, ,
access_token none none
Remark : type : accept
type : ignore
Request URL : http://api.mylife.truelife.com/friends/friend.json
4.3 Delete FriendMethod : Delete
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
user_id none none
access_token none none
Request URL : http://api.mylife.truelife.com/friends/friend.json
7/31/2019 Srs Wap Rev3.2
20/30
20Detail Design Specifications: WAP_Rev3.2
4.4 getMultilsFriendRequest URL :http://api.uprofile.truelife.com/apis/rest/friends/?method=getMultiIsFriend&apiKey= {apiKey}&user_id={user_id}&dat
a={data}
Parameters :
output
Varname Type Description Required Default
apiKey text Api Key *
client_ip int IP addresss client *
user_id int Ids user *
data text List of friend user
id(separate by |)
*
7/31/2019 Srs Wap Rev3.2
21/30
21Detail Design Specifications: WAP_Rev3.2
5. Comment5.1 Comment
Method : get
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type none status, link, article,
media, photo_album,
photo, product,
ext_content
id 0 none
access_token none none
start 0 none
limit 0 none
Remark : product Parameters
Fields Default Value Options Description
group none article,
article_digital,
photo_digital,
audio_digital,
media_digital
Request URL : http://api.mylife.truelife.com/comment/comment.xml?type=status&id= {id}&access_token={access_token}
http://api.mylife.truelife.com/comment/comment.xml?type=status&id=%7bid%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/comment/comment.xml?type=status&id=%7bid%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/comment/comment.xml?type=status&id=%7bid%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/comment/comment.xml?type=status&id=%7bid%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/comment/comment.xml?type=status&id=%7bid%7d&access_token=%7baccess_token%7dhttp://api.mylife.truelife.com/comment/comment.xml?type=status&id=%7bid%7d&access_token=%7baccess_token%7d7/31/2019 Srs Wap Rev3.2
22/30
22Detail Design Specifications: WAP_Rev3.2
output
5.2
Add commentMethod : post
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type none status, link, article,
media, photo_album,
photo, product,
ext_content
id none none type: ext_contentfield
message none none
lat none none
lon none none
access_token none none
7/31/2019 Srs Wap Rev3.2
23/30
23Detail Design Specifications: WAP_Rev3.2
Remark : product Parameters
Fields Default Value Options Description
group none article,
article_digital,
photo_digital,
audio_digital,
media_digital
Remark : ext_content Parameters
Fields Default Value Options Description
ext_key none none
ext_type none none
ext_field none {url: URL content, thumbnail:
mylife}
jsonformat
title none none
description none none
Request URL :http://api.mylife.truelife.com/comment/comment.json 6. Like
6.1 set likeMethod : post
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type none status, link, article,
media, photo_album,
photo, product,
7/31/2019 Srs Wap Rev3.2
24/30
24Detail Design Specifications: WAP_Rev3.2
ext_content
id none none type: ext_contentfield
access_token none none
Remark : type : product Parameters Fields Default Value Options Description
group none article,
article_digital,
photo_digital,
audio_digital,
media_digital
Remark : type : ext_content Parameters Fields Default Value Options Description
ext_key none none
ext_type none none
ext_field none {url: URL
content ,thumbnail: mylife}
json
format
title none none
description none none
Request URL :http://api.mylife.truelife.com/like/like.json
7/31/2019 Srs Wap Rev3.2
25/30
25Detail Design Specifications: WAP_Rev3.2
6.2 UnLikeMethod : Delete
Resource Formats : application/json
Parameters :
Fields Default Value Options Description
type none status, link, article,
media, photo_album,
photo, product,
ext_content
id none none type: ext_contentfield
access_token none none
Remark : type : product Parameters Fields Default Value Options Description
group none article,
article_digital,
photo_digital,
audio_digital,media_digital
Remark : type : ext_content Parameters Fields Default Value Options Description
ext_key none none
Request URL :api.mylife.truelife.com/like/like.json
7/31/2019 Srs Wap Rev3.2
26/30
26Detail Design Specifications: WAP_Rev3.2
7. PM7.1 PM List Inbox
Method : get_pm_group_by_friend
HTTP:
http://sv.chat.truelife.com/pm2/?method=get_pm_group_by_friend&user_id= {user_id}&channel={channel}
&page_no={page_no}&page_size={page_size}
Resource Formats : application/json
Parameters :
Varname Type Description Required Default
user_id int ID of user *
channel text Channel of
client[iphone,bb,android,web,wap]
*
reverse_item Flag to reverse sort item
page_no int Number of page
page_size int Size of page
format text Response format(xml,json)
cache int Flag clear cache(0=Clear cache)
7/31/2019 Srs Wap Rev3.2
27/30
27Detail Design Specifications: WAP_Rev3.2
output
7/31/2019 Srs Wap Rev3.2
28/30
28Detail Design Specifications: WAP_Rev3.2
7.2 PM 2 userMethod : get_pm
HTTP:
http://sv.chat.truelife.com/pm2/?method=get_pm&user_id= {user_id}&sort_by={sort_by}&channel={channe
l}
Resource Formats : application/json
Parameters :
Varname Type Description Required Default
user_id int Id of user *
friend_id int Id of friend *
channel text Channel of
client[iphone,bb,android,web,wap]
*
folder text Folder of PM[sent,inbox]
status Status of PM[read,unread]
sort_by text Sort PM by
[date,date_asc,subject,user]
last_id int Last PM ID to get PM
page_no int Number of page
page_size int Size of page
reverse_item text Flag to
client[iphone,bb,android,web,wap]
format text Response format(xml/json)
cache int Flag clear cache(0=Clear cache)
7/31/2019 Srs Wap Rev3.2
29/30
29Detail Design Specifications: WAP_Rev3.2
output
7.3 PM 2 userMethod : send_pm
HTTP:
http://sv.chat.truelife.com/pm2/?method=send_pm&user_id= {user_id}&friend_id={friend_id}&send_type={
send_type}&msg={msg}&channel={channel}
Resource Formats : application/json
Parameters :
Varname Type Description Required Default
user_id int Id of user *
friend_id int Id of friend *
send_type text Type of send[send,reply]
subject text Subject of PM
msg text Text message of PM
media_type text Type of media(photo/video)
media_url text url of media
7/31/2019 Srs Wap Rev3.2
30/30
output
media_surl text Short URL of media
sender_msisdn int Mobile number of sender
sender_displayname text Display name of sender *
recipient_displayname text Displayname of recipient
channel text Channel of
client[iphone,bb,android,web,wap]
*
format text Response format(xml/json) *
Top Related