Get user conversations


List all channels with information containing sender name & email, messages and timestamps.

GET

/channels/

Parameters
Type
Description
client_user_id
integer
Unique ID provided in clientuser model

Optionally, you can set status parameter to the request URL to narrow the results. This will show only opened channels.

Request URL would look like this:

https://app.userengage.com/api/public/users/:client_user_id/conversations/?status=true
curl -X GET -H "Authorization: Token <your_64_char_api_key>" "https://app.userengage.com/api/public/users/:client_user_id/conversations/"

Response

{
    "count": 4,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 6,
            "user": {
                "name": "user@email.com",
                "key": "I8REkrrhPWes",
                "id": 2039,
                "email": "user@email.com"
            },
            "active": false,
            "agent": null,
            "messages": 1
        },
        {
            "id": 5,
            "user": {
                "name": "user@email.com",
                "key": "I8REkrrhPWes",
                "id": 2039,
                "email": "user@email.com"
            },
            "active": false,
            "agent": null,
            "messages": 1
        },
        {
            "id": 4,
            "user": {
                "name": "user@email.com",
                "key": "I8REkrrhPWes",
                "id": 2039,
                "email": "user@email.com"
            },
            "active": false,
            "agent": null,
            "messages": 1
        },
        {
            "id": 3,
            "user": {
                "name": "user@email.com",
                "key": "I8REkrrhPWes",
                "id": 2039,
                "email": "user@email.com"
            },
            "active": false,
            "agent": null,
            "messages": 1
        }
    ]
}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://app.userengage.com/api/public/users/:client_user_id/conversations/",
  "method": "GET",
  "headers": {
    "authorization": "Token <your_64_char_api_key>"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.userengage.com/api/public/users/:client_user_id/conversations/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.userengage.com/api/public/users/:client_user_id/conversations/',
  headers: { authorization: 'Token <your_64_char_api_key>' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
<?php

$request = new HttpRequest();
$request->setUrl('https://app.userengage.com/api/public/users/:client_user_id/conversations/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'authorization' => 'Token <your_64_char_api_key>'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
import requests

url = "https://app.userengage.com/api/public/users/:client_user_id/conversations/"

headers = {'authorization': 'Token <your_64_char_api_key>'}

response = requests.request("GET", url, headers=headers)

print(response.text)
import http.client

conn = http.client.HTTPSConnection("app.userengage.com")

headers = { 'authorization': "Token <your_64_char_api_key>" }

conn.request("GET", "/api/public/users/:client_user_id/conversations/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))