Track multiple messages with filters for a specific time range

post

https://connect.routee.net/sms/tracking

Limit the tracking result of multiple sms by passing filters (accept a date range only for the latest 7 days).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

RESPONSE PARAMETERS

KEY	DESCRIPTION
totalPages	The number of total pages.
last	Whether the current page is the last one.
totalElements	The total amount of elements for the current search.
first	Whether the current page is the first one.
numberOfElements	The number of elements currently on this page.
number	The requested page number.
size	The requested page size.
content	Contains the search results.
content.applicationName	The name of the application that was used to send this message.
content.campaignName	The name of the campaign that this message was send from.
content.campaignTrackingId	The tracking id of the campaign that this message was sent from.
content.country	The country of the recipient in ISO 3166-1 alpha 2 format.
content.smsId	The unique id of one SMS part included in a message. If the message is multipart then these values will be different for each part.
content.messageId	The id of the message. All the parts of a multipart SMS have the same messageId.
content.groups	The groups that the recipient belongs to.
content.body	The message of the SMS.
content.operator	The operator of the recipient.
content.originatingService	The service that sent this message.
content.to	The recipient.
content.latency	The overall delivery latency of the message.
content.parts	The number of actual SMS parts.
content.part	The number of the current SMS part.
content.price	The cost of this SMS part.
content.label	The label that was given to the SMS tracking.
content.status	Information about the Sms status.
content.status.date	The date that the status was reported.
content.status.status	The status of the SMS. Check here for possible values.
content.status.reason	The reason of the status
content.status.reason.detailedStatus	The detailed status. Possible values: Sent, Delivered, Undelivered, Failed, Undelivered on Handset, Unknown Number, Roaming, Call Barred, Unknown Status, Carrier Violation, Expired. Check here for details.
content.status.reason.description	The description of the detailed status
content.from	The sender Id of the message
content.direction	The direction of the message. Possible values: "Inbound", "Outbound"
content.receivedDate	The date that an inbound message has received.

ERROR CODES

STATUS	CODE	DESCRIPTION
404	404001001	Account not found.
400	404009001	Campaign not found.

Query Params

dateStart

date

required

ISO-8601 date-time format (accept a date range only for the latest 7 days)

dateEnd

date

required

ISO-8601 date-time format (accept a date range only for the latest 7 days)

page

int32

Defaults to 0

The page number to retrieve, default value is 0 (meaning the first page).

size

int32

Defaults to 20

The number of items to retrieve, default value is 20. Max value is 2000.

sort

string

The field name that will be used to sort the results.

trackingId

string

If provided then only the SMS messages for the specific Campaign Tracking Id will be retrieved.

campaign

boolean

If true it will return only SMS messages that belong to an SMS campaign.

Body Params

fieldName

string

required

The name of the field to filter. Available values: smsId, to, status.status, direction, label, campaign

searchTerm

string

required

The exact value that the specified field must match.

searchOperator

string

Defaults to "is"

Optional: The operator upon which the search operation will be executed. Possible values: 'is', 'is_not', 'contains', 'starts_with', 'ends_with'. If missing defaults to 'is'.

Headers

Content-Type

string

required

Defaults to application/json

application/json

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400