Get a conversation | Hams AI Docs

Authentication

api_access_tokenstring

An API key created in Settings > Developer. A user token works too and is useful while you experiment. A key is authorized at the account level: it reaches every inbox, conversation and contact in the account that issued it, and nothing outside that account.

Path parameters

account_idintegerRequired

Your account id.

conversation_idintegerRequired

The conversation's display id, as shown in the dashboard.

Response

The conversation.

idintegerOptional

display_idintegerOptional

inbox_idintegerOptional

statusenumOptional

can_replybooleanOptional

Whether a plain text message can be delivered right now. When false, send a template.

prioritystring or nullOptional

labelslist of stringsOptional

metamap from strings to anyOptional

The contact and assignee behind this conversation.

Errors

401

Unauthorized Error

404

Not Found Error

1	{
2	"id": 1,
3	"display_id": 1,
4	"inbox_id": 1,
5	"status": "open",
6	"can_reply": true,
7	"priority": "string",
8	"labels": [
9	"string"
10	],
11	"meta": {}
12	}