Message

All the endpoints that can be called on the Message controller.

All of the endpoints require the MESSAGE_CREATE permission.

index

post

Creates a new message.

The ticket must already exist. It will clear the ticket's cache before processing this data.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

ticketIDstringOptional

type: number

If you want to send a message in an already existing ticket.

typestringOptional

type: ^([0-9]+|calllog|contactform)$

toAddressstringOptional

type: string = ' '

Nullable for contactforms and notes.

ccInputstringOptional

type: string = ' '

Must be a valid email address format.

bccInputstringOptional

type: string = ' '

Must be a valid email address format.

respondMessageIDstringOptional

type: number = 0

Add this parameter if it is a reply to an existing message.

plaintextstringOptional

type: string = ' '

If this one is empty, it will use the value of the message parameter instead. Only relevant for emails.

messagestringOptional

type: string

The actual message.

forwardedFileIDs[]stringOptional

type: number = null

If you want to forward existing files.

sendAtstringOptional

type: string 'Y-m-d H:i' = current time

A special parameter as it is a string that would be following the date format specified.

userIDstringOptional

type: number = 0

The ID of the user who created this message.

submitStatusstringOptional

type: ^open|pending|holding|solved|closed$ = null

Responses

200

Successful response

application/json

post/api/v2/message

HTTPcURLJavaScriptPython

POST /api/v2/message HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 231

{
  "ticketID": "text",
  "type": "text",
  "toAddress": "text",
  "ccInput": "text",
  "bccInput": "text",
  "respondMessageID": "text",
  "plaintext": "text",
  "message": "text",
  "forwardedFileIDs[]": "text",
  "sendAt": "text",
  "userID": "text",
  "submitStatus": "text"
}

200

Successful response

chatbot

post

Creates a ticket and its accompanying message coming from a chatbot.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

brandIDstringOptional

type: number

messagestringOptional

type: string

subjectstringOptional

type: string

fromstringOptional

type: string

Responses

200

Successful response

application/json

post/api/v2/message/chatbot

HTTPcURLJavaScriptPython

POST /api/v2/message/chatbot HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66

{
  "brandID": "text",
  "message": "text",
  "subject": "text",
  "from": "text"
}

200

Successful response