Find messages

GET

public

messages

curl --request GET \
  --url https://web-api.clerk.chat/public/messages \
  --header 'apiKey: <api-key>'

{
  "data": [
    {
      "id": 1,
      "body": "Hello, world!",
      "conversationId": "1",
      "userId": "1",
      "campaignMessageId": 1,
      "campaignId": 1,
      "channelId": "00000000-0000-0000-0000-000000000000",
      "inboxId": "00000000-0000-0000-0000-000000000000",
      "inbound": true,
      "members": [
        "+1415456789"
      ],
      "sender": "+1415456789",
      "senderType": "user",
      "status": "delivered",
      "error": "<string>",
      "sentByName": "Clerk",
      "errorCode": 123,
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-01T00:00:00.000Z",
      "seen": true,
      "externalId": "external-id",
      "segments": 1,
      "timestamp": "2021-01-01T00:00:00.000Z"
    }
  ],
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  },
  "total": 1
}

Authorizations

apiKey

string

header

required

Query Parameters

inboxIds

string[]

The IDs of the inboxes to filter messages by. If not provided, all inboxes will be included.

start

string

Only messages after this date until the end date or now

end

string

Only messages up to this date

limit

number

Number of items to return (max 50)

page

number

Page number

Response

200

application/json

A paginated list of messages

data

object[]

required

Represents a message resource

data.id

number

required

The ID of the resource

Example:

1

data.body

string

required

The message text

Example:

"Hello, world!"

data.conversationId

string

required

The associated Conversation ID

Example:

"1"

data.inbound

boolean

required

Whether the message was received (true) or sent (false)

Example:

true

data.members

string[]

required

The phone numbers or identifiers of message participants

Example:

["+1415456789"]

data.sender

string

required

The phone number or identifier of the message sender

Example:

"+1415456789"

data.senderType

enum<string>

required

The type of sender

Available options:

ai_pipeline,

assistant,

user,

campaign,

campaign_message,

workflow

Example:

"user"

data.status

enum<string>

required

The status of the message

Available options:

sending,

scheduled,

sent,

delivered,

failed,

read

Example:

"delivered"

data.created

string

required

The date and time the resource was created

Example:

"2021-01-01T00:00:00.000Z"

data.updated

string

required

The date and time the resource was last updated

Example:

"2021-01-01T00:00:00.000Z"

data.seen

boolean

required

Whether the message has been seen

Example:

true

data.segments

number

required

Number of SMS message segments used by the message

Example:

1

data.timestamp

string

required

The timestamp associated with the message

Example:

"2021-01-01T00:00:00.000Z"

data.userId

string | null

The ID of the user who created the resource

Example:

"1"

data.campaignMessageId

number | null

The ID of the campaign message

Example:

1

data.campaignId

number | null

The associated Campaign ID

Example:

1

data.channelId

string | null

The associated Channel ID

Example:

"00000000-0000-0000-0000-000000000000"

data.inboxId

string | null

The associated Inbox ID

Example:

"00000000-0000-0000-0000-000000000000"

data.error

string | null

The error message if the message failed to send

data.sentByName

string | null

The name of the sender displayed in the UI

Example:

"Clerk"

data.errorCode

number | null

The error code if the message failed to send

Example:

123

data.externalId

string | null

The external ID of the resource

Example:

"external-id"

total

number

required

The total number of messages

Example:

1

links

object

Send a message

curl --request GET \
  --url https://web-api.clerk.chat/public/messages \
  --header 'apiKey: <api-key>'

{
  "data": [
    {
      "id": 1,
      "body": "Hello, world!",
      "conversationId": "1",
      "userId": "1",
      "campaignMessageId": 1,
      "campaignId": 1,
      "channelId": "00000000-0000-0000-0000-000000000000",
      "inboxId": "00000000-0000-0000-0000-000000000000",
      "inbound": true,
      "members": [
        "+1415456789"
      ],
      "sender": "+1415456789",
      "senderType": "user",
      "status": "delivered",
      "error": "<string>",
      "sentByName": "Clerk",
      "errorCode": 123,
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-01T00:00:00.000Z",
      "seen": true,
      "externalId": "external-id",
      "segments": 1,
      "timestamp": "2021-01-01T00:00:00.000Z"
    }
  ],
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  },
  "total": 1
}

Public

Public Admin

Authorizations

Query Parameters

Response