Our API sends out performer status 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.
For this service, you will need to provide your account manager with a fully qualified URL which can accept the following messages via raw post data:
POST [YOUR_API_URI] HTTP/1.1 Host: [YOUR_API_HOST] Content-Type: text/xml; charset=utf-8 Content-Length: [int] { function: performerStatus, action: online | offline | change, performerId: [id], performerName: [name], performerCategory: [string], roomType: Standard | MultiUser | Combo | Party Chat, roomState: inOpen | onBreak | inShow, roomTopic: [string], 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: flash: { connectUrl: [url], streamName: [name] }, hls: [url] }, filters: { countries: [country], [country] , states: [], ips: [] }, service: [string], lastUpdated: [timestamp] }
You should then respond with true if you were able to handle the request or false if the command was not valid. Do not return false if you were unable to process each update for any reason. Only return false if the data did not appear to be valid.
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: [int] { success: true | false message: [string] }
Name | Description |
---|---|
success | Whether or not your request was allowed. |
message | An error message if success is false. |