v1

latestOpenAPI 3.1.02026-07-2454140152.8 KB

Messages

Get Your Messages

get/v1/messages

page_sizestring

Default value is 10, can be at maximum 1000

page_tokenstring

Found in pagination links and can be used to get 'previous' or 'next' items

filter[countries]string[]

Filter by country ISO codes

filter[sender_ids]string[]

Filter by sender IDs

filter[created_date_start]string date-time

Shows messages created from the specified date and time. Date format should be in yyyy-MM-dd HH:mm:ss

filter[created_date_end]string date-time

Shows messages created up to the specified date and time. Date format should be in yyyy-MM-dd HH:mm:ss

filter[statuses]EnumMessageStatuses[]

Filter by statuses. Enumeration values [delivered, sent, failed, enroute, read, rejected, unsubscribed, expired, blocked]

filter[to]string

Filter by the specified phone number

filter[from]string

Filter by the specified sender

filter[to_prefix]string

Filter(Starts With) by the specified phone number

filter[channel]'SMS' | 'VIBER' | 'WHATSAPP'

Filter Senders by Channel. Enumeration values [SMS, VIBER, WHATSAPP]

filter[campaign_ids]string[]

Filter by campaign IDs