GET reports/delivery

callfire.com:V2

Summary: Get delivery reports by ad hoc criteria
Operation ID: getDeliveryReports
Auth: unknown
Description

Get delivery reports

Parameters (11)

campaignId (integer, query, optional)

~

carrier (string, query, optional)

~

deliveryCategory (string, query, optional)

~

Constraints: {'enum': ['NO_DATA', 'OPTED_OUT', 'BOUNCED', 'NO_CREDITS', 'DELIVERED']}

deliveryState (string, query, optional)

~

Constraints: {'enum': ['DELIVERED', 'UNSENT_OPTED_OUT_GLOBAL', 'UNSENT_OPTED_OUT_LOCAL', 'UNSENT_NO_CREDITS', 'GATEWAY_REJECTED', 'CARRIER_REJECTED', 'NOT_DELIVERED', 'UNSENT_INVALID_NUMBER', 'UNSENT_BAD_DATA', 'UNSENT_FORCE_STOPPED', 'UNSENT_PERIOD_LIMIT', 'UNSENT_INTERNATIONAL', 'UNSENT_INVALID_TIMEZONE_OR_DNC', 'UNSENT_ALREADY_SCRUBBED', 'UNSENT_SYSTEM_ERROR', 'UNSENT_NO_WIRELESS_CARRIER', 'UNSENT_MESSAGE_TOO_LONG', 'UNSENT_MESSAGE_BLOCKED', 'UNSENT_QUEUE_LIMIT_REACHED', 'UNSENT_TOKEN_LIMIT_REACHED', 'UNSENT_TIME_LIMIT_REACHED', 'UNSENT_SCHEDULER_CAPACITY_EXCEEDED', 'SPAM_DETECTED', 'UNSENT_NO_GATEWAY', 'UNSENT_DAILY_LIMIT_REACHED', 'ORIGINATED', 'SUBMITTED', 'FORWARDED', 'NOT_GIVEN', 'UNKNOWN', 'RETRY_MMS_AS_SMS', 'QUEUED', 'QUEUED_TRANSCODE', 'ORIGINAL', 'DUPE', 'TRUNCATED', 'REQUEUED_RATE_LIMITED', 'BUFFERED', 'RATE_LIMIT_EXCEEDED', 'SERVICE_UNAVAILABLE', 'SEND_MMS_AS_SMS', 'REQUEUED_RECOVERABLE_ERROR', 'SEND_WITH_ADDITIONAL_SPID', 'UNSENT_FREE_TRIAL']}

endDate (string, query, optional)

~

fromNumber (string, query, optional)

~

limit (integer, query, optional, default: 100)

To set the maximum number of records to return in a paged list response. The default is 100

messageText (string, query, optional)

~

offset (integer, query, optional, default: 0)

Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

startDate (string, query, optional)

~

toNumber (string, query, optional)

~

No probe data for this endpoint yet.