Helpdesk

HelpdeskThreadsList

Returns a list of helpdesk threads.

Sample response:

{
  "Action":"HelpdeskThreadsList",
  "Result":
  {
    "Search":"",
    "Filter":4,
    "List":
    [
      {
        "@Object":"Object\/CHelpdeskThread",
        "IdHelpdeskThread":98,
        "ThreadHash":"4s935rgd2t9",
        "IdOwner":3,
        "Owner":["john_doe@domain.com","John"],
        "Type":3, // 'None': 0, 'Pending': 1, 'Waiting': 2, 'Answered': 3, 'Resolved': 4, 'Deferred': 5
        "Subject":"I have a question",
        "IsRead":false,
        "IsArchived":false,
        "ItsMe":false,
        "HasAttachments":false,
        "PostCount":2, // number of threads in a post
        "Created":1436167038,
        "Updated":1436187119
      },
      {
        "@Object":"Object\/CHelpdeskThread",
        "IdHelpdeskThread":97,
        "ThreadHash":"4d9123sur43",
        "IdOwner":3831,
        "Owner":["good_man@other_domain.com","Good Man"],
        "Type":2,
        "Subject":"How can I do this?",
        "IsRead":true,
        "IsArchived":false,
        "ItsMe":false,
        "HasAttachments":false,
        "PostCount":1,
        "Created":1433499484,
        "Updated":1433499484
      },
      ...
    ],
    "Offset":0,
    "Limit":10,
    "ItemsCount":32
  },
  "@Time":0.22722291946411
}

HelpdeskThreadByIdOrHash

This request is used if there's an application link which includes hash of a thread not found in the list. In that case, data on that specific thread can be fetched separately.

Sample response:

{
  "Action":"HelpdeskThreadByIdOrHash",
  "Result":
  {
    "@Object":"Object\/CHelpdeskThread",
    "IdHelpdeskThread":98,
    "ThreadHash":"4s935rgd2t9",
    "IdOwner":3,
    "Owner":["john_doe@domain.com","John"],
    "Type":3,
    "Subject":"I have a question",
    "IsRead":true,
    "IsArchived":false,
    "ItsMe":false,
    "HasAttachments":false,
    "PostCount":2,
    "Created":1436167038,
    "Updated":1436187119
  },
  "@Time":0.17580986022949
}

HelpdeskThreadPosts

Obtain list of posts in a specific thread.

Sample response:

{
  "Action":"HelpdeskThreadPosts",
  "Result":
  {
    "ThreadId":98,
    "StartFromId":0,
    "Limit":5,
    "ItemsCount":2,
    "List":
    [
      {
        "@Object":"Object\/CHelpdeskPost",
        "IdHelpdeskPost":215,
        "IdHelpdeskThread":98,
        "IdOwner":5,
        "Owner":["good_man@other_domain.com","Good Man"],
        "Attachments":null,
        "IsThreadOwner":false,
        "ItsMe":true,
        "Type":0,
        "SystemType":0,
        "Text":"this is my answer",
        "Created":1436187119
      },
      {
        "@Object":"Object\/CHelpdeskPost",
        "IdHelpdeskPost":214,
        "IdHelpdeskThread":98,
        "IdOwner":3,
        "Owner":["john_doe@domain.com","John"],
        "Attachments":null,
        "IsThreadOwner":true,
        "ItsMe":false,
        "Type":0,
        "SystemType":0,
        "Text":"this is my question",
        "Created":1436167038
      }
    ]
  },
  "@Time":0.18508005142212
}

HelpdeskPostCreate

Creates a new post.

Identifier used for looking up the thread. Obtained from IdHelpdeskThread returned by HelpdeskThreadsList request.

Sample response:

{
  "Action":"HelpdeskPostCreate",
  "Result":
  {
    "ThreadId":98,
    "ThreadIsNew":false
  },
  "@Time":7.7658529281616
}