Telephony

Cloud telephony (Exotel): the connection, virtual numbers per lead source with validity dates, A2P declarations, recording and missed-call settings.

POST/v1/integrations/telephony

Connect Exotel

Your Exotel account SID, API key and API token (Exotel → API settings) and the cluster the account lives on (`in`: api.in.exotel.com, `sg`: api.exotel.com). The answer carries the webhook URLs to paste in Exotel.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Request body

providerrequired: "exotel"
name: string or null
account_sidrequired: string
api_keyrequired: string
api_tokenrequired: string
region: "in" | "sg"

Response · 201

datarequired: TelephonyConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/telephony' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"provider":"exotel","name":"string","account_sid":"string","api_key":"string","api_token":"string","region":"in"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "hooks": {
      "status": "string",
      "connect": "string",
      "passthru": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/integrations/telephony/{id}

Change the telephony keys, SID, cluster or name

Only the fields sent change.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string or null
account_sid: string
api_key: string
api_token: string
region: "in" | "sg"

Response · 200

datarequired: TelephonyConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/integrations/telephony/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","account_sid":"string","api_key":"string","api_token":"string","region":"in"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "hooks": {
      "status": "string",
      "connect": "string",
      "passthru": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/integrations/telephony/{id}/sync-numbers

Fetch the ExoPhones

New numbers are added, known ones refreshed, numbers gone from the account released.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.addedrequired: integer
data.updatedrequired: integer
data.releasedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/telephony/{id}/sync-numbers' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "added": 0,
    "updated": 0,
    "released": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/integrations/telephony/{id}/test

Test the telephony connection

Lists the account’s numbers with the keys and records the result on the connection.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.okrequired: boolean
data.messagerequired: string
data.numbersrequired: integer or null
data.checked_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.hooksrequired: TelephonyHooks or null
Secret webhook URLs of the connection — paste them in Exotel.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/telephony/{id}/test' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "ok": true,
    "message": "string",
    "numbers": 0,
    "checked_at": "2026-10-06T05:30:00.000Z",
    "hooks": {
      "status": "string",
      "connect": "string",
      "passthru": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/telephony

Telephony overview

The connection (webhook URLs for members who manage integrations), settings and virtual numbers.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations or settings.view.

Response · 200

datarequired: TelephonyOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/telephony' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "string",
      "connector_key": "string",
      "name": "string",
      "status": "pending",
      "health": "ok",
      "config": {},
      "has_secret": true,
      "secret_hints": {},
      "inbound_url": "string",
      "scopes": [
        "string"
      ],
      "connected_at": "2026-10-06T05:30:00.000Z",
      "connected_by_id": "cmusrceel0000q7kaafxqi1om",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "error_count": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "hooks": {
      "status": "string",
      "connect": "string",
      "passthru": "string"
    },
    "settings": {
      "record_calls": true,
      "disclosure_text": "string",
      "recording_disclosed": true,
      "ai_assist_disclosed": true,
      "click_to_call_a2p": "warn",
      "missed_call_ack": true,
      "missed_call_channel": "auto",
      "callback_minutes": 5,
      "ring_timeout_sec": 15,
      "max_call_minutes": 5,
      "calling_hours": {
        "start": "string",
        "end": "string"
      }
    },
    "numbers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "connection_id": "cmusrceel0000q7kaafxqi1om",
        "provider": "string",
        "e164": "string",
        "label": "string",
        "kind": "string",
        "is_default": true,
        "branch_id": "cmusrceel0000q7kaafxqi1om",
        "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
        "fallback_e164": "string",
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z",
        "current_source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "source": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string",
            "type": "string",
            "is_active": true
          },
          "valid_from": "2026-10-06T05:30:00.000Z",
          "valid_to": "2026-10-06T05:30:00.000Z",
          "route_member_id": "cmusrceel0000q7kaafxqi1om",
          "note": "string",
          "live": true
        },
        "sources": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "source": {
              "id": null,
              "name": null,
              "type": null,
              "is_active": null
            },
            "valid_from": "2026-10-06T05:30:00.000Z",
            "valid_to": "2026-10-06T05:30:00.000Z",
            "route_member_id": "cmusrceel0000q7kaafxqi1om",
            "note": "string",
            "live": true
          }
        ],
        "a2p": {
          "state": "declared",
          "latest": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status": "draft",
            "uses": [
              null
            ],
            "filed_with": "string",
            "reference": "string",
            "submitted_at": "2026-10-06T05:30:00.000Z",
            "declared_at": "2026-10-06T05:30:00.000Z",
            "valid_until": "2026-10-06T05:30:00.000Z",
            "has_document": true,
            "document_name": "string",
            "note": "string",
            "created_at": "2026-10-06T05:30:00.000Z",
            "updated_at": "2026-10-06T05:30:00.000Z"
          }
        }
      }
    ],
    "recording_retention_days": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/telephony/declarations/{id}

