Messaging

Get communication history

Returns the entire communication history with prospect. All incoming and outgoing messages as well as activity logs

get/prospects/{prospect}/communication

Request

  • Base URL: http://bonzo.site/api/v3
  • URL: http://bonzo.site/api/v3/prospects/{prospect}/communication
  • Auth: HTTP bearer

Path parameters

prospectstring required
Example:1

Query parameters

only_activityboolean
per_pageinteger
pageinteger

Response

Success

Example response

{
  "data": {
    "user_id": "3",
    "created_at": "2022-01-01T01:00:00.000000Z",
    "status": "delivered",
    "audio_path": "https://example.com",
    "image_path": "Parsed json array",
    "subject": "Message subject",
    "content": "Message content",
    "type": "email",
    "direction": "outgoing",
    "source": "direct",
    "user_name": "John Doe",
    "avatar_url": "https://via.placeholder.com/128x128",
    "error_message": "Error message",
    "send_at": "2022-01-01T01:00:00.000000Z",
    "event_date": "2022-01-01 01:00:00"
  },
  "links": {
    "first": "https://example.com?page=1",
    "last": "https://example.com?page=3",
    "next": "https://example.com?page=2"
  },
  "meta": {
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://example.com?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": "https://example.com?page=2",
        "label": 2,
        "active": false
      },
      {
        "url": "https://example.com?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.