Skip to main content
GET
List messages

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

filter
object

Fields encoded with qs bracket notation.

skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

Response

Messages list

id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
content
string
required
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND
status
enum<string>
required
Available options:
QUEUED,
SENT,
DELIVERED,
READ,
FAILED,
UNKNOWN,
RECEIVED,
DELAYED
failureReason
enum<string> | null
required
Available options:
MESSAGE_EXPIRED,
AUTHENTICATION_FAILED,
ACCESS_DENIED,
INVALID_MESSAGE_PARAMETER,
SERVICE_UNAVAILABLE,
RATE_LIMIT_HIT,
ACCOUNT_RESTRICTED,
COUNTRY_RESTRICTED,
SENDER_RECIPIENT_SAME,
BUSINESS_PAYMENT_ISSUE,
MEDIA_ERROR,
UNSUPPORTED_MESSAGE_TYPE,
ACCOUNT_MAINTENANCE,
TEMPLATE_NOT_AVAILABLE,
TEMPLATE_PARAMETER_MISMATCH,
TEMPLATE_PAUSED,
TEMPLATE_DISABLED,
TEMPLATE_CLASSIFICATION_RESTRICTED,
FLOW_BLOCKED,
NUMBER_PART_OF_EXPERIMENT,
MESSAGE_UNDELIVERABLE,
HEALTHY_ECOSYSTEM_POLICY,
SPAM_RATE_LIMIT_HIT,
USER_OPTED_OUT_MARKETING_MESSAGES,
OUTSIDE_CONVERSATION_WINDOW,
BUSINESS_ACCOUNT_LOCKED,
UNKNOWN_ERROR,
WHATSAPP_PHONE_NUMBER_NOT_CONNECTED,
WHATSAPP_ACCOUNT_NOT_APPROVED,
WHATSAPP_DISPLAY_NAME_NOT_APPROVED,
null
channel
enum<string>
required
Available options:
EMAIL,
SMS,
WHATSAPP
sentAt
string<date-time> | null
required
from
string
required
to
string
required
source
enum<string>
required
Available options:
AUTOMATED,
ASSISTANT,
USER,
CUSTOMER
authorId
string | null
required
provider
enum<string>
required
Available options:
TWILIO,
SENDGRID,
WHATSAPP_API
providerMessageId
string | null
required
incomingMessageId
string | null
required
outboundMessageId
string | null
required
organizationId
string | null
required
conversationId
string | null
required