Get Directcam Settings

Use this method to get the settings used by the performer.

URL / Endpoint

GET /v1/DirectCam/GetSettings

GET /v1/Groups/DirectCam/GetSettings (See Group manager)

Request

Property	Type	Description
This operation does not accept any parameters.

Group manager

If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.

The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. Additionally, it has the following extra parameters:

Property	Type	Description
`UserID`	integer	Required. The ID of a member in the group that will be impersonated for this request.

Request Information

HTTP Method / Verb

This endpoint is using the HTTP GET method.

Headers

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.

Authentication

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.

Scopes

This endpoint requires the following scope:

Scope
`account_webcam_bookings`

Samples

GET method

https://api-sandbox.adultwork.com/v1/DirectCam/GetSettings

Authorization: bearer {your-access-token}

GET as Group manager

https://api-sandbox.adultwork.com/v1/Groups/DirectCam/GetSettings
?UserID=123456

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`DoesFree`	boolean	Indicates this user will cam & chat for free (clothed, to entice viewers to enter a paid-for mode.)
`AllowGuestFreePreview`	boolean	Allows non-registered members to enter free preview mode with this user.
`FreeTimeMins`	integer	The maximum amount of minutes the client can connect with the user. Possible values are `0` (unlimited), `5`, `10`, `15`, `20`, `30`, `45`
`FreeTimePeriod`	integer	The maximum amount of minutes the client can connect with the user within this time period. Possible values are `0` (unlimited), `15`, `30`, `60`, `120`, `180`, `240`, `300`, `240`, `360`, `420`, `480`, `540`, `600`, `660`, `720`, `780`, `840`, `900`, `960`, `1020`, `1080`, `1140`, `1200`, `1260`, `1320`, `1380`, `1440`
`DoesGroup`	boolean	Indicates the user is offering group cam & chat for a reduced rate.
`GroupPPM`	decimal	The price for group cam in credits per minute.
`DoesPrivate`	boolean	Indicates the user is offering private one-to-one cam & chat.
`PrivatePPM`	decimal	The price for private cam in credits per minute.
`ChatOnly`	boolean	Indicates this user will only provide typed text-chat only.
`DoesAudioPrivate`	boolean	Indicates this user wishes to send audio in private mode.
`DoesAudioGroup`	boolean	Indicates this user wishes to send audio in group mode.
`DoesAudioFree`	boolean	Indicates this user wishes to send audio in free preview mode.
`WebcamCategoryID`	integer	The directcam category ID. See the GetDirectcamCategories method.
`ShowLiveThumbnails`	aws: ShowLiveThumbnails	The ShowLiveThumbnails settings of this user.
`Title`	string	The specific Profile Title for DirectCam.

Response Sample

The following example returns a result of a users' settings.

JSON
XML

{
    "DoesFree": true,
    "AllowGuestFreePreview": true,
    "FreeTimeMins": 0,
    "FreeTimePeriod": 0,
    "DoesGroup": true,
    "GroupPPM": 1,
    "DoesPrivate": true,
    "PrivatePPM": 2,
    "ChatOnly": false,
    "DoesAudioPrivate": true,
    "DoesAudioGroup": true,
    "DoesAudioFree": true,
    "WebcamCategoryID": 1,
    "ShowLiveThumbnails": {
        "Waiting": true,
        "FreePreview": true,
        "GroupMode": true,
        "ReplaceProfilePic": false
    },
    "Title": "Come and join me."
}

<DirectCamSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.DirectCam">
    <AllowGuestFreePreview>true</AllowGuestFreePreview>
    <ChatOnly>false</ChatOnly>
    <DoesAudioFree>true</DoesAudioFree>
    <DoesAudioGroup>true</DoesAudioGroup>
    <DoesAudioPrivate>true</DoesAudioPrivate>
    <DoesFree>true</DoesFree>
    <DoesGroup>true</DoesGroup>
    <DoesPrivate>true</DoesPrivate>
    <FreeTimeMins>0</FreeTimeMins>
    <FreeTimePeriod>0</FreeTimePeriod>
    <GroupPPM>1.0000</GroupPPM>
    <PrivatePPM>2.0000</PrivatePPM>
    <ShowLiveThumbnails>
        <FreePreview>true</FreePreview>
        <GroupMode>true</GroupMode>
        <ReplaceProfilePic>false</ReplaceProfilePic>
        <Waiting>true</Waiting>
    </ShowLiveThumbnails>
    <Title>Come and join me.</Title>
    <WebcamCategoryID>1</WebcamCategoryID>
</DirectCamSettings>