Menu
POST telephony/v1/calls/outbound/ Service tier

Server-placed calls (play a recording, or an agent: Phase 6). Seat calls go through the browser dialer and the TwiML App instead.

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/calls/outbound/

Body keys (JSON)

KeyRequiredDefault
audio_urloptional or conditionalnone
modeoptional or conditionalnone
number_public_idoptional or conditionalnone
tooptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

201 data and meta envelope

{
  "data": {
    "call_public_id": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_request
400mode_not_available
404number_not_found
502call_failed

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/calls/outbound/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com" \
  -H "Content-Type: application/json" \
  -d '{
  "audio_url": "...",
  "mode": "...",
  "number_public_id": "...",
  "to": "..."
}'

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.calls_outbound)

GET telephony/v1/calls/{call_public_id}/ Service tier

Read one of the telephony by id. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/calls/{call_public_id}/

Path parameters

NameType
call_public_idstr

Responses

200 data and meta envelope

{
  "data": {
    "call_public_id": "...",
    "number_public_id": "...",
    "direction": "...",
    "from": "...",
    "to": "...",
    "mode": "...",
    "status": "...",
    "seat_email": "...",
    "started_at": "2026-01-01T00:00:00Z",
    "ended_at": "2026-01-01T00:00:00Z",
    "duration_seconds": 0,
    "recording_url": "...",
    "is_voicemail": true,
    "transcript_url": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
404call_not_found

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/calls/CALL_PUBLIC_ID/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.call_detail)

GET telephony/v1/numbers/ Service tier

List telephony. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/numbers/

Query parameters

NameDefault
appnone
assigned_tonone

Responses

200 data and meta envelope

{
  "data": [
    {
      "...": "..."
    }
  ],
  "meta": {
    "total": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/numbers/?app=...&assigned_to=..." \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.numbers)

POST telephony/v1/numbers/buy/ Service tier

POST to telephony/v1/numbers/buy/. derived from route

This read is not paginated. It returns at most 120 rows and does not report a total, so a result of exactly 120 may be truncated.

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/numbers/buy/

Body keys (JSON)

KeyRequiredDefault
appoptional or conditionalnone
assigned_tooptional or conditionalnone
friendly_nameoptional or conditionalnone
phone_numberoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

201 data and meta envelope

{
  "data": {
    "...": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_number
502telephony_unavailable

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/numbers/buy/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com" \
  -H "Content-Type: application/json" \
  -d '{
  "app": "...",
  "assigned_to": "...",
  "friendly_name": "...",
  "phone_number": "..."
}'

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.buy)

GET telephony/v1/numbers/search/ Service tier

List telephony. derived from route

This read is not paginated. It returns at most 10 rows and does not report a total, so a result of exactly 10 may be truncated.

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/numbers/search/

Query parameters

NameDefault
area_codenone
capabilitiesnone
containsnone
countrynone
limitnone

Responses

200 data and meta envelope

{
  "data": "...",
  "meta": {
    "total": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
502search_failed
503telephony_unavailable

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/numbers/search/?area_code=...&capabilities=...&contains=..." \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.search)

POST telephony/v1/numbers/{public_id}/assign/ Service tier

POST to telephony/v1/numbers/{public_id}/assign/. derived from route

This read is not paginated. It returns at most 120 rows and does not report a total, so a result of exactly 120 may be truncated.

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/numbers/{public_id}/assign/

Path parameters

NameType
public_idstr

Body keys (JSON)

KeyRequiredDefault
appoptional or conditionalnone
assigned_tooptional or conditionalnone
friendly_nameoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 data and meta envelope

{
  "data": {
    "...": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
404number_not_found

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/numbers/PUBLIC_ID/assign/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com" \
  -H "Content-Type: application/json" \
  -d '{
  "app": "...",
  "assigned_to": "...",
  "friendly_name": "..."
}'

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.assign)

POST telephony/v1/numbers/{public_id}/release/ Service tier

POST to telephony/v1/numbers/{public_id}/release/. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/numbers/{public_id}/release/

Path parameters

NameType
public_idstr

Responses

200 data and meta envelope

{
  "data": {
    "...": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
404number_not_found

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/numbers/PUBLIC_ID/release/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.release)

GETPUT telephony/v1/numbers/{public_id}/route/ Service tier

GET, PUT on telephony/v1/numbers/{public_id}/route/. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/numbers/{public_id}/route/

Path parameters

NameType
public_idstr

Responses

200 data and meta envelope

{
  "data": {
    "...": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_route
404number_not_found

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/numbers/PUBLIC_ID/route/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.route)

GETPUT telephony/v1/registration/ Service tier

GET, PUT on telephony/v1/registration/. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/registration/

Responses

200 data and meta envelope

{
  "data": {
    "...": "..."
  },
  "meta": {
    "errors": [
      "..."
    ]
  }
}

200 data and meta envelope

{
  "data": {
    "...": "..."
  },
  "meta": {
    "fees": "...",
    "options": [
      "..."
    ],
    "errors": [
      "..."
    ]
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/registration/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.registration)

POST telephony/v1/registration/resend-verification/ Service tier

POST to telephony/v1/registration/resend-verification/. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/registration/resend-verification/

Responses

200 data and meta envelope

{
  "data": {
    "...": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/registration/resend-verification/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.registration_resend_verification)

POST telephony/v1/registration/submit/ Service tier

POST to telephony/v1/registration/submit/. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/registration/submit/

Responses

200 data and meta envelope

{
  "data": {
    "...": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/registration/submit/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.registration_submit)

GET telephony/v1/registration/use-cases/ Service tier

List telephony. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/registration/use-cases/

Query parameters

NameDefault
business_namenone
opt_in_urlnone

Responses

200 data and meta envelope

{
  "data": "...",
  "meta": {
    "total": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/registration/use-cases/?business_name=...&opt_in_url=..." \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.registration_use_cases)

GET telephony/v1/usage/ Service tier

List telephony. derived from route

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/usage/

Query parameters

NameDefault
fromnone
tonone

Responses

200 data and meta envelope

{
  "data": [
    {
      "kind": "...",
      "quantity": 0.0,
      "credits": 0.0
    }
  ]
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://automations.mattering.io/api/internal/telephony/v1/usage/?from=...&to=..." \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.usage)

POST telephony/v1/voice-token/ Service tier

Access token for the browser dialer, as the acting seat, for one of the org's numbers that the seat may use (assigned to them, or shared).

URL

  • Service tierhttps://automations.mattering.io/api/internal/telephony/v1/voice-token/

Body keys (JSON)

KeyRequiredDefault
number_public_idoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 data and meta envelope

{
  "data": {
    "token": "...",
    "ttl_seconds": "...",
    "identity": "...",
    "number": {
      "...": "..."
    }
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
403not_your_line
404number_not_found
409dialer_unavailable

Example

curl -X POST "https://automations.mattering.io/api/internal/telephony/v1/voice-token/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com" \
  -H "Content-Type: application/json" \
  -d '{
  "number_public_id": "..."
}'

Source: AutomationsCore/telephony_api_views.py (telephony_api_views.voice_token)

All Automations resources
Start Free Explore our Products