--- updatedAt: 2026-06-15T14:41:25.000Z agentTools: projectIndex: https://developers.dexatel.com/llms.txt --- # Get Your Messages
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Contacts and Messaging", "version": "v1" }, "servers": [ { "url": "https://api.dexatel.com", "description": "Server base url" } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/messages": { "get": { "tags": [ "Messages" ], "summary": "Get Your Messages", "operationId": "get_messages", "parameters": [ { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/page_token" }, { "$ref": "#/components/parameters/filter.countries" }, { "$ref": "#/components/parameters/filter.sender_ids" }, { "$ref": "#/components/parameters/filter.created_date_start" }, { "$ref": "#/components/parameters/filter.created_date_end" }, { "$ref": "#/components/parameters/filter.message_statuses" }, { "name": "filter[to]", "in": "query", "description": "Filter by the specified phone number", "schema": { "type": "string" } }, { "name": "filter[from]", "in": "query", "description": "Filter by the specified sender", "schema": { "type": "string" } }, { "name": "filter[to_prefix]", "in": "query", "description": "Filter(Starts With) by the specified phone number", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/filter.channel_plus_voice" }, { "name": "filter[campaign_ids]", "in": "query", "description": "Filter by campaign IDs", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponseListWrapperDto" } } } }, "400": { "description": "

Bad Request:

\n\n\n\n
CodeMessageDescription
1521Wrong date formatDate format should be in yyyy-MM-dd HH:mm:ss
" } } } } }, "components": { "parameters": { "page_size": { "in": "query", "name": "page_size", "schema": { "type": "string", "default": "10", "description": "Default value is 10, can be at maximum 1000" } }, "page_token": { "in": "query", "name": "page_token", "schema": { "type": "string", "description": "Found in pagination links and can be used to get 'previous' or 'next' items" } }, "filter.countries": { "name": "filter[countries]", "in": "query", "description": "Filter by country ISO codes", "schema": { "type": "array", "items": { "type": "string" } } }, "filter.sender_ids": { "name": "filter[sender_ids]", "in": "query", "description": "Filter by sender IDs", "schema": { "type": "array", "items": { "type": "string" } } }, "filter.created_date_start": { "name": "filter[created_date_start]", "in": "query", "description": "Shows messages created from the specified date and time.\n Date format should be in yyyy-MM-dd HH:mm:ss", "schema": { "type": "string", "format": "date-time" } }, "filter.created_date_end": { "name": "filter[created_date_end]", "in": "query", "description": "Shows messages created up to the specified date and time.\n Date format should be in yyyy-MM-dd HH:mm:ss", "schema": { "type": "string", "format": "date-time" } }, "filter.message_statuses": { "name": "filter[statuses]", "in": "query", "description": "Filter by statuses. Enumeration values [delivered, sent, failed, enroute, read, rejected, unsubscribed, expired, blocked]", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnumMessageStatuses" } } }, "filter.channel_plus_voice": { "in": "query", "name": "filter[channel]", "description": "Filter Senders by Channel. Enumeration values [SMS, VIBER, WHATSAPP]", "schema": { "$ref": "#/components/schemas/EnumChannelsPlusVoice" } } }, "schemas": { "EnumChannels": { "type": "string", "enum": [ "SMS", "VIBER", "WHATSAPP" ] }, "EnumChannelsPlusVoice": { "allOf": [ { "$ref": "#/components/schemas/EnumChannels" } ] }, "EnumMessageStatuses": { "type": "string", "enum": [ "delivered", "sent", "failed", "enroute", "read", "rejected", "unsubscribed", "expired", "blocked" ] }, "MessageResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the message" }, "account_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the account" }, "from": { "type": "string", "description": "Identifier of the sender(name)" }, "to": { "type": "string", "description": "Recipients phone number" }, "channel": { "allOf": [ { "$ref": "#/components/schemas/EnumChannelsPlusVoice" }, { "description": "Delivery channel of the message.\nEnumeration values [SMS, VIBER, WHATSAPP]" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/EnumMessageStatuses" }, { "description": "Message status. Enumeration values [delivered, sent, failed, enroute, read, rejected, unsubscribed, expired, blocked]" } ] }, "text": { "type": "string", "description": "Text of the message" }, "button": { "type": "object", "properties": { "type": { "type": "string", "description": "Button type of the message" }, "text": { "type": "string", "description": "Button text of the message" }, "value": { "type": "string", "description": "Button value of the message" }, "button_variables": { "type": "array", "items": { "type": "string" }, "description": "Dynamic URL segment values for call_to_action buttons." } } }, "create_date": { "type": "string", "format": "date-time", "description": "Creation date of the message in UTC, formatted as yyyy-mm-dd hh:mm:ss" }, "update_date": { "type": "string", "format": "date-time", "description": "Update date of the message in UTC, formatted as yyyy-mm-dd hh:mm:ss" }, "segment_count": { "type": "integer", "format": "int32", "description": "The count of message parts for [SMS] Channel, other channel messages are always in 1 segment" }, "encoding": { "type": "string", "description": "Encoding of the [SMS] message. Enumeration Values [GSM-7, UCS-2]" }, "country": { "type": "string", "description": "ISO code of the recipients number" } } }, "MessageResponseListWrapperDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/MessageResponseDto" }, { "properties": { "price": { "type": "number", "description": "Amount charged for the message in accounts currency" } } } ] } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } }, "Pagination": { "type": "object", "properties": { "number": { "type": "integer", "format": "int32", "description": "Current page number" }, "size": { "type": "integer", "format": "int32", "description": "Page size. Default value is 10, can be at maximum 1000" }, "total": { "type": "integer", "format": "int32", "description": "Total count of requested resources" }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginationLinks" }, { "description": "Contains URLs to get next/previous resources" } ] } } }, "PaginationLinks": { "type": "object", "properties": { "first": { "type": "string", "description": "URL to the first page" }, "current": { "type": "string", "description": "URL to the current page" }, "previous": { "type": "string", "description": "URL to the previous page, if any" }, "next": { "type": "string", "description": "URL to the next page, if any" } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Dexatel-Key" } } } } ```