/show

Logging into, out of and maintaining a show requires the use of the following messages:

• Login message
• Ready message
• Logout message

1. Login Message

This message should be sent as soon as a customer indicates that they would like to start a show. If successful, this method causes the API to lock the performer's room for a small period of time, allowing you to transition the customer into a "show" room, if applicable. Once the customer has been transitioned, you will need to send the Ready Message.

POST /show?key=[KEY] HTTP/1.1
    Host: [API]:80
    
    function=showLogin
      &performerId=[id]
      &customerId=[id]
      &nickname=[nickname]
      &showType=[SHOWTYPE]
      &showRate=[cpm]
    

NOTE: The post variables should all be on 1 line. We have separated them here for visual clarity only.

Parameters

Once this request is received the API will verify that all information is valid and will return true or false based on whether the user can enter the show.

Example Response

HTTP/1.1 200 OK
    Content-Type: text/xml; charset=utf-8
    Content-Length: [int]
    
    {
        success: true | false
        message: [string]
    }

Response Parameters

2. Ready Message

This message should be sent as soon as the customer has been fully transitioned into a paying show room environment. That may mean different things for your users than it means to us, so feel free to contact your account representative if you need any further clarity on this state. When a customer wishes to leave the show you will need to send the Logout message.

POST /show?key=[KEY] HTTP/1.1
Host: [API]:80

function=showReady
  &performerId=[id]
  &customerId=[id]

NOTE: The post variables should all be on 1 line. We have separated them here for visual clarity only.

Parameters

Once this request is received the API will verify that all information is valid and will return true or false based on whether the user can enter the show.

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: [int]

{
    success: true | false
    message: [string],
    video: {
        flash: [
            {
                connectUrl: [url],
                streamName: [name]
            },
            {
                connectUrl: [url],
                streamName: [name]
            }
        ],
        hls: [
            [url],
            [url]
        ]
    }
}

Response Parameters

3. Logout Message

You will send this message as soon as the customer decides to end the show. If the user has disconnected on your end, you should also send this message to cleanly shut down the show. If you fail to do so, some extra credits may be deducted from the customer's account while it is determined that they have disconnected.

POST /show?key=[KEY] HTTP/1.1
Host: [API]:80

function=showLogout
  &performerId=[id]
  &customerId=[id]

NOTE: The post variables should all be on 1 line. We have separated them here for visual clarity only.

Parameters

Once this request is received the API will verify that all information is valid and will return true or false based on whether the user can enter the show.

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: [int]

{
    success: true | false
    message: [string]
}

Response Parameters