Conversations

This section contains what all conversations related actions can be performed using Admin APIs.

Get All Conversations

Retrieves all conversations of a target user.

GET https://api.channelize.io/v1/conversations/

Query Params

The following table lists the parameters this API call supports to get filtered results.

Parameter	Type	Required	Default	Description
memberId	string	no	null	Restricts the search scope to only retrieve the target user's conversations.
isGroup	boolean	no	null	Restricts the search scope to only retrieve private 1-to-1 or group conversations. If set to true, group conversations are returned. If set to false, private 1-to-1 conversations are returned in the response.
includeDeleted	boolean	no	false	Determines whether to include deleted conversation in response.
includeOnlyActive	string	no	false	Restricts the search scope to retrieve only conversations in which the user is active.
sort	string	no	updatedAt DESC	Specifies the sorting criteria for the returned results. Allowed values are updatedAt ASC and updatedAt DESC.
include	string	no	null	Specifies extra fields if you want extra information to be appended with the conversation objects. Allowed values are membersList and messages.
limit	int	no	25	Specifies the number of results to return.
skip	int	no	0	Specifies the number of results you want to skip from the beginning.

Request Example

https://api.channelize.io/v1/conversations?includeDeleted=false&limit=10

Response

Status Code: 201

[
    {
        "id": "42ab4d40-666a-11e9-bdcd-0bf68210bf49",
        "title": "Soccer Group",
        "memberCount": 20,
        "isGroup": true,
        "ownerId": "20697",
        "profileImageUrl": null,
        "createdAt": "2019-04-24T08:23:38.260Z"
    },
    {
        "id":"a357c350-507e-11e9-9602-77ade703151b",
        "title":"Roomates Group",
        "memberCount":6,
        "isGroup":false,
        "ownerId":"20697",
        "profileImageUrl":null,
        "createdAt":"2019-03-27T10:54:04.805Z"
    },
    {
        "id":"6f877f60-5d18-11e9-8c71-9b3ad3c868c4",
        "title":"Avengers Group",
        "memberCount":13,
        "isGroup":true,
        "ownerId":"20456",
        "profileImageUrl":null,
        "createdAt":"2019-04-12T11:45:14.326Z"
    }

]