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

Get All DirectChat PINs

This API operation retrieves a list of existing DirectChat PINs from the user.

URL / Endpoint

Need help with Postman?

GET /v1/DirectChat/GetAllPINs


This operation does not accept any parameters.

Request Information

HTTP Method / Verb

This endpoint is using the HTTP GET method.


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 scope:



GET method


Authorization: bearer {your-access-token}


User aws:DirectChatPINUser The user to which the PIN is made for. This contains some basic and and other relevant pieces of information for the user.
PIN string The PIN associated with the user. This is the PIN number you will have to provide when calling our DirectChat number.
CreatedDate datetime The date and time at which this PIN has been associated with the user.
NumberOfCalls integer The amount of calls made using this PIN.
LastCallDate datetime The date and time at which this PIN has most recently been used.
InProgress boolean Indicates whether a call using this PIN is currently on-going.

Response Sample

The following example returns multiple associated PINs.

        "User": {
            "Id": 123456,
            "Username": "BookedUser",
            "AvailableNow": true,
            "IsDirectChat": true,
            "DirectChatPPM": 1.25,
        "PIN": "1234",
        "CreatedDate": "2018-02-12T12:34:56.789",
        "NumberOfCalls": 2,
        "LastCallDate": "2018-02-15T23:20:45.250",
        "InProgress": false
    { ... }   (Shortened for brevity)
<ArrayOfDirectChatPinResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.DirectChat">
    <DirectChatPinResult>... (Shortened for brevity)</DirectChatPinResult>