v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
reports

Get delivery reports by ad hoc criteria

Get delivery reports

get/reports/delivery

Query parameters

startDatestring

~

endDatestring

~

limitinteger

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

offsetinteger

Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API.

campaignIdinteger

~

fromNumberstring

~

toNumberstring

~

deliveryCategory'NO_DATA' | 'OPTED_OUT' | 'BOUNCED' | 'NO_CREDITS' | 'DELIVERED'

~

deliveryState'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_NON_A2P_BLOCKED' | 'UNSENT_A2P_NOT_ENABLED_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' | 'CONNECTOR_SELECTED' | 'TRUNCATED' | 'REQUEUED_RATE_LIMITED' | 'BUFFERED' | 'RATE_LIMIT_EXCEEDED' | 'SERVICE_UNAVAILABLE' | 'SEND_MMS_AS_SMS' | 'REQUEUED_RECOVERABLE_ERROR' | 'SEND_WITH_ADDITIONAL_SPID' | 'UNSENT_FREE_TRIAL' | 'PAUSED'

~

carrierstring

~

messageTextstring

~

Response

successful operation

limitinteger

~

offsetinteger

~

totalCountinteger

~