Support

List all Tickets messages

Returns a list of your Tickets messages.

get/admin/support/ticket-messages

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/support/ticket-messages
  • Auth: HTTP basic

Query parameters

files_with_contentboolean required

Get files with content

Response

ticket_idnumber

Ticket ID

customer_idnumber

Customer ID

incoming_customer_idnumber

Incoming customer ID

admin_idnumber

Administrator ID

api_idnumber

API key ID

source'administration' | 'api' | 'portal' | 'public_form' | 'incoming'

Source of the message

datestring
timestring
messagestring

Message text

rawMessagestring
is_mergedboolean

Is message merged

can_be_deletedboolean

Is message can be deleted

hide_for_customerboolean

Is message hidden for customer

mail_tostring
smsTostring[]
mail_ccstring

Forwarding Cc email

mail_bccstring

Forwarding Bcc email

author_type'admin' | 'customer' | 'api' | 'system'

Type of the author who created the message

idnumber

Ticket Message ID

message_type'message' | 'note' | 'change_ticket'

Type of ticket message

author_namestring

Display name of the message author (admin, customer, sub-account or API); "System" for system messages

Example response

[
  {
    "ticket_id": 1,
    "customer_id": 2,
    "incoming_customer_id": 0,
    "admin_id": 1,
    "api_id": 0,
    "source": "administration",
    "date": "2021-01-10",
    "time": "14:35:22",
    "message": "Message content",
    "rawMessage": "<i>Message content</i>",
    "files": [
      {
        "id": 199,
        "type": "ticket_attachment",
        "filename_original": "ticket_file.txt",
        "filename_uploaded": "/var/www/splynx/uploads/ticket_attachment/2018-12/bf932f8491852129",
        "content_type": "text/plain",
        "content": "bHNmamFsc2tkamZsa2FqZGZsYWoK",
        "download_link": "https://yourdomain/a",
        "has_thumbnail": true,
        "thumbnail_link": "https://yourdomain/b"
      }
    ],
    "is_merged": false,
    "can_be_deleted": true,
    "hide_for_customer": false,
    "mail_to": "client@example.com",
    "smsTo": [
      "+120501234567",
      "+120501234568"
    ],
    "mail_cc": "",
    "mail_bcc": "",
    "author_type": "admin",
    "id": 1,
    "message_type": "message",
    "author_name": "John Doe"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.