Get conversation

This method allows you to get data about a specific dialog.

URL

GET https://api.dashly.app/v1/conversations/{id}

The conversation ID should be used as {id}.

Arguments

This method follows the general rules. Arguments are transmitted as GET or POST parameters.

Argument Description
auth_token Required. Authorization token (requires scope: conversations-read)

Answer

{
  "data": {
    "id": 7100586,
    "created": 1450342055,
    "user": {
      "id": 7722092,
      "app": 3,
      "user_id": "27384",
      "presence": "idle",
      "props": {
        "$last_seen": "2015-12-17T13:01:32",
        "$name": "Alex",
        "$email": "alex@example.com",
        ...
      }
    },
    "read": true,
    "replied": true,
    "clicked": false,
    "unsubscribed": false,
    "closed": false,
    "message": null,
    "type": "popup_chat",
    "reply_type": "text",
    "part_last": {
      "id": 7855356,
      "created": 1450345019,
      "conversation": 7100586,
      "body": "...",
      "type": "reply_user",
      "sent_via": "web_user",
      "from": 16588048
    },
    "parts_count": 13,
    "assignee": null,
    "unread_parts_count": 2,
    "last_admin": {
      "id": 24601,
      "name": "Maks",
      "avatar": "https://files.dashly.app/avatars/1446021235578-n653y667.jpg",
      "type": "admin"
    },
    "last_update": 1450345019,
    "tags": []
  }
  "meta": {
    "status": 200
  }
}

Answer contains Conversation object.

Errors

This table contains errors that can be returned. However, in case of unforeseen situations (in case of the service's inoperability), other errors may occur. Always check meta.status parameter.

Error Description
MethodNotAllowed Invalid http method
AuthenticationFailed Invalid (or missing) auth token
PermissionDenied There is no access to this conversation (most likely the conversation belongs to another application)

Example

curl -X GET https://api.dashly.app/v1/conversations/313341?auth_token=XXX