Get paginated telephony detail records for an organization

GET

/api/organizations/{id}/telephony/detail-records

const url = 'https://example.com/api/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/telephony/detail-records?page=1&page_size=20&date_range=today&direction=all';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/telephony/detail-records?page=1&page_size=20&date_range=today&direction=all' \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string format: uuid

Query Parameters

page

integer

default: 1

page_size

integer

default: 20

date_range

string

Allowed values: today yesterday last_month last_30_days all_time

direction

string

Allowed values: all inbound outbound

Responses

200

Paginated telephony detail records

application/json

object

records

required

Array<object>

object

uuid

required

string

direction

required

string

cli

required

string

cld

required

string

message_type

string

default: SMS

status

required

string

delivery_status

string

carrier

string

carrier_fee

string

rate

string

cost

required

string

currency

string

default: USD

created_at

string

sent_at

string

page

required

integer

page_size

required

integer

total_records

required

integer

total_pages

required

integer

Example

{
  "records": [
    {
      "message_type": "SMS",
      "currency": "USD"
    }
  ]
}

401

Unauthorized

403

Forbidden

404

Organization not found