Admin SMS Logs

Get paginated SMS/message logs for a tenant with optional filters

POST /v2/admin/reporting/messages/logs

Admin SMS Logs

cURL

curl --request POST \
  --url https://api.voxo.co/v2/admin/reporting/messages/logs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1,
  "startDate": "<string>",
  "endDate": "<string>"
}
'

200

{
  "records": [
    {
      "id": 123,
      "direction": "<string>",
      "from": "<string>",
      "to": "<string>",
      "body": "<string>",
      "status": "<string>",
      "timestamp": "<string>",
      "peerName": "<string>",
      "name": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "maxPage": 123
}

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

Required range: x > 0

startDate · string · required

Start date for the report period

endDate · string · required

End date for the report period

users · string[] enum<string>

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

groups · object[]

Filter by groups (queue, huntlist, or branch)

Show child attributes

phoneNumber · string[]

Filter by phone numbers

direction · Option 1 · enum<string> Option 2 · enum<string>

Message direction filter (inbound or outbound)

Available options: inbound

recordsPerPage · number

Number of records per page

page · number

Page number

reportType · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Report type (Scheduled, Export, or Live)

Available options: Scheduled

Response

200

application/json

SMS logs or export acknowledgement

Option 1

Option 2

Paginated SMS logs

records · object[] · required

SMS log records

Show child attributes

total · number · required

Total matching records

page · number · required

Current page number

maxPage · number · required

Maximum page number