Skip to main content
POST
Admin SMS Logs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required

Tenant ID

startDate
string
required

Start date for the report period

endDate
string
required

End date for the report period

users

Filter by user peer names, or 'ALL' for all users

groups
object[]

Filter by groups (queue, huntlist, or branch)

phoneNumber
string[]

Filter by phone numbers

direction

Message direction filter (inbound or outbound)

Available options:
inbound
reportType

Report type (Scheduled, Export, or Live)

Available options:
Scheduled
query
string

Search messages by number or text

paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
page
number

Page number

recordsPerPage
number

Records per page

sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc

Response

200 - application/json

SMS logs or export acknowledgement

Paginated SMS logs

records
object[]
required
page
number
required
maxPage
number
required
totalRecords
number
required