Skip to content
digizeDocs

Get a conversation

GET
/api/v1/conversations/{id}
curl --request GET \
  --url https://digize.com/api/v1/conversations/example \
  --header 'x-api-key: <x-api-key>'

A conversation with its newest 500 messages and calls, oldest first, with links to their files and recordings.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
id
required
string
contact
required
object
id
required
string
name
required
string
firstName
required
string
email
required
string | null
phone
required
string | null
channel
required
string
Allowed values: sms email
address
required

The workspace’s number or address the contact writes to.

string
subject
required

Emails only.

string | null
status
required
string
Allowed values: open closed
assigneeId
required

The member answering it, by user id.

string | null
unread
required
boolean
lastMessage
required
Any of:
object
kind
required
string
Allowed values: message call
direction
required
string
Allowed values: in out
authorKind
required
string
Allowed values: contact team automation system
body
required

The start of it, on one line.

string
status
required
string
Allowed values: pending queued sent delivered failed undelivered received
sentAt
required
string format: date-time
lastMessageAt
required
string format: date-time
optedOut
required

A text conversation whose contact replied STOP: nothing can be texted to them until they reply START.

boolean
createdAt
required
string format: date-time
messages
required

Oldest first, the newest 500.

Array<object>
object
id
required
string
conversationId
required
string
kind
required

A text or email, or a call to one of the workspace’s numbers.

string
Allowed values: message call
direction
required
string
Allowed values: in out
author
required
One of:
object
kind
required
string
Allowed value: contact
from
required
string
to
required
string
subject
required
string | null
body
required
string
status
required

Pending until Twilio takes it, then queued, sent and delivered, or failed or undelivered; received for one that came in.

string
Allowed values: pending queued sent delivered failed undelivered received
error
required

Why it didn’t go.

string | null
attachments
required
Array<object>
object
name
required
string
type
required
string
size
required
number
url
required

A signed link that works for an hour.

string | null
fullEmailUrl
required

The whole email, when it was too long to show here.

string | null
call
required
Any of:
object
status
required
string
Allowed values: ringing answered completed missed voicemail failed
durationSeconds
required
number
recording
required
Any of:
object
kind
required
string
Allowed values: voicemail call
status
required
string
Allowed values: pending stored absent failed
seconds
required
number | null
url
required
string | null
sentAt
required
string format: date-time

Example 

{
  "channel": "sms",
  "status": "open",
  "lastMessage": {
    "kind": "message",
    "direction": "in",
    "authorKind": "contact",
    "status": "pending"
  },
  "messages": [
    {
      "kind": "message",
      "direction": "in",
      "author": {
        "kind": "contact"
      },
      "status": "pending",
      "call": {
        "status": "ringing",
        "recording": {
          "kind": "voicemail",
          "status": "pending"
        }
      }
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}