Messages

Search for SMS messages

The method is used to search for SMS messages using a part of their names or a tag. By default, a rate limit of 500 requests per hour applies. <br/>The method returns a maximum of 500 messages per request. <br/>The <b>TotalCount</b> header contains the number of messages returned by the query.<br/>

get/api/v1/messages/sms

Request

Query parameters

searchstring

Search condition (a part of the message name or a tag)

startindexinteger
maxrowsinteger

Response

idinteger

Message ID.

namestring required

Message name.

languageCodestring

Language code.

tagsstring[]

List of tags.

subscriptionsKeysstring[]

Subscription categories keys, assigned to a message.

languagesstring[]

An array with the language codes for multilingual messages. Available for the GET method only.

fromstring required

Sender name.

textstring required

Message text.

trackUrlsboolean

The parameter determines whether to track links in a message or not. The default value is ‘false’.

Changes

No recorded changes to this operation across all 2 revisions of this API.