View source for API/host list feed

=Overview=

This API provides means for accessing and manipulating the ImLive hosts and guests resources.


=Description=

Return detailed list of online webcam hosts.


=Request URL=
There are two feed URLs, one returns XML with host details and the second is an RSS feed.

The WL site should pull one of these feeds, parse it and render the hosts page from it.

'''<u>Note:</u>''' These feeds are updated every 30 seconds. For the sake of site performance, it is strongly advised that the white label site will cache the returned data for 30 seconds and '''<u>will not</u>''' request the feed upon each page request.

On the other hand, it is not advised to cache the data for longer than 1 minute since hosts status may change during that time and hosts that are presented in the list as available, may no longer be available.
==XML Feed==
[http://feeds.webcamwiz.com/live-sex.xml feeds.webcamwiz.com/live-sex.xml]

==RSS Feed==

[http://feeds.webcamwiz.com/live-sex.rss feeds.webcamwiz.com/live-sex.rss]


=Parameters=

{| class="wikitable"
|
'''Name'''

|
'''Description '''

|
'''Max length'''

|
'''Type'''

|
'''Mandatory'''

|
'''Comment'''

|-

|
wid

|
sponsorID*12345

|


|
Integer

|
Y

|
The affiliates WID

|-
|
itemcount

|
number of hosts to return

|


|
Integer

|
Y

|
Not capped

|-
|
queryID

|
Hosts niche selection

|


|
Integer

|
Y

|
Supports multiple query IDs in a comma delimited list



Amateurs=1 or 138

Lesbians=2

Asians=3

Black=4

Fetish=5

Tranny=6

Couples=7

Guys=8

Boobs=9

BBW=10

MILF=11

Co-eds=12

Latina=103

|-
|
promocode

|
Additional tracking tag

|
50

|
String

|
N

|
Custom affiliate tracking code

|-
|
cid

|
Landing page selection

|


|
Integer

|
Y

|
8 = random free chat

10 = specific host free chat

13 = free chat gallery

|-
|
ptype

|
Affiliation program type

|


|
Integer

|
Y

|
1 = revshare

2 = PPS

|-
|
baseurl

|
Affiliate site domain

|


|
String

|
Y

|


|-
|
freeonly

|
Prioritize host that are in free chat

|


|
Integer

|
N

|
1 = Place free chat hosts in the top of the list

|-
|
iw

|
Host thumbnail image width

|


|
Integer

|
N

|
In pixels.

Note that image width/height ratio must be 4:3

|-
|
ih

|
Host thumbnail image height

|


|
Integer

|
N

|
In pixels

Note that image width/height ratio must be 4:3

|-
|
addimages

|
Return more images per host

|


|
Integer

|
N

|
1 is the default, max value is 5

|-
|
freeonly

|
Show only flc hosts

|


|
Integer

|
N

|
0 is the default, 1 returns only flc hosts

|-
|
attributes

|
Output as elements or attributes

|


|
Integer

|
N

|
1 is the default, returns MXL output as attributes. 0 returns XML output as elements.

|}

=Request Example=
[http://feeds.webcamwiz.com/Live-Sex.xml?wid=12345&ItemCount=5&QueryID=138&promocode=BCODEL0000053_00000&cid=10&wlbl=1&baseurl=qatest.com&ptype=1 feeds.webcamwiz.com/Live-Sex.xml?wid=12345&ItemCount=5&QueryID=138&promocode=BCODEL0000053_00000&cid=10&wlbl=1&baseurl=qatest.com&ptype=1]

=Response Data=

The response is returned in XML format, containing list of hosts.

For each host, the following information is provided:

{| class="wikitable"
|-
|
'''Field'''

|
'''Type'''

|
'''Description'''

|-
|
NickName

|
String

|
Host nickname

|-
|
BHID

|
Integer

|
Host ID

|-
|
Online

|
String

|
Online yes/no

|-
|
Description

|
String

|
Description/BIO

|-
|
Expertise

|
String

|
Host expertise

|-
|
Build

|
String

|
Female: Petite, Slender, Muscular, Curvy, Healthy, BBW

Male: Twinks (+18), Jocks, Muscle gods, Bears, Chubs, BBW, Otters

Shemale: Slender, Athletic, Healthy, Bear

|-
|
Measurements

|
String

|
Example: 92-65-95

|-
|
Age

|
Integer

|
Host age

|-
|
Room

|
String

|
Options: Girl Alone, Shy Girl Alone, Girl Alone (Lesbian), Girl on Girl, Fetish & BDSM, Shemales, Guy Alone (Straight), Guy Alone (Gay), Guy on Guy, Girl and Guy (Couples), Threesomes/Groups, Shemale Couples, Celebrity Porn Stars

|-
|
SeoRoomName

|
String

|


|-
|
SexualPreferences

|
String

|
Straight, Bisexual, Gay, Lesbian, TS

|-
|
EyeColor

|
String

|
Black, Brown, Gray, Blue, Green

|-
|
HostPicture

|
String

|
Example: <nowiki>http://i3.gatewayinterface.com/imagesrv/imp_getimage?qu=77&mark=1&cctrl=public</nowiki>, max-age%3d2592000&is=imlfoh&wm=0&wi=423&hi=343&fn=0204/1012204<nowiki>/1012204O1391498116.jp</nowiki>g

|-
|
PictureHeight

|
Integer

|
Picture Height in pixels

|-
|
PictureWidth

|
Integer

|
Picture Width in pixels

|-
|
TotalPhotos

|
Integer

|
Number of photos

|-
|
TotalVideos

|
Integer

|
Number of videos

|-
|
Stars

|
Integer

|
Rating 1-5

|-
|
AboutMe

|
String

|
Short description

|-
|
TurnsOn

|
String

|
what the host states as turn-on

|-
|
TurnsOff

|
String

|
what the host states as turnoff

|-
|
Gender

|
String

|
Female, Male, Androgynous, Intersex, Pangender, Transgender, Other

|-
|
CupSize

|
String

|
a = Small, b = Medium, c = Medium, d = Big, dd (e) = Huge, ddd (f) = Huge, HUGE = Huge

|-
|
HairColor

|
String

|
Straight: Black, Brown, Gray, Blonde, Red, White, Auburn

Gay: Black, Brown, Silver, Blonde, Red, White, Auburn, Bald

|-
|
HairLength

|
String

|
Short, Medium, Long

|-
|
Ethnicity

|
String

|
Straight: Caucasian, Afro-American/Black, Hispanic, Asian, Arab, Mediterranean, Other, Indian

Gay: Caucasian, Ebony, Latino, Asian, Arab, Mediterranean, Other, Indian

|-
|
Height

|
String

|
Less than 5' ( - 1.5m), <nowiki>5' - 5'4'' (1.5 - 1.6m)</nowiki>, <nowiki>5'4'' - 5'8'' (1.6 - 1.7m)</nowiki>, <nowiki>5'8'' - 6' (1.7 - 1.8m)</nowiki>, <nowiki>6' - 6'4'' (1.8 - 1.9m)</nowiki>, <nowiki>6'4'' - 6'8'' (1.9 - 2.0m)</nowiki>, <nowiki>Over 6'8'' (2.0m - )</nowiki>, 

|-
|
Weight

|
String

|
under 100 lbs (under 45 kg), 100-110 lbs (46-50 kg), 111-121 lbs (51-55 kg), 122-132 lbs (56-60 kg), 133-143 lbs (61-65 kg), 144-154 lbs (66-70 kg), 155-165 lbs (71-75 kg), 166-176 lbs (76-80 kg), 177-187 lbs (81-85 kg), 188-199 lbs (86-90 kg), over 200 lbs (over 90 kg) , 

|-
|
Kinkies

|
String

|
Piercings, Tattoos, Shaved, Hairy, Branded

|-
|
ToysOrProps

|
String

|
Description of toys or props that the host use

|-
|
Languages

|
String

|
English, Italian, French, German, Spanish, Tagalog, Chinese, Arabic, Romanian, Russian, Hebrew, Dutch, Greek, Portuguese, Japanese, Korean, Hindi, Hungarian, Polish, Norwegian, Swedish, Turkish, Bulgarian, Czech, Thai, Vietnamese, Danish, Punjabi

|-
|
FreeSupported

|
Integer

|
If the host is in free live chat, 0 – no, 1 – yes

|-
|
HostLink

|
String

|
Direct link to the host

|-
|
NicheID

|
Integer

|
<nowiki>= queryID</nowiki>

|}

= Host List Functionality =
The developer can select what action to take when clicking on a host thumnail inthe rendered gallery page.

Possibilities are:
# Open the host profile (this is the only action available when the host is online).
# Open the host chat room as an iframe (if the host is online).
# Redirect to the Webcamwiz white label to the hosts profile or chat room.

In order to redirect, the following links should be constructed:
* '''Host profile''': http://<domain>/live-sex-chat/<SeoRoomName>/<NickName>
* '''Host free chat room''': http://<domain>/free-videochat/<NickName>
* '''Host private chat room''': http://<domain>/waitingroom/<NickName>
'''<u>Note:</u>''' When redirecting to the host's private chat room, the user must first be logged in. If not then it is automatically redirected to the host profile.