Get Ticket Conversations
Retrieves all the conversations from a ticket.
Prerequisite
Before you pass this API, the API Configurations setting must be enabled on your account. To do this –
- On your LeadSquared account, navigate to My Profile>Settings>Service Cloud, and click API Configurations.
- Alongside Enable API, enable the slider
.
- Alongside Enable IP Whitelisting, enable the slider and add the IPs you want to whitelist. This is optional.
- Once you’re done, click Save.
Note: To obtain the host API URL, contact your account manager, or write to scsupport@leadsquared.com.
Pass the following mandatory API headers –
- X-LSQ-ACCESS-KEY – <AccessKey>
- X-LSQ-SECRET-KEY – <SecretKey>
To obtain the tenantID, after logging into your LeadSquared account, click the My Profile icon.
API URL
URL
POST
https://apigw.service-in.leadsquared.com/api/tenants/{{tenantID}}/conversation/filter
Request
Content-Type: application/json
JSON Body/Payload
{
"TicketId": 143,
"OrgId": 22824,
"ActivityType" : [
"InboundEmail"
]
}
Request Parameters
| Parameter | Description |
|---|---|
| TicketId | The ticketId of the ticket for which you retrieve the conversation. To obtain the Id, navigate to the Ticket Details Page, and copy the number (143 in the screenshot below) from the page URL.
|
| OrgId | Your account number. To get it, click the My Profile icon in your account.
|
| ActivityType | The following conversations can be retrieved –
|
Response
200 OK
Content-Type: application/json
{
"Total":2,
"Conversations":null,
"ConversationList":[
{
"RelatedActivityType":"InboundEmail",
"Html":"\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nHi,
\r\n
\r\nHas my email Id been updated. Have raised this issue a while ago.
\r\n
\r\nThanks,
\r\nWim
\r\n
\r\n\r\n\r\n\r\n",
"Text":"Hi, Has my email Id been updated. Have raised this issue a while ago. Thanks, Wim",
"Attachments":[
],
"CreatedBy":"a443f7b7-d1fd-11ec-993a-06f221480cd8",
"CreatedOn":"2024-08-28T12:38:36.198",
"Id":131
},
{
"RelatedActivityType":"InboundEmail",
"Html":"\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nPlease update my Id to \r\nxyz@example.com
\r\n
\r\nHave attached file for reference
\r\n
\r\n\r\n\r\nFrom: Sri Sudhan R <sri.sudhan@leadsquared.com>\r\n
\r\nSent: Wednesday, August 28, 2024 6:09 PM
\r\nTo: Vir K.D Singh <Vir.Singh@leadsquared.com>
\r\nSubject: RE: [#143] Update Email Id
\r\n\r\n\r\n
\r\n\r\n\r\nHi,
\r\n
\r\nCan you please share a government issued ID, along with the email ID you want to update on your account?\r\n
\r\n\r\nThanks,
\r\n\r\n
\r\n\r\nSupport Team,
\r\n\r\nEducation 101
\r\n\r\n\r\n\r\nOn 28 Aug , 04:06 PM, Vir.Singh@leadsquared.com wrote:
\r\n\r\n\r\n\r\nHi,
\r\n
\r\nHas my email Id been updated. Have raised this issue a while ago.
\r\n
\r\nThanks,
\r\nWim
\r\n
\r\n\r\n\r\n\r\n\r\n\r\n",
"Text":"Please update my Id to xyz@example.com Have attached file for reference From: Sri Sudhan R Sent: Wednesday, August 28, 2024 6:09 PM To: Vir K.D Singh Subject: RE: [#143] Update Email Id Hi, Can you please share a government issued ID, along with the email ID you want to update on your account? Thanks, Support Team, Education 101 On 28 Aug , 04:06 PM, Vir.Singh@leadsquared.com wrote: Hi, Has my email Id been updated. Have raised this issue a while ago. Thanks, Wim",
"Attachments":[
{
"Id":null,
"FileName":"Aadhaar.png",
"FileSize":109210,
"ContentType":"image/png",
"ContentPath":"https://service-cloud-tenant-data-prod-in.s3.ap-south-1.amazonaws.com/t/22824/ticket/%23143/email/ebf0f7d2-b153-4775-ae9f-c45e8a047c7c?response-content-disposition=inline%3B%20filename%3D%22Aadhaar.png%22&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECMaCmFwLXNvdXRoLTEiRzBFAiEA8c2qX%2FyY0nE5UdIqEsL6XEonGthRckQDK1pNr8hkBV0CIHoFMX3WLnkOVpfyt0cEmON0tAsnWk2kDBAhjOyK%2BPgMKosFCOz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQARoMNjc2MjQxOTU0NjQxIgxal%2BXMqBWv5rlmShYq3wSEI%2BEdCuT59Y5wvLlOPAx8CDfNRlICG9w93GlOll675p8mVn7vZHj%2FM2q7rcXJPYTygyg%2BGFgqGyJXM65bfyLNqF0kltmh3zS6krmzfBpkkyc3IWq05zflT4cgZ2lTg4cJv18FWlIvyv3Z24B2cGrsEXBdOyxLGiHpy7MbCViC9rooptCkP9jWX6Jd6lG9Er2WOEiO9xTI6oMMfO9w8pKctfMVwBTGPzhVEkcD78Zd70rJ3QPoPfzTvwS%2FCtkcrtMKLaCA1SDneC4Xwsklo6H1UbqcILkDkUZ%2FzxuTXW%2FJwLJzbR5mM9ZzEWA3%2F7b44%2F5oFDwlNmUdNMrbfgc%2B2NucbPpJAuDo%2BtE5g4xCSkA9eInU5tKnKHvnfExdZ2dEGap7LDU%2FMR404LN5L2Wi0R7xQ0IiM618toPbzIZMlaY5zSkEBQQB93RXq0HAJVqEaAx0imnkYfEerZnrDKXinBgRLGRnKP%2FarWnMNnFbkpFnYs6Mvi2UtpwzEJWrpdM5dBLvwNOdg1b61bdukDGoCMF6ttNoK3EwUcgIni354DFBM1AISrzKelt3ssJTmPwbk6lz0nBz7%2FTxtSNP%2BcRxJO9agfNplVo1X8GjT4fruh6H0cMisOfYxaJUudguvb28MzY0ZgHi8U9JsGrQR53sY%2F9PUjru2ycEmuFasLDcpgKNYvVbhLCiaYNmlyizySk94XoQ10vRDHoEfJrnbahCzHYHDpMsdmdXLkjm%2FCsb0nrA9R7uk1ePgKPcGivGkqnq02lPFQHvCLtnvyRDMSnxFNBlPpPWLNVSNy1OoSBRX%2BckMOydttAGOpgBKX%2FTlf7UNWRyQRsToqSR3ABU37nEpH87Dx8Yro6ehiikdVrB%2Bm9g91SRPzonC7BDd5ROLPa4fv0pAFwmUXoiugaa49JWoKfW85X5JLhCEUU0BOToy%2Bl2N47fSPcGqOcX9PWKt06HUwtgowgxmv1INQluUDKVlLwGu9LehhoCO83D%2BvdP6YaF%2FxAEbqmwejITIQljY4kol7k%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260520T103732Z&X-Amz-SignedHeaders=host&X-Amz-Credential=ASIAZ24ZJK5IWPODMY4S%2F20260520%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Expires=3600&X-Amz-Signature=5f99829c9af5999904d1d7ad4c920238039bbb883048aca95ef97dab143a0906",
"ContentLocation":null,
"ContentId":null,
"Ttl":60
}
],
"CreatedBy":"a443f7b7-d1fd-11ec-993a-06f221480cd8",
"CreatedOn":"2024-08-28T13:55:43.68",
"Id":135
}
]
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK |
This is the status code for successful API call. |
| 401 Unauthorized |
The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request |
The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found |
The API could not be found. Please check the API signature. |
| 429 Too Many Requests |
API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error |
The API called failed. There could be many reasons for it. Check the exception message to get more details. |
