/message

When one of your customers wishes to send a message within a given room, you can POST to this URL:

[API]/message?key=[KEY]&performerId=[id]&customerId=[customerId]&nickname=[nickname]

Example:

SWIPE TO SCROLL
POST /message?key=[KEY]&performerId=[id]&customerId=[id]&nickname=[nickname] HTTP/1.1
    Host: [API]:80
    
    [message]
    

Parameters

SWIPE TO SCROLL
Name Required Type Description
key Yes string Supplied by VS. Please ask us for your key.
performerId Yes integer The id of the performer in whose room the chat should appear.
customerId No integer The unique id of the customer. If no id is provided, it is assumed that this is an unregistered customer.
nickname Yes string The name that this user will appear as in the chat.
post-data Yes string This is the message that the customer wishes to say to the room (max 200 chars).

Example Response

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

Response Parameters

SWIPE TO SCROLL
Name Description
success Whether or not your post was successful.
message An error message if success is false.

Copyright © 1996 - 2025 4AF - VS Media, Inc. All Rights Reserved | Terms & Conditions | Cookies Policy | Privacy Policy18 U.S.C. 2257 Record-Keeping Requirements Compliance Statement