UserAuthToken GET

UserAuthToken GET
GET /api/userauthtoken

Create a single use authentication token.

Create a single use login authentication token for the user which credentials were supplied in the authentication header. This token can then be used to access the web portal or call other REST api calls.

When retrieved, you can login to your CallN account with

e.g. https://mycompany.calln.com/?authtoken={token}

 

QUERY STRING PARAMETERS

durationminutes
[optional]

The number of minutes the token is valid for. The maximum value is 60 minutes and the default is 10 minutes if not provided.

domainname
[optional]

By default, the domain of the user who requested the token.
For reseller accounts, you can request very limited access to one of your associated client accounts. This permission can only include upload a call and modify handsets.

rights
[optional]

Possible rights are:

ALL Rights to all api calls
   
CALLCREATE Rights to create a call record
CALLDELETE Rights to delete a call record
CALLREAD Rights to read a call record
CALLWRITE Rights to update a call record
   
CALLAUDIOREAD Rights to the call audio
CALLAUDIOWRITE Rights to upload a call audio
   
CALLAUDITREAD Rights to read a call audit record
CALLAUDITWRITE Rights to update a call audit record
   
HANDSETCREATE Rights to create a new handset
HANDSETDELETE Rights to delete a handset
HANDSETREAD Rights to read a handset record
HANDSETWRITE Rights to update a handset record
   
USERCREATE Rights to create a new user
USERDELETE Rights to delete a user
USERREAD Rights to read a user record
USERWRITE Rights to update a user
   
CREATE Rights to create objects across all apis
DELETE Rights to delete objects across all apis
READ Rights to access objects across all apis
PORTAL Rights to portal apis
WRITE Rights to update objects across all apis
   
DIAGNOSTICREAD Rights to read diagnostic data
TRANSCRIPTIONREAD Rights to read transcription records
   

One or more comma delimited rights. By default, ALL.

 

 

Result Code

200

OK

401

Unauthorized

406

SSL must be used

500

Server Error

 

Result Body

token

The authentication token.

expiry

The expiry of the token.

 

Example request

Example;-
GET
https://api.calln.com/api/userauthtoken
Result;-
200 (OK)
{"token":"e553a4e6b9dc4c9595ba634523eb6b44","expiry":"2019-04-10T06:41:24.000Z"}

Using Curl

Get a token
curl "https://api.calln.com/api/userauthtoken" -H "Authorization: Basic username:password | base64" -X GET

 

Get a token for your client account ‘myclient’
curl "https://api.calln.com/api/userauthtoken?domainname=myclient&rights=HANDSETCREATE,CALLCREATE,CALLAUDIOCREATE" -H "Authorization: Basic username:password | base64" -X GET

 

Calculate your CallN Costs in 60 Seconds

  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • After you sign up, this will be used for your Calln domain.
  • A Team member will contact you on this number.
  • A summary of your calculations will be sent to this email address.
  • You may review our terms and conditions and privacy policies by clicking on the links above.