Move an A2P declaration forward

draft → submitted → declared / rejected, declared → revoked; the reference, dates and the document.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

status: "draft" | "submitted" | "declared" | "rejected" | "revoked"
uses: array of "click_to_call" | "dialer" | "voice_agent" | "ivr"
filed_with: string or null
reference: string or null
submitted_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
declared_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
valid_until: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
note: string or null
document_key: string or null
document_name: string or null

Response · 200

datarequired: A2pDeclaration
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/telephony/declarations/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"draft","uses":["click_to_call"],"filed_with":"string","reference":"string","submitted_at":"2026-10-06T05:30:00.000Z","declared_at":"2026-10-06T05:30:00.000Z","valid_until":"2026-10-06T05:30:00.000Z","note":"string","document_key":"string","document_name":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "uses": [
      "string"
    ],
    "filed_with": "string",
    "reference": "string",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "declared_at": "2026-10-06T05:30:00.000Z",
    "valid_until": "2026-10-06T05:30:00.000Z",
    "has_document": true,
    "document_name": "string",
    "note": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/telephony/declarations/{id}/document

Open the filed declaration

A five-minute link; audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations or settings.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/telephony/declarations/{id}/document' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/telephony/declarations/{id}/upload

Upload the filed declaration

A presigned PUT (PDF or image); then PATCH the declaration with the returned `key`.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

content_typerequired: string
sizerequired: integer
filename: string or null

Response · 200

datarequired: A2pDeclarationUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/telephony/declarations/{id}/upload' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"content_type":"string","size":1,"filename":"string"}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/telephony/number-sources/{id}

Change or end a number’s source period

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

source_id: Id
Opaque record id.
valid_from: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
valid_to: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
route_member_id: Id or null
Opaque record id.
note: string or null

Response · 200

datarequired: TelephonyNumber
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/telephony/number-sources/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"source_id":"cmusrceel0000q7kaafxqi1om","valid_from":"2026-10-06T05:30:00.000Z","valid_to":"2026-10-06T05:30:00.000Z","route_member_id":"cmusrceel0000q7kaafxqi1om","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "e164": "string",
    "label": "string",
    "kind": "string",
    "is_default": true,
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_e164": "string",
    "status": "string",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "current_source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string",
        "is_active": true
      },
      "valid_from": "2026-10-06T05:30:00.000Z",
      "valid_to": "2026-10-06T05:30:00.000Z",
      "route_member_id": "cmusrceel0000q7kaafxqi1om",
      "note": "string",
      "live": true
    },
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "type": "string",
          "is_active": true
        },
        "valid_from": "2026-10-06T05:30:00.000Z",
        "valid_to": "2026-10-06T05:30:00.000Z",
        "route_member_id": "cmusrceel0000q7kaafxqi1om",
        "note": "string",
        "live": true
      }
    ],
    "a2p": {
      "state": "declared",
      "latest": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "draft",
        "uses": [
          "string"
        ],
        "filed_with": "string",
        "reference": "string",
        "submitted_at": "2026-10-06T05:30:00.000Z",
        "declared_at": "2026-10-06T05:30:00.000Z",
        "valid_until": "2026-10-06T05:30:00.000Z",
        "has_document": true,
        "document_name": "string",
        "note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/telephony/number-sources/{id}

Remove a number’s source period

Calls already received keep their source.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: TelephonyNumber
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/telephony/number-sources/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "e164": "string",
    "label": "string",
    "kind": "string",
    "is_default": true,
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_e164": "string",
    "status": "string",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "current_source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string",
        "is_active": true
      },
      "valid_from": "2026-10-06T05:30:00.000Z",
      "valid_to": "2026-10-06T05:30:00.000Z",
      "route_member_id": "cmusrceel0000q7kaafxqi1om",
      "note": "string",
      "live": true
    },
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "type": "string",
          "is_active": true
        },
        "valid_from": "2026-10-06T05:30:00.000Z",
        "valid_to": "2026-10-06T05:30:00.000Z",
        "route_member_id": "cmusrceel0000q7kaafxqi1om",
        "note": "string",
        "live": true
      }
    ],
    "a2p": {
      "state": "declared",
      "latest": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "draft",
        "uses": [
          "string"
        ],
        "filed_with": "string",
        "reference": "string",
        "submitted_at": "2026-10-06T05:30:00.000Z",
        "declared_at": "2026-10-06T05:30:00.000Z",
        "valid_until": "2026-10-06T05:30:00.000Z",
        "has_document": true,
        "document_name": "string",
        "note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/telephony/numbers

Add a virtual number by hand

For accounts whose plan has no number API: the ExoPhone exactly as Exotel shows it.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Request body

e164required: string
label: string or null

Response · 201

datarequired: TelephonyNumber
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/telephony/numbers' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"e164":"string","label":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "e164": "string",
    "label": "string",
    "kind": "string",
    "is_default": true,
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_e164": "string",
    "status": "string",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "current_source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string",
        "is_active": true
      },
      "valid_from": "2026-10-06T05:30:00.000Z",
      "valid_to": "2026-10-06T05:30:00.000Z",
      "route_member_id": "cmusrceel0000q7kaafxqi1om",
      "note": "string",
      "live": true
    },
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "type": "string",
          "is_active": true
        },
        "valid_from": "2026-10-06T05:30:00.000Z",
        "valid_to": "2026-10-06T05:30:00.000Z",
        "route_member_id": "cmusrceel0000q7kaafxqi1om",
        "note": "string",
        "live": true
      }
    ],
    "a2p": {
      "state": "declared",
      "latest": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "draft",
        "uses": [
          "string"
        ],
        "filed_with": "string",
        "reference": "string",
        "submitted_at": "2026-10-06T05:30:00.000Z",
        "declared_at": "2026-10-06T05:30:00.000Z",
        "valid_until": "2026-10-06T05:30:00.000Z",
        "has_document": true,
        "document_name": "string",
        "note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/telephony/numbers/{id}

Change a virtual number

Its label, the default caller id, the branch it belongs to and where unanswerable calls go.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

label: string or null
is_default: boolean
branch_id: Id or null
Opaque record id.
fallback_member_id: Id or null
Opaque record id.
fallback_e164: string or null
status: "active" | "released"

Response · 200

datarequired: TelephonyNumber
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/telephony/numbers/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"label":"string","is_default":true,"branch_id":"cmusrceel0000q7kaafxqi1om","fallback_member_id":"cmusrceel0000q7kaafxqi1om","fallback_e164":"string","status":"active"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "e164": "string",
    "label": "string",
    "kind": "string",
    "is_default": true,
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_e164": "string",
    "status": "string",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "current_source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string",
        "is_active": true
      },
      "valid_from": "2026-10-06T05:30:00.000Z",
      "valid_to": "2026-10-06T05:30:00.000Z",
      "route_member_id": "cmusrceel0000q7kaafxqi1om",
      "note": "string",
      "live": true
    },
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "type": "string",
          "is_active": true
        },
        "valid_from": "2026-10-06T05:30:00.000Z",
        "valid_to": "2026-10-06T05:30:00.000Z",
        "route_member_id": "cmusrceel0000q7kaafxqi1om",
        "note": "string",
        "live": true
      }
    ],
    "a2p": {
      "state": "declared",
      "latest": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "draft",
        "uses": [
          "string"
        ],
        "filed_with": "string",
        "reference": "string",
        "submitted_at": "2026-10-06T05:30:00.000Z",
        "declared_at": "2026-10-06T05:30:00.000Z",
        "valid_until": "2026-10-06T05:30:00.000Z",
        "has_document": true,
        "document_name": "string",
        "note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/telephony/numbers/{id}/declarations

Record an A2P declaration of a number

TRAI (18 Sep 2026): numbers used for software-initiated calls must be declared to the operator. Each filing is its own record; the newest decides the number’s state.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

status: "draft" | "submitted" | "declared" | "rejected" | "revoked"
uses: array of "click_to_call" | "dialer" | "voice_agent" | "ivr"
filed_with: string or null
reference: string or null
submitted_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
declared_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
valid_until: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
note: string or null

Response · 201

datarequired: A2pDeclaration
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/telephony/numbers/{id}/declarations' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"draft","uses":["click_to_call"],"filed_with":"string","reference":"string","submitted_at":"2026-10-06T05:30:00.000Z","declared_at":"2026-10-06T05:30:00.000Z","valid_until":"2026-10-06T05:30:00.000Z","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "uses": [
      "string"
    ],
    "filed_with": "string",
    "reference": "string",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "declared_at": "2026-10-06T05:30:00.000Z",
    "valid_until": "2026-10-06T05:30:00.000Z",
    "has_document": true,
    "document_name": "string",
    "note": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/telephony/numbers/{id}/sources

Let a number stand for a lead source

From `valid_from` until `valid_to` (open-ended when empty); periods of one number never overlap.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

source_idrequired: Id
Opaque record id.
valid_fromrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
valid_to: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
route_member_id: Id or null
Opaque record id.
note: string or null

Response · 201

datarequired: TelephonyNumber
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/telephony/numbers/{id}/sources' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"source_id":"cmusrceel0000q7kaafxqi1om","valid_from":"2026-10-06T05:30:00.000Z","valid_to":"2026-10-06T05:30:00.000Z","route_member_id":"cmusrceel0000q7kaafxqi1om","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "e164": "string",
    "label": "string",
    "kind": "string",
    "is_default": true,
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "fallback_e164": "string",
    "status": "string",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "current_source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string",
        "is_active": true
      },
      "valid_from": "2026-10-06T05:30:00.000Z",
      "valid_to": "2026-10-06T05:30:00.000Z",
      "route_member_id": "cmusrceel0000q7kaafxqi1om",
      "note": "string",
      "live": true
    },
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "type": "string",
          "is_active": true
        },
        "valid_from": "2026-10-06T05:30:00.000Z",
        "valid_to": "2026-10-06T05:30:00.000Z",
        "route_member_id": "cmusrceel0000q7kaafxqi1om",
        "note": "string",
        "live": true
      }
    ],
    "a2p": {
      "state": "declared",
      "latest": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "draft",
        "uses": [
          "string"
        ],
        "filed_with": "string",
        "reference": "string",
        "submitted_at": "2026-10-06T05:30:00.000Z",
        "declared_at": "2026-10-06T05:30:00.000Z",
        "valid_until": "2026-10-06T05:30:00.000Z",
        "has_document": true,
        "document_name": "string",
        "note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/telephony/settings

Change the telephony settings

Recording and its disclosure, the A2P rule for click-to-call, missed-call acknowledgement, call-back time.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Request body

record_calls: boolean
disclosure_text: string
recording_disclosed: boolean
The provider flows play the disclosure to the customer before the call connects; no call is recorded until it is set.
ai_assist_disclosed: boolean
The disclosure tells callers an AI assistant processes the call; live call assist stays off until it is set.
click_to_call_a2p: "warn" | "block" | "off"
missed_call_ack: boolean
missed_call_channel: "auto" | "whatsapp_cloud" | "sms"
callback_minutes: integer
ring_timeout_sec: integer
max_call_minutes: integer
calling_hours: object
calling_hours.startrequired: string
calling_hours.endrequired: string

Response · 200

datarequired: TelephonySettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/telephony/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"record_calls":true,"disclosure_text":"string","recording_disclosed":true,"ai_assist_disclosed":true,"click_to_call_a2p":"warn","missed_call_ack":true,"missed_call_channel":"auto","callback_minutes":5,"ring_timeout_sec":15,"max_call_minutes":5,"calling_hours":{"start":"string","end":"string"}}'

Response example

{
  "data": {
    "record_calls": true,
    "disclosure_text": "string",
    "recording_disclosed": true,
    "ai_assist_disclosed": true,
    "click_to_call_a2p": "warn",
    "missed_call_ack": true,
    "missed_call_channel": "auto",
    "callback_minutes": 5,
    "ring_timeout_sec": 15,
    "max_call_minutes": 5,
    "calling_hours": {
      "start": "string",
      "end": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.