Get Conversation

Retrieve details regarding a conversation by ID.

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/conversations/{conversation_id}
Method	JSON via GET

Authorization:

Header Parameter	Description
api_access_token	user API key

The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.

Path Parameters:

Parameter	Description	Required
account_id	The numeric id of the account	yes
conversation_id	The numeric id of the conversation	yes

Response:

{
  "meta": {
    "sender": {
      "additional_attributes": {},
      "availability_status": "offline",
      "email": "string",
      "id": 0,
      "name": "string",
      "phone_number": "string",
      "identifier": "string",
      "thumbnail": "string",
      "custom_attributes": {},
      "last_activity_at": 0,
      "blocked": false,
      "created_at": 0
    },
    "channel": "string",
    "team": {
      "id": 0,
      "name": "string",
      "description": "string",
      "allow_auto_assign": true,
      "account_id": 0,
      "is_member": true
    },
    "assignee": {
      "id": 0,
      "account_id": 0,
      "availability_status": "online",
      "auto_offline": true,
      "confirmed": true,
      "email": "string",
      "available_name": "string",
      "name": "string",
      "role": "administrator",
      "see_all_conversations": true,
      "thumbnail": "string"
    },
    "hmac_verified": false
  },
  "id": 0,
  "messages": [
    {
      "id": 0,
      "content": "string",
      "account_id": 0,
      "inbox_id": 0,
      "conversation_id": 0,
      "message_type": 0,
      "created_at": 0,
      "updated_at": "string",
      "private": false,
      "status": "sent",
      "source_id": "string",
      "content_type": "text",
      "content_attributes": {},
      "sender_type": 0,
      "sender_id": 0,
      "external_source_ids": {},
      "additional_attributes": {},
      "label_list": ["string"],
      "created_at_exact": "string",
      "conversation": {
        "assignee_id": 0,
        "unread_count": 0
      }
    }
  ],
  "account_id": 0,
  "additional_attributes": {},
  "agent_last_seen_at": 0,
  "assignee_last_seen_at": 0,
  "can_reply": false,
  "contact_last_seen_at": 0,
  "custom_attributes": {},
  "inbox_id": 0,
  "labels": ["string"],
  "muted": false,
  "snoozed_until": null,
  "status": "open",
  "created_at": 0,
  "timestamp": 0,
  "first_reply_created_at": 0,
  "unread_count": 0,
  "last_non_activity_message": {
    "id": 0,
    "content": "string",
    "account_id": 0,
    "inbox_id": 0,
    "conversation_id": 0,
    "message_type": 1,
    "created_at": 0,
    "updated_at": "string",
    "private": false,
    "status": "read",
    "source_id": "string",
    "content_type": "text",
    "content_attributes": {},
    "sender_type": "User",
    "sender_id": 0,
    "external_source_ids": {},
    "additional_attributes": {},
    "label_list": ["string"],
    "created_at_exact": "string",
    "conversation": {
      "assignee_id": 0,
      "unread_count": 0
    },
    "sender": {
      "id": 0,
      "name": "string",
      "available_name": "string",
      "email": "string",
      "avatar_url": "string",
      "logo_user_url": "string",
      "type": "user",
      "availability_status": "busy",
      "thumbnail": "string"
    }
  }
}

Response-Explain:

Parameter	Description
meta	Object containing conversations metadata
meta -> sender	Object containing sender data
meta -> channel	Channel type
meta -> team	Object containing assigned team data (for
meta -> assignee	Object containing assignee data
meta -> hmac_verified
id	Conversation numeric id
status	The status of the conversation Enum: `"open"` `"resolved"` `"pending"` `"snoozed"`
messages	Array of objects (message)
account_id	Account numeric id
inbox_id	Inbox numeric id
labels	Array of strings (label)
unread_count	The number of unread messages
contact_last_seen_at	The last time a contact interacted with your service
can_reply	Whether the conversation is currently within messaging window
muted	Whether the conversation is currently muted
snoozed_until	The time at which previously snoozed conversation is reactivated
assignee_last_seen_at	The last time at which the assignee was available
agent_last_seen_at	The last time at which the agent was available
additional_attributes	Object containing additional attributes related to the conversation
custom_attributes	Object containing custom attributes related to the conversation
created_at	The time at which conversation was created
first_reply_created_at	The time at which the first reply was sent
last_non_activity_message	Object containing last non-activity message (incoming, outgoing, template)

Created with the Personal Edition of HelpNDoc: Free HTML Help documentation generator