Table of Contents

API : HelpCenters

Introduction

Returns the help centers of the caller's own organisation.

Request

URL https://api.telecomx.dk/helpcenter/helpcenter
Method GET
Access level RESELLER_ADMIN with HELPCENTER feature, or ADMIN.

Query example

https://api.telecomx.dk/helpcenter/helpcenter

Response

JSON object
_id ObjectId Id of the customer the help centers belong to.
helpCenters Array The customer's help centers as full settings objects - see HelpCenterSettings List for the field definitions.

Example

{
  "_id": "650000000000000000000003",
  "helpCenters": [
    {
      "id": "650000000000000000000001",
      "name": "Example Support",
      "emailAddress": "support@example.dk",
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "tenantId": "00000000-0000-0000-0000-000000000000",
      "appClientValue": "<CLIENT_SECRET>",
      "signature": "Best regards, Example Support"
    }
  ]
}

Errors

Error code Message Description
404 helpCenterSettings No HelpCenterSettings found
403 access_denied Insufficient access level
500 internal_error <Unspecified>