Authentication

In order to make API requests, you will first need to request a token

POSThttps://api.voxo.co/authentication

Make API Requests

This request returns an access token along with the authenticated user

Parameters

Header

Name
Content-Type*
Type
string
Description
Name
Accept
Type
string
Description

Body

Name
strategy*
Type
string
Description
Name
email*
Type
string
Description
Name
password*
Type
string
Description

Response

{
    "accessToken": "XXXXXXXXXXXXX",
    "authentication": {
        "strategy": "local"
},
    "user": {
        "id": 0,
        "tenantId": 0,
        "receiveQueueReports": 0,
        "email": "test@test.com",
        "emailField": null,
        "avatarPath": null,
        "avatarFileName": null,
        "userRole": 1,
        "us_useldap": "",
        "resetToken": null,
        "online": 0,
        "lastOnline": "2020-09-28 15:46:02",
        "enableCallNotifications": 1,
        "enableChatNotifications": 0,
        "integrationId": null,
        "timezone": null,
        "conversations": [
        0
        ],
        "faxEnabled": false,
        "faxNumber": null,
        "myExtension": {
        "id": 0,
        "name": "Tony Fax",
        "tenantId": 0,
        "tenantCode": "demo",
        "number": "XXX",
        "sipFriendId": 0,
        "status": "NOT_INUSE",
        "hostServer": "",
        "peerName": "XXX",
        "peerSecret": "XXXX",
        "dnd": "",
        "callerId": "XXX",
        "voicemailId": 0,
        "omniaPhonebookId": null,
        "devices": [
            null
        ],
        "branch": "Hattiesburg",
        "branchId": 0,
        "queueIds": [
            0,
            0
        ]
        },
        "adminQueues": [],
        "tenantIds": [],
        "name": "Tony Fax",
        "extNum": "XXXX"
    }
}

cURL

curl --location --request POST 'https://api.voxo.co/authentication' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"strategy": "local",
	"email": "test@test.com",
	"password": "XXXX"
}'

The response from this API will contain a field called accessToken

All subsequent API calls should the following header

Authorization: Bearer {accessToken}

Replace {accessToken} with value from the response