Get sendings

get

https://api.indigitall.com/v2/chat/{applicationId}/sending

Retrieve a list of sendings for a given application.

Path Params

applicationId

integer

required

Application's ID

Query Params

createdFrom

date-time

Filter sendings created from this date (inclusive).

createdTo

date-time

Filter sendings created to this date (inclusive).

scheduledFrom

date-time

Filter sendings scheduled from this date (inclusive).

The use of this parameter excludes sendings that aren't scheduled.

scheduledTo

date-time

Filter sendings scheduled to this date (inclusive).

The use of this parameter excludes sendings that aren't scheduled.

limit

integer

1 to 100

Defaults to 25

Limit the number of sendings returned

page

integer

≥ 0

Defaults to 0

Page number

campaignId

integer

Campaign's ID which the sending is associated with

onlyActive

boolean

Defaults to false

If true, only active sendings or those completed today or later are returned.

Active sendings are those whose sending task status is one of:

pending
queued
in_progress

Additionally, any sending whose sendingTask.finishedAt is greater than or equal to 24 hours ago is considered active.

Responses

Language

Credentials

Header

Response

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

application/json

200Retrieve information about a list of sendings

400Bad request

403Forbidden

500Internal server error