Skip to content

smsOutUdrReport

(...args)
SmsOutUdrQueryResult

Query for smsOutUdrReport.

Arguments
customerId
String!,non-nullrequired
Your customer ID.
datePeriod
DatePeriod!,non-nullrequired
filter
SmsOutColumnUdrFilters
page
Int
Default: 0
The requested page index. The first page is 0.
size
Int
Default: 500
Maximum 10,000 rows per page. For larger reports, please refer to our asynchronous reporting.
sort
SortDirection
Default: "ASC"
Return type
SmsOutUdrQueryResult
content
[SmsOutUdrReportRecord!]!,non-null
List of SMS outbound usage detail records.
pageIndex
Int
Page number of the response, starting at 0.
pageSize
Int
Page size of the response.
hasMoreElements
Boolean
Flag indicating if more pages are available.
Query sample
query smsOutUdrReport(
  $customerId: String!
  $datePeriod: DatePeriod!
  $filter: SmsOutColumnUdrFilters
  $page: Int
  $size: Int
  $sort: SortDirection
) {
  smsOutUdrReport(
    customerId: $customerId
    datePeriod: $datePeriod
    filter: $filter
    page: $page
    size: $size
    sort: $sort
  ) {
    content {
      __typename
      # ...SmsOutUdrReportRecordFragment
    }
    pageIndex
    pageSize
    hasMoreElements
  }
}
Variables
{
  "customerId": "Example String",
  "datePeriod": {
    "fromIncluded": "Example String",
    "toExcluded": "Example String"
  },
  "filter": {
    "service": {
      "__typename": "ColumnFilter"
    },
    "statusCode": {
      "__typename": "ColumnFilter"
    },
    "recipient": {
      "__typename": "ColumnFilter"
    },
    "reference": {
      "__typename": "ColumnFilter"
    }
  },
  "page": 40,
  "size": 40,
  "sort": "ASC"
}
Response sample
{
  "data": {
    "content": [
      {
        "__typename": "SmsOutUdrReportRecord"
      }
    ],
    "pageIndex": 40,
    "pageSize": 40,
    "hasMoreElements": true
  }
}