Use this endpoint to check a conversation before acting on it: who participates, who owns it, and which channel it uses.
Request
Send a GET request with the conversation ID in the path. There is no request body. Subiz reads the conversation in the account of your access token.
| Parameter | Type | Description |
|---|---|---|
cid (path) |
string | Conversation ID. |
Response
A successful request returns HTTP 200 with a Conversation object. Selected fields:
{
"id": "conversation_example",
"account_id": "account_example",
"created": 1763107200000,
"state": "active",
"assignee": "agent_example",
"members": [
{
"id": "user_example",
"type": "user",
"membership": "active"
},
{
"id": "agent_example",
"type": "agent",
"conversation_id": "conversation_example",
"membership": "active"
}
],
"touchpoint": {
"channel": "facebook",
"source": "page_example",
"id": "profile_example"
}
}
| Field | Description |
|---|---|
id |
Conversation ID. |
state |
Current state, such as active or ended. |
assignee |
Agent responsible for the conversation. Omitted when unassigned. |
members |
Participants. Each has a type (user for the customer, agent for staff), an id, and a membership state. |
touchpoint |
Channel the conversation happens on. |
created, ended |
Unix timestamps in milliseconds. ended is omitted while the conversation is open. |
last_message_sent |
The latest non-internal message event, when present. |
Empty fields are omitted. The object has more fields than shown; ignore those your integration does not use.
Next steps
- Read the messages with Read message history.
- Add an agent as a participant with Invite an agent.
- Change the owner with Assign an agent.
Being a member and being the assignee are separate. An agent can own a conversation without being in members.
HTTP request
Replace YOUR_CID with the conversation ID and YOUR_ACCESS_TOKEN with your token.
GET https://api.subiz.com.vn/4.0/conversations/YOUR_CID
Authorization: Bearer YOUR_ACCESS_TOKEN