Table of Contents

API : HelpCenter Case List

Introduction

Returns a litst of all HelpCenterCases related to a specific HelpCenter id.

Request

URL https://api.telecomx.dk/helpcenter/case
Method GET
Access Level RESELLER, RESELLER_ADMIN OR ADMIN
Query id Id of the HelpCenter.
offset [optional] : Index of first item to return.
limit [optional] : The number of cases to return, default 100, min 1, max 500 .
state [optional] : Status of the cases. Options: 'ALL', 'UNHANDLED', 'HANDLING', 'CLOSED'. Default 'ALL'.
sortOrder [optional] : Sorting order, 'asc' for ascending or 'desc' for descending. Default asc.
sortBy [optional] : Sorting catagories, 'CREATED' for oldest, 'SENT' for latest or 'STATE' for status. Default SENT.

Query Example

https://api.telecomx.dk/helpcenter/case?id=1234567890ABCDEF12345678
https://api.telecomx.dk/helpcenter/case?id=1234567890ABCDEF12345678&state=UNHANDLED
https://api.telecomx.dk/helpcenter/case?id=1234567890ABCDEF12345678&state=UNHANDLED&sortOrder=asc
https://api.telecomx.dk/helpcenter/case?id=1234567890ABCDEF12345678&sortOrder=asc&sortBy=CREATED
https://api.telecomx.dk/helpcenter/case?id=1234567890ABCDEF12345678&limit=10&state=UNHANDLED&sortBy=SENT

Response

JSON object
offset Number Index of the first HelpCenterCase returned.
limit Number Number of helpcenter cases to return. Actual amount of cases returned can be lower than limit.
total Number Number of helpcenter cases that can be returned. Used for pagination.
cases Array Array of cases
Case object (JSON)
_id String Case id.
caseNumber Number Number of the case.
conversationId String ID of the email conversation.
subject String Overall subject.
state Enum Enum of states: UNHANDLED / HANDLING / CLOSED.
customer ObjectId ObjectId of the customer who the case regards.
company String Name of the customer who the case regards to.
customerName String Name of the sender on the original email that originated the case.
emailAddress String Email of the customer who sent the original email.
phoneNumber String Phonenumber of the customer.
actionNeeded Boolean Flag for showing if case is unhandled.
messages
messages[].content String Content of email or comment.
messages[].messageId String ID of the email.
messages[].internetMessageId String Unique ID from internet headers.
messages[].sent Date Datetimestamp of when the email or comment was sent.
messages[].sentBy String Name of sender.
messages[].type Enum COMMENT / INCOMING / OUTGOING

Example

{
  _id: "12345678901234567890ABCD",
  caseNumber: 5
  conversationId: "abcdefg12345678",
  subject: "#5 Skærm går i sort",
  messages: [
    {
      content: "Hej, min skærm...",
      messageId: "123",
      sent: 2024-05-14T08:48:05.000Z,
      sentBy: "Mikkel Jørgensen",
      type: OUTGOING
    },
    {
      content: "Hej! Kan du ikke...",
      messageId: "1234",
      sent: 2024-05-14T08:48:05.000Z,
      sentBy: "Thomas Andersen",
      type: INCOMING
    }
  ],
  state: "HANDLING",
  customer: "87654321abcdefg",
  customerName: "Mikkel Jørgensen",
  emailAddress: "mmj@powernet.dk",
  phoneNumber: "+4588888888",
  actionNeeded: true
}

Errors

Error code Message Description
403 access_denied Insufficient access level
422 id Invalid helpcenterId
422 sortBy Invalid sorting specified. Use CREATED, SENT or STATE ´
422 sortOrder Invalid sort order. use asc or desc
422 state Invalid state. Use ALL, UNHANDLED, HANDLING or CLOSED.
500 internal_error <Unspecified error>