Message notification list

get

https://temvox.com/api/v1/statistics/messaging/messages

Use this endpoint to get list of message notifications.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

withoutCount

boolean

Defaults to false

Determines whether to return the total number of records.

withoutItems

boolean

Defaults to false

Determines whether to return the record list.

limit

integer

Defaults to 10

Maxium number of returning records.

offset

integer

Starting point to return records from a result set.

page

integer

Page number, used to paginate over all records.

fields

string

Comma-separated list of a record's fields to be fetched

from

string

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

output

string

enum

Determines the output format.

Allowed:

filename

string

Base filename (without extension) to be downloaded.

archive

boolean

Determines whether the zip archive should be returned.

keyword

string

Any text to search by id, flowId, groupId, bulkId, status, channel type, email, phone or pushRegistrationId

sort

string

Comma-separated list of fields to sort by. Each sort field can have special prefix indicating a desirable sort order: + (ascending order, default) or - (descending order). The available sort fields: status, channel, createdAt, sentAt and deliveredAt.

string

Comma-separated list of message identifiers.

bulkId

string

Comma-separated list of bulk identifiers.

groupId

string

Comma-separated list of group identifiers.

flowId

string

Comma-separated list of flowId identifiers.

taskId

string

Comma-separated list of task identifiers.

status

string

enum

The message status.

channel

string

enum

The channel type.

Allowed:

Responses

400

Invalid input parameters

401

User is not authenticated

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

5XXUnexpected error