API : Authentication Validate Token

Introduction

Used to check if a token is still valid for use. This is to be used by the client or a 3rd party application that uses the authentication of the platform (if you are logged into the X-Telecom API, then you also have access to this application if you present a valid token).

Request

URL	https://api.telecomx.dk/auth/validateToken
Method	GET
Query	token	The token string to validate
	ip	`[optional]` The IP-address the client is at. If it does not match the IP-address the user authenticated from, the token will be considered invalid.
	simple	`[optional]` True if response should set status code 403 (invalid token) or 200 (valid token) instead.
	extend	`[optional]` True if extended data is requested.

Query example

https://api.telecomx.dk/auth/validateToken?token=DGEFYFEEIGHJVNEWJCF&ip=1.2.3.4

Response

Property	Type	Description	Extended
success	Boolean	True if the token is valid
employee	Id	Id of the employee the token belongs to
customer	Id	Id of the customer the employee belongs to
accessLevel	String	The employees access level (see employee for access levels)
name	String	Name of employee	X
language	String	The language selected by the employee	X
customerName	String	Name of the customer the user belongs to	X
customerFeatures	Array	List of features in the TelecomX platform that the customer has access to. The available features are:	X
		CUSTOMER - Basics, addresses, financial, usage limits, employees
		SIP - SIP trunks
		MVNO - Mobile phones
		PBX - Hosted PBX
		TCE - Telecom Call Enhancer
		DNS - Domain management
		INTERNET - Fiber & xDSL
		IPTVPRIVATE - TV for private
		IPTVBUSINESS - TV for commercial
		FLEXCARE - Healthcare
		EXTERNAL_LICENCES - Also license management
customerIntegrations	Object	Integrations to third-party systems. Omitted if the user is not a reseller	X
customerIntegrations.billing	Object	Contains billing integrations	X
customerIntegrations.billing.economic	Object	Integration for visma e-conomic (only relevant for resellers)	X
customerIntegrations.billing.economic.enabled	Boolean	True if the integration is enabled, default false.	X
customerIntegrations.billing.rackbeat	Object	Integration for rackbeat (only relevant for resellers)	X
customerIntegrations.billing.rackbeat.enabled	Boolean	True if the integration is enabled, default false.	X
customerIntegrations.licences.also	Object	Integration for Also (only relevant for resellers)	X
customerIntegrations.licenses.also.enabled	Boolean	True if the integration is enabled, default false.	X
customerIntegrations.ms365	Object	Integration for Also (only relevant for resellers)	X
customerIntegrations.ms365.enabled	Boolean	True if the integration is enabled, default false.	X
customerIntegrations.mvnoPrivate	Object	Integration for Also (only relevant for resellers)	X
customerIntegrations.mvnoPrivate.enabled	Boolean	True if the integration is enabled, default false.	X
reseller	String	Id of the reseller the customer (of the user) belongs to.	X
accountingSystemId	String	Id of customer in 3rd party system.	X
employeeFeatures	Array	List of features the employee has access to:	X
		PLAYMAKERSTATUS - access to PlayMaker support site.	X
		DASHBOARD_EDITOR - permission to edit own PBX dashboards.	X
		HUMAN_TASK - access to human tasks	X
		COMMUNICATOR_DEBUG - access to perform debugging in Communicator.	X
		PORTING - ResellerAdmin has access to Porting	X
		TELE - ResellerAdmin has access to telecom management	X
		TV - ResellerAdmin has access to to IPTV management	X
		FINANCE - ResellerAdmin has access to finance management	X
		FLEXCARESWAP - permission to perform FlexCare Swap	X
recordingMode	String	Current call recording mode: ALWAYS - all calls are recorded, DEMAND - only record when requested, NEVER - cannot record. (requires PBX).	X
skin	String	Name of skin to apply in apps (requires PBX).	X
impersonatedBy	Id	Id of the user who is currently impersonating the logged in user, if impersonation is in use.
communicatorAccess	Boolean	True if user has access to Communicator. (requires PBX).	X
recordingAccess	Boolean	True if user has permission to record calls. (requires PBX).	X
recordingRetension	Boolean	Number of days recordings are kept (requires PBX).	X

Example

{
  success: true,
  employee: '1234567890ABCDEF12345678',
  language: 'da',
  customer: 'ABCDEF123456789012345678',
  name: 'Donald Duck',
  accessLevel: 'MANAGER',
  customerName: 'Northwind Industries',
  customerFeatures: ['CUSTOMER','SIP','MVNO'],
  customerIntegrations: {
    billing: {
      economic: {
        enabled: true
      },
      rackbeat: {
        enabled: true
      }
    },
    licenses: {
      also: {
        enabled: true
      }
    },
    ms365: {
      enabled: true
    },
    mvnoPrivate: {
      enabled: true
    }
  },
  reseller: '123457890ABCDEF12345678',
  accountingSystemId: '646254r6253563tgbcbn',
  employeeFeatures: [ 'DASHBOARD_EDITOR' ],
  recordingMode: 'NEVER',
  skin: 'EARTH',
  impersonatedBy: '12345678901234567890DEDE',
  communicatorAccess: true,
  recordingAccess: false,
  recordingRetension: 0
 
}

Errors

This function does not return any errors.

WIKI

Table of Contents