Get a single conversation and it's messages (getConversationById)

GET {{baseUrl}}/channels/:providerChannelId/conversations/:sourceConversationId?after=<string>&messages_limit=30

This endpoint is used to fetch a specific conversation and its messages. It is called when an incoming message is part of a new conversation or when paginating over messages.

Request Params

KeyDatatypeRequiredDescription
afterstringThe cursor used for fetching more messages from the provider
messages_limitnumberThe maximum number of messages expected for each conversation in the response. It's recommended to use this default value and support pagination, for better performance

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;success&quot;:true,&quot;data&quot;:{&quot;id&quot;:&quot;ea nulla&quot;,&quot;link&quot;:&quot;enim ex&quot;,&quot;status&quot;:&quot;closed&quot;,&quot;seen&quot;:false,&quot;next_messages_cursor&quot;:&quot;Lorem cupidatat&quot;,&quot;messages&quot;:[{&quot;id&quot;:&quot;id minim&quot;,&quot;status&quot;:&quot;sent&quot;,&quot;created_at&quot;:&quot;2021-06-22T04:11:01.161Z&quot;,&quot;message&quot;:&quot;cupidatat mollit labore&quot;,&quot;sender_id&quot;:&quot;des&quot;,&quot;reply_by&quot;:&quot;1988-07-05T17:32:11.604Z&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;Lorem nisi Ut&quot;,&quot;type&quot;:&quot;voluptate&quot;,&quot;url&quot;:&quot;amet sunt&quot;,&quot;name&quot;:&quot;veniam non cillum&quot;,&quot;size&quot;:16479897.468681589,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;ex elit cupidatat do&quot;},{&quot;id&quot;:&quot;irure anim&quot;,&quot;type&quot;:&quot;anim Ut enim&quot;,&quot;url&quot;:&quot;in fugiat&quot;,&quot;name&quot;:&quot;voluptate nulla amet laboris&quot;,&quot;size&quot;:-48692983.54724565,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;cupidatat&quot;}]},{&quot;id&quot;:&quot;ullamco ad ex aliquip&quot;,&quot;status&quot;:&quot;failed&quot;,&quot;created_at&quot;:&quot;1993-06-17T21:31:17.513Z&quot;,&quot;message&quot;:&quot;tempor&quot;,&quot;sender_id&quot;:&quot;cillum mollit irure non&quot;,&quot;reply_by&quot;:&quot;1995-03-12T08:48:37.462Z&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;et&quot;,&quot;type&quot;:&quot;in laborum ex Ut&quot;,&quot;url&quot;:&quot;ad Excepteur quis Lorem occaecat&quot;,&quot;name&quot;:&quot;anim aliqua nulla&quot;,&quot;size&quot;:-55776446.76373037,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;Lorem Excepteur sit quis&quot;},{&quot;id&quot;:&quot;voluptate labore&quot;,&quot;type&quot;:&quot;laborum sint labore incididunt cupidatat&quot;,&quot;url&quot;:&quot;fugiat est&quot;,&quot;name&quot;:&quot;nisi voluptate labore&quot;,&quot;size&quot;:16826023.61016725,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;ipsum&quot;}]}],&quot;participants&quot;:[{&quot;id&quot;:&quot;adipisicing cupidatat&quot;,&quot;name&quot;:&quot;culpa eiusmod labore ullamco velit&quot;,&quot;role&quot;:&quot;source_user&quot;,&quot;avatar_url&quot;:&quot;sit veniam sunt dolore&quot;,&quot;fetch_avatar&quot;:false,&quot;avatar_expires&quot;:false},{&quot;id&quot;:&quot;quis sit aliqui&quot;,&quot;name&quot;:&quot;consequat Lorem ipsum ex enim&quot;,&quot;role&quot;:&quot;end_user&quot;,&quot;avatar_url&quot;:&quot;cupidatat cillum id commodo&quot;,&quot;fetch_avatar&quot;:false,&quot;avatar_expires&quot;:false}]},&quot;additional_data&quot;:{&quot;after&quot;:&quot;ullamco non proident&quot;}}