Get organization telephony activity, provisioning, and costs report

GET

/api/organizations/{id}/telephony/reports

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

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

date_range

string

Allowed values: today yesterday last_month last_30_days all_time

direction

string

Allowed values: all inbound outbound

Responses

200

Telephony report summary and detail records

Media typeapplication/json

object

organization_id

required

string format: uuid

phone_numbers

required

Array<object>

object

phone_number

required

string

status

required

string

monthly_cost

string

default: 1.00

upfront_cost

string

default: 1.00

currency

string

default: USD

tcr_brand

object

brand_id

string

status

string

brand_type

string

display_name

string

tcr_campaign

object

campaign_id

string

status

string

usecase

string

monthly_fee

string

summary

required

object

total_spend

required

string

currency

required

string

default: USD

monthly_budget

required

integer

provisioning_cost

required

string

ten_dlc_cost

required

string

messaging_cost

required

string

total_messages_sent

required

integer

total_messages_received

required

integer

detail_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

Example

{
  "phone_numbers": [
    {
      "monthly_cost": "1.00",
      "upfront_cost": "1.00",
      "currency": "USD"
    }
  ],
  "summary": {
    "currency": "USD"
  },
  "detail_records": [
    {
      "message_type": "SMS",
      "currency": "USD"
    }
  ]
}

401

Unauthorized

403

Forbidden

404

Organization not found