Get PhoneChat Settings

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

URL / Endpoint

GET /v1/PhoneChat/GetSettings

GET /v1/Groups/PhoneChat/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_phonechat_bookings`

Samples

GET method

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

Authorization: bearer {your-access-token}

GET as Group manager

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

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`OfferDirectChat`	boolean	Indicates this user wishes to participate in the DirectChat scheme.
`DirectChat`	aws:DirectChatSettings	All settings directly related to DirectChat. This will only be provided if `OfferDirectChat` is true.
`PhoneChatNumber`	string	The phone number provided by the user, which users will be able to call when they have confirmed a Phone Chat booking. If a phone number is not supplied, the user will be required to call the client using the number the client supplies.
`ShowPhoneChatNumber`	boolean	Indicates this user wants their `PhoneChatNumber` to appear on their profile page and emails. There is a charge for displaying their number.
`PhoneChatPPM`	decimal	The amount, in Credits, that the user wishes to charge for normal Phone Chat calls, per minute.

Response Sample

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

JSON
XML

{
    "OfferDirectChat": true,
    "DirectChat": {
        "DirectChatOnly": false,
        "DirectChatNumber": "44...",
        "DirectChatPPM": 0.75
    },
    "PhoneChatNumber": "44...",
    "ShowPhoneChatNumber": false,
    "PhoneChatPPM": 0.6
}

<PhoneChatSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.PhoneChat">
    <DirectChat>
        <DirectChatNumber>44...</DirectChatNumber>
        <DirectChatOnly>false</DirectChatOnly>
        <DirectChatPPM>0.7500</DirectChatPPM>
    </DirectChat>
    <OfferDirectChat>true</OfferDirectChat>
    <PhoneChatNumber>44...</PhoneChatNumber>
    <PhoneChatPPM>0.6000</PhoneChatPPM>
    <ShowPhoneChatNumber>false</ShowPhoneChatNumber>
</PhoneChatSettings>