The first step to accessing our system is to find out who's online. Rather than force your system to constantly query ours to define this information, our API sends out this information in real time as performers log in and out of our system or change status by going on break, entering a show or changing any of their room information.
You can view how to configure your webservice to accept this information here.
If for any reason your system needs to get a full listing of all performers online for a given service, you may also GET the following URL:
| [API]/performers?key=[KEY]&service=[SERVICE] |
| Name | Required | Type | Description |
|---|---|---|---|
| key | Yes | string | Supplied by VS. Please ask us for your key. |
| service | Yes | string | Must be girls, guys or trans. Defaults to girls. |
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: [int]
{
success: true,
message: "",
data: [
{
performerId: [id],
performerName: [name],
performerCategory: [string],
score: [int],
roomType: Standard | MultiUser | Combo | Party Chat,
roomState: inOpen | onBreak | inShow,
roomTopic: [category],
showTypes:
{
[SHOWTYPE]: [cpm],
[SHOWTYPE]: [cpm],
(The number of show types available at any time will vary and may be zero. Paid shows are not possible for performers using the Party room type.)
},
video: {
width: [width],
height: [height],
flash: [
{
provider: [name],
connectUrl: [url],
streamName: [name],
auth: [string]
},
{
provider: [name],
connectUrl: [url],
streamName: [name],
auth: [string],
}
],
hls: [
[url],
[url]
]
},
filters: {
countries: { [country], [country], etc.. },
states: { [state], [state], etc... },
ips: { [ip], [ip], etc... }
},
lastUpdated: [timestamp]
},
...
]
}
| Name | Description |
|---|---|
| success | Whether or not your post was successful. |
| message | An error message if success is false. |
| data | The requested data, if any. |