API Methods
Account ...
Blogs ...
Bookings ...
CreditHistory ...
Dashboard ...
DirectCam ...
DirectChat ...
Email ...
FieldReport ...
Groups ...
HotLists ...
Interview ...
Lists ...
Movie ...
Newsfeed ...
PhoneChat ...
Pictures ...
Profile ...
Search ...
Tours ...
Webcam ...

Get User Requirements for Webcam Booking

This API operation retrieves the requirements and restrictions of creating a Webcam booking at the specified users.

URL / Endpoint

Need help with Postman?

GET /v1/WebCam/GetUserBookingRequirements


BookUserIDs string of comma-seperated integers Required. The IDs of the users of which the requirements and restrictions will be returned. Up to 4 IDs can be provided.


This endpoint has a couple of prerequisites which affects the returned requirements.

BookUserIDs string of comma-seperated integers The users must be providing Webcam.
The users must not have the DirectChat Only option enabled.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.


The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.


An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.


This endpoint requires the following scopes:



GET method


Authorization: bearer {your-access-token}


Users array of aws:WebCamUser An array containing all different requirements for one user. Every requested user has a specific object containing their requirements.

Response Sample

The following example returns the requirements and restrictions of a user who can be booked using MSN or Skype, with a minimum time of 10 minutes.

    "Users": [
            "UserID": 123,
            "SoftwareTypeIDs": [
                    "SoftwareTypeID": 1,
                    "Available": true
                    "SoftwareTypeID": 2,
                    "Available": false
                    "SoftwareTypeID": 3,
                    "Available": true
            "MinimumDuration": 10
<UBROutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Webcam.UserBookingRequirements">