Get a conversation

Get a conversation by its ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

conversation_idstringRequiredformat: "id"

The ID of the conversation to retrieve

Response

Conversation retrieved

idstringOptionalRead-onlyformat: "id"

The ID of the conversation

channel_idstringOptional

The ID of the channel

end_user_idstringOptionalformat: "id"

The ID of the end user participating in the conversation

statusenumOptionalRead-only

The status of the conversation

created_atstringOptionalRead-only

The date and time the conversation was created

updated_atstringOptionalRead-only

The date and time the conversation was last updated

metadatamap from strings to strings or booleans or integers or doublesOptional

A dictionary of key value pairs assigned to the conversation. Note: This metadata does not create or set Ada metavariables. To create or update metavariables, use the End Users API.

metadata keys may only be of type: string
metadata values may only be one of type: string, boolean, integer, or number (float)

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

1	import requests
2
3	url = "https://example.ada.support/api/v2/conversations/conversation_id/"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "5df263b7db5a7e6ea03fae9b",
3	"channel_id": "5df263b7db5a7e6ea03fae9b",
4	"end_user_id": "5df263b7db5a7e6ea03fae9b",
5	"status": "active",
6	"created_at": "2020-09-20T00:00:00+00:00",
7	"updated_at": "2020-09-20T00:00:00+00:00",
8	"metadata": {
9	"pass": "example_string_value",
10	"initial_url": "https://example.com",
11	"locale": "en-CA",
12	"confidence": 0.95
13	}
14	}