Message

Each time someone from our system communicates with a room, you will receive the following command. Please note that you will NOT get messages that originated from your system. Those messages should be handled by your own system and then relayed to us so that we can notify other customers of your customer's message.

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:

SWIPE TO SCROLL
POST [YOUR_API_URI] HTTP/1.1
Host: [YOUR_API_HOST]
Content-Type: text/xml; charset=utf-8
Content-Length: [int]

[
    {
        function: message,
        type: 8002,
        performerId: [id],
        nickname: [nickname],
        color: [#hex],
        message: [string]
    },
    ...
]

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 send the message or handle it for any logistical reason. Only return false if the data did not appear to be valid.

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 request was allowed.
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