API : HelpCenter Case Get

Introduction

Request returns a case found by Id.

Request

URL	https://api.telecomx.dk/helpcenter/case/ID
Method	GET
Access Level	RESELLER, RESELLER_ADMIN OR ADMIN
Params	id	Id of the conversation
Query	limit	The number of messages to return, default 5, min 1, max 10.

Query Example

https://api.telecomx.dk/helpcenter/case/1234567890ABCDEF12345678

Response

Case object (JSON)
subject	String	Overall subject, fetched from the email
phoneNumber	String	Phonenumber of the customer
emailAddress	String	Email of the customer who sent the original email
customerName	String	Name of the sender on the original email that originated the case
conversationId	String	ID of the email conversation, provided by Microsoft Graph
state	Enum	UNHANDLED / HANDLING / CLOSED
company	String	Name of the customer who the case regards to
actionNeeded	Boolean	Flag for showing if case is unhandled
createdAt	Date	Date of creation
messages
messages[].content	String	Content of email or comment.
messages[].messageId	String	ID of the message.
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	String	Type to filter between intern comments, incoming and outgoing email. COMMENT INCOMING OUTGOING

totalMessagesCount

Number

Amount of messages fetched, limited by “limit” in query

Example

{
  _id: "12345678901234567890ABCD",
  caseNumber: 5
  conversationId: "abcdefg12345678",
  subject: "#5 Skærm går i sort",
  messages: [
    {
      content: "Hej, min skærm...",
      messageId: "123",
      internetMessageId: "ngjosnfapen",
      sent: 2024-05-14T08:48:05.000Z,
      sentBy: "Mikkel Jørgensen",
      type: OUTGOING
    },
    {
      content: "Hej! Kan du ikke...",
      messageId: "1234",
      internetMessageId: "fnioafnwadda",
      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
404	case	Case not found
500	internal_error	<Unspecified error>

WIKI

Table of Contents

API : HelpCenter Case Get

Introduction

Request

Query Example

Response

Example

Errors