Received PhoneChat Bookings

This API operation retrieves a list of existing PhoneChat Bookings made for the user.

URL / Endpoint

GET /v1/PhoneChat/ReceivedBookings

GET /v1/Groups/PhoneChat/ReceivedBookings (See Group manager)

Request

Property	Type	Description
`StartDate`	date	The date at which the phonechat bookings were created. You can use this to search from this date. Format: `yyyy-mm-dd`
`OrderBy`	string	Sets the order in which the bookings will be returned. Default is `date-desc`. Other possible options are `date-asc`, `nickname-asc`, `nickname-desc`, `sessiondate-asc` and `sessiondate-desc`
`BookingsPerPage`	integer	Sets the number of bookings on each page of the result set. Accepts values from `1` to `100`. Default is `50`.
`PageNumber`	integer	Returns a specific page in the result set. Accepts values from `1` onwards.

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

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/ReceivedBookings
?OrderBy=sessiondate-asc &BookingsPerPage=10

Authorization: bearer {your-access-token}

GET as Group Manager

https://api-sandbox.adultwork.com/v1/Groups/PhoneChat/ReceivedBookings
?UserID=123456 &OrderBy=sessiondate-asc &BookingsPerPage=10

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`BookingsTotal`	integer	Represents the total number of bookings in the result set.
`BookingsPerPage`	integer	Represents how many bookings are listed on each page.
`Bookings`	Array of aws:PhoneChatReceivedBooking	The page of bookings. See the type for more information

Response Sample

The following example returns a page of 10 PhoneChat Bookings.

JSON
XML

{
    "PageCount": 3,
    "PageNumber": 1,
    "BookingsTotal": 30,
    "BookingsPerPage": 10,
    "Bookings": [
        {
            "BookingID": 1,
            "Duration": 15,
            "Credits": 8,
            "Status": "Confirmed",
            "Method": 2,
            "PhoneNumber": "44...",
            "SkypeName": null,
            "CreateDate": "2018-01-20T12:34:56.789",
            "SessionDate": "2018-01-22T21:30:00",
            "AcceptBy": "2018-01-22T00:00:00",
            "AcceptedDate": "2018-01-21T12:48:13.412",
            "ConfirmedDate": "2018-01-21T13:24:05.987",
            "CancelledDate": null,
            "CancelledReason": null,
            "CancelledBy": null,
            "RejectedReason": null,
            "LastUpdated": "2018-01-21T13:24:05.987",
            "Comments": null,
            "ActionCandidate": "You need to carry out the session",
            "Client": {
                "UserID": 123654,
                "Nickname": "BookingUser",
                "PhoneNumber": null,
                "SkypeName": null,
                "Total": 6,
                "Positive": 7,
                "Neutral": 0,
                "Negative": 1,
                "Ratings": 8,
                "Disputes": 0
            }
        },
        ... (Shortened for brevity)
    ]
}

<BookingsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.PhoneChat.Bookings.Made">
    <Bookings>
        <MadeBooking>
            <AcceptBy>2018-01-22T00:00:00</AcceptBy>
            <AcceptedDate>2018-01-21T12:48:13.412</AcceptedDate>
            <ActionCandidate>You need to carry out the session</ActionCandidate>
            <BookingID>1</BookingID>            
            <CancelledBy i:nil="true" />
            <CancelledDate i:nil="true" />
            <CancelledReason i:nil="true" />
            <Client xmlns:d4p1="http://schemas.datacontract.org/2004/07/API.Models.PhoneChat.Bookings">
                <Disputes xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">0</Disputes>
                <Negative xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">1</Negative>
                <Neutral xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">0</Neutral>
                <Positive xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">7</Positive>
                <Ratings xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">8</Ratings>
                <Total xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">6</Total>
                <d4p1:Nickname>BookingUser</d4p1:Nickname>
                <d4p1:PhoneNumber i:nil="true" />
                <d4p1:SkypeName i:nil="true" />
                <d4p1:UserID>123654</d4p1:UserID>
            </Candidate>
            <Comments i:nil="true" />
            <ConfirmedDate>2018-01-21T13:24:05.987</ConfirmedDate>
            <CreateDate>2018-01-20T12:34:56.789</CreateDate>
            <Credits>8.0000</Credits>
            <Duration>5</Duration>
            <LastUpdated>2018-01-21T13:24:05.987</LastUpdated>
            <Method>2</Method>
            <PhoneNumber>44...</PhoneNumber>
            <RejectedReason i:nil="true" />
            <SessionDate>2018-01-22T21:30:00</SessionDate>
            <SkypeName i:nil="true" />
            <Status>Confirmed</Status>
        </MadeBooking>
        <MadeBooking>... (Shortened for brevity)</MadeBooking>
    </Bookings>
    <BookingsPerPage>10</BookingsPerPage>
    <BookingsTotal>30</BookingsTotal>
    <PageCount>1</PageCount>
    <PageNumber>3</PageNumber>
</BookingsResult>