Get User Requirements for PhoneChat Booking

This API operation retrieves the requirements and restrictions of creating a PhoneChat booking at the specified user.

URL / Endpoint

GET /v1/PhoneChat/GetUserBookingRequirements

Request

Property	Type	Description
`BookUserID`	integer	Required. The ID of the user of which the requirements and restrictions will be returned.

Prerequisites

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

Property	Type	Description
`BookUserID`	integer	The user must be providing PhoneChat. The user 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.

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_phonechat_bookings`

Samples

GET method

https://api-sandbox.adultwork.com/v1/PhoneChat/GetUserBookingRequirements
?BookUserID=123456

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`PhoneChatPPM`	decimal	The price per minute (including VAT) required to book this user. When creating a booking, the value of `Credits` must be at least `PhoneChatPPM × Duration`. This value can be null if the user has not yet configured their PhoneChatPPM, in which case this has no additional restrictions.
`Methods`	array of aws:PhoneChatMethod	An array containing all different methods and whether they are available to use for the user or not. The different methods are `1` if the client (logged in user) wants to be called by the booked user, `2` if the client will call the booked user him/herself, or `3` if skype will be used.

Response Sample

The following example returns the requirements and restrictions of a user who can be booked using Skype, or by calling the client.

JSON
XML

{
    "PhoneChatPPM": 0.726,
    "Methods": [
        {
            "Method": 1,
            "Available": true
        },
        {
            "Method": 2,
            "Available": false
        },
        {
            "Method": 3,
            "Available": true
        }
    ]
}

<UBROutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.PhoneChat.UserBookingRequirements">
    <Methods>
        <UBRMethod>
            <Available>true</Available>
            <Method>1</Method>
        </UBRMethod>
        <UBRMethod>
            <Available>false</Available>
            <Method>2</Method>
        </UBRMethod>
        <UBRMethod>
            <Available>true</Available>
            <Method>3</Method>
        </UBRMethod>
    </Methods>
    <PhoneChatPPM>0.7260</PhoneChatPPM>
</UBROutput>