LiveZilla Live Chat
EN  DE Please sign in or register Hi
Incredible software. Easy to install and configure. Give you tons of information about what is happening...
Christopher
Show all reviews


LiveZilla API V2




TicketMessage
TicketMessage Object Format
TicketMessage is represented as JSON objects having the following keys:


JSON Key Type Required Read only Comment Example
IdstringNoYes
Message ID

First message's ID must be equal to ticket ID.

Example:
First Message: 11701
Second Message: 246733d03f64db3b72af327d0d835ebd
Read more
TicketIdstringYesNoTicket ID11701
FullnamestringNoNoVisitor's nameJohanna Doe
EmailstringNoNoVisitor's emailjohanna@jdscompany.com
CompanystringNoNoVisitor's companyJdscompany Ltd.
PhonestringNoNoVisitor's phone #004988373728
IPstringNoNoVisitor's IP192.168.1.222
CallMeBackbooleanNoYesCallback Requiredtrue
TypeintNoNo
Message Type

[0] = (Incoming) Web
[1] = (Outgoing) Email
[2] = Chat
[3] = (Incoming) Email
Read more
SubjectstringNoNoSubject / URLCan you help?
SenderIdstringNoNoOperator or Visitor Idjohn_doe
ChannelIdstringNoNo
Commentsarray<int,array<str, str>>NoNo
Ticket Comments

array<index,array<operator_id, comment_text>>
Read more
Attachmentsarray<Attachment>NoYesFile attachments
EditedintNoYesLast edited time (UNIX Timestamp)1395332206
CreatedintNoYesCreated (UNIX Timestamp)1395332206
Customsarray<int,array<str, str>>NoNo
Custom input field values

array<index,array<input_name, input_value>>
Read more
TextstringNoNoMessage PlaintextHello, please help me.


TicketMessage Functions


Create Ticket Message
Function
As of version 5.2.5.0


POST /api/v2/api.php p_ticketmessage_create=1


Filters


Name POST Key Type Required Comment Example  
SendEmailResponderp_sendemailresponderboolNoSend autoresponder email to sender of message1
SendEmailReplyp_sendemailreplyboolNoSend operator reply email to receiver of message1
QuoteMessageIdp_quotemessageidstringNoThe Ticket Message ID of the Message the Operator is replying to.90f9cf...


CURL Example


curl {yourdomain}{livezilla_folder}/api/v2/api.php
-d {authenthication}
-d p_ticketmessage_create=1
-d p_data={ "TicketMessage": { "Type": "0", "Customs": "", "ChannelId": "", "Subject": "Can you help?", "Comments": "", "TicketId": "11701", "Text": "Hello, please help me.", "Fullname": "Johanna Doe", "Company": "Jdscompany Ltd.", "Phone": "004988373728", "Email": "johanna@jdscompany.com", "IP": "192.168.1.222", "SenderId": "john_doe" } } -X POST

Response


200 Ok: {
    "TicketMessage": {
        "Type": "0",
        "Customs": "",
        "CallMeBack": "true",
        "ChannelId": "",
        "Attachments": "",
        "Edited": "1395332206",
        "Subject": "Can you help?",
        "Comments": "",
        "TicketId": "11701",
        "Text": "Hello, please help me.",
        "Created": "1395332206",
        "Id": "
First Message: 11701
Second Message: 246733d03f64db3b72af327d0d835ebd", "Fullname": "Johanna Doe", "Company": "Jdscompany Ltd.", "Phone": "004988373728", "Email": "johanna@jdscompany.com", "IP": "192.168.1.222", "SenderId": "john_doe" } }

Error Codes


                            403 Forbidden: Invalid or no user authentication data sent (see General API Authentication)
400 Bad Data: Invalid or missing POST parameters (see required fields/filters and data types)
                        





Something missing?


If you find anything missing please let us know and we will add the missing structures right away. Thanks.