List conversations

List all conversations available to the custom adapter

A GET request to Medallia Conversations to return a list of al the conversations available to the adapter. Optionally the query can be filtered to return only the channels that contain one or more specific Labels.

Request URL

{conversations-api-gateway-host}/apis/v0/channels/{channel-guid}/conversations

Where

conversations-api-gateway-host: the Medallia Experience Cloud hostname to access the Medallia Conversations API gateway.
channel-guid: the ID of the Custom Channel assigned in Medallia Conversations.

Query parameters


f.labels `string`	List of one or more labels (case insensitive) that must be in list of Labels defined in the conversation. For example, this query returns all conversations that have both the labels "survey" and "frontdesk": `/?f.labels="survey,frontdesk"` Omit the query to return a list of all conversations available to the adapter.

Request headers

accept: text/plain 
authorization: Bearer 12345
content-type: application/json

For information about the authorization header, see Adapter authentication.

Responses


Response	Description
200	The request was processed as expected.
401	Unauthorized. The reason is provided in a human-readable string.
403	Forbidden. `statusCode`: The HTTP status code. `error`: The error code. `message`: The error message.
500	Internal server error. `statusCode`: The HTTP status code. `error`: The error code. `message`: The error message.

Response payload of a successful query

A array of channels (items[]) with information about each channel.

{
    "items": [
        {
            "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
            "title": "string",
            "description": "string",
            "keyword": [
                "string"
            ],
            "labels": [
                "string"
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "_total": 1
}

Response parameters


items `array[ object]` required	A array of zero or more channels that are available to the adapter based on the query parameters.
guid `string<uuid>` required	Channel unique identifier. Use this when sending communications from the adapter to the channel.
title `string` required	Channel title.
description `string` required	Channel Description.
keyword `array[string]` required	The labels defined for the channel, if any.
labels `array[string]` required	The labels defined for the channel.
created_at `string<date-time>` required	The creation timestamp in ISO-8601 UTC format (ex: yyyy-mm-ddThh:mm:ssZ).
updated_at `string<date-time>` required	The timestamp of the last modification in ISO-8601 UTC format (e.g.: yyyy-mm-ddThh:mm:ssZ).
_total `integer<int64>` required	Count of channels in the items[] array. Zero or more.