API : HelpCenterSettings : List

Introduction

Returns a list of HelpCenterSettings for a customer has access to.

Request

URL	https://api.telecomx.dk/helpcenter/helpcentersettings
Method	GET
Access Level	RESELLER_ADMIN OR ADMIN

Query Example

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

Response

Array of customers helpcenters.

JSON object
_id	String	Id of the customer this Helpcenter belongs to
name	String	Name of the customer this Helpcenter belongs to
helpCenters	Array of objects	Settings for helpcenters for customer.
helpCenters[].id	ObjectId	Id of the helpcenter
helpCenters[].name	String	Name of Helpcenter
helpCenters[].applicationId	String	ApplicationId used to authenticate with Microsoft.
helpCenters[].tenantId	String	TenantId used to authenticate with Microsoft.
helpCenters[].appClientValue	String	ClientSecret used to authenticate with Microsoft.
helpCenters[].emailAddress	String	Emailaddress of the support email that the Helpcenter will belong to.
helpCenters[].signature	String	Signature stored for auto use when sending emails
helpCenters[].startDate	String	Date of when Help Center should retreive mails FROM. Represented in DD/MM/yyyy
helpCenters[].authSettings[]	Object	Settings for accessToken.
helpCenters[].authSettings[].accessToken	String	Access token received from Microsoft, used in as bearer token. Valid for 1 hour.
helpCenters[].authSettings[].expires	Date	Date of expiration for accessToken
helpCenters[].subscription	Object	Settings for subscription to Graph.
helpCenters[].subscription.id	String	Id for subscription. Used to receive change notifications
helpCenters[].subscription.clientState	String	Randomly generated clientState used to validate the request. Set up when creating a subscription
helpCenters[].subscription.resource	String	Uri to the specific email inbox to listen to. '/users/{id}/messages'
helpCenters[].subscription.created	Date	Date of creation of subscription
helpCenters[].subscription.expires	Date	Date of expiration of subscription
helpCenters[].subscription.changeTypes[]	String[]	Different types of changes received from Microsoft: 'created', 'updated', 'deleted'

Example

[
  {
    _id: ObjectId('1234578901234567890ABCD'),
    name: 'FupFirma',
    helpCenters: [
      {
        id: ObjectId('1234578901234567890ABCD'),
        name: 'FupFirma 1',
        applicationId: 'b2b55f-8888-4748-c71d-4bc63e25g390',
        tenantId: 'd38g7521-g3ed-4816-b121-1a4b2r502rh9',
        appClientValue: '12345-12345-12345-12345',
        emailAddress: 'helpcenter@example.dk',
        signature: 'Med venlig hilsen, Andeby',
        startDate: '01-03-2024',
        authSettings: {
          accessToken: 'tokenExample',
          expiresOn: '01-03-2024'
        },
        subscription: {
          id: 'subscriptionId',
          clientState: 'acbcDasdwagrradsadwa'
          resource: 'users/helpcenter@example.dk/mailFolders('Inbox')/messages',
          created: ISODate('2024-01-01T12:34:56.123Z'),
          expires: ISODate('2024-01-01T12:34:56.123Z'),
          changeTypes: 'created,updated'
        }
      }
    ]
  }
]

Errors

Error code	Message	Description
403	access_denied	Insufficient acccess level
404	customerId	Customer ID not found
500	internal_error	<Unspecified error >

WIKI

Table of Contents

API : HelpCenterSettings : List

Introduction

Request

Query Example

Response

Example

Errors