API REFERENCE

Phone Numbers

Manage your phone numbers, which would be used for calling campaigns.

Use shared phone numbers for quick experiments, order a dedicated line directly from Call Camp Studio or register your owned number from external telephony provider.

List all phone numbers

GEThttp://localhost:3000/api/phones

Returns a list of all phone numbers registered in your account. You can filter by status or search for specific numbers.

Query Parameters

ParameterTypeDescription
search stringSearch by phone number or name.
status stringFilter by status: active, pending, inactive.
page numberPage number for pagination.
limit numberItems per page (max 100).

Responses

JSON
{
  "phones": [
    {
      "uuid": "9z8y7x6w-5v4u-3t2s-1r0q-9p8o7n6m5l4k",
      "clientUuid": "2b91c27d-4f10-4d5e-6f7a-8b9c0d1e2f3a",
      "name": "Main Office Line",
      "number": "+16054440129",
      "referenceId": "d398f9d8d9f",
      "type": "private",
      "countryCode": "US",
      "sipTrunk": "sip.twillio.com",
      "provider": "twillio",
      "status": "active",
      "smsEnabled": false,
      "fallbackDestination": null,
      "server": {
        "url": "wss://api.callcamp.com/ws",
        "region": "us-east-1"
      },
      "hooks": {
        "on_call_end": "https://api.twillio.com/webhook"
      },
      "sipTrunkUser": "user_abc",
      "sipTrunkPassword": "••••••••",
      "sipTrunkProtocol": "udp",
      "parameters": {},
      "createdAt": "2026-01-10T12:00:00Z",
      "updatedAt": "2026-04-20T15:30:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}

Register phone number

POSThttp://localhost:3000/api/phones

Registers a new phone number to your account. This can be a number you already own from an external provider, or a new line you wish to initialize within Call Camp.

Body Parameters

FieldTypeDescription
number *stringThe E.164 formatted phone number.
name stringDisplay name for the phone number.
countryCode stringISO country code (default: US).
provider stringExternal provider name (e.g., vapi, twilio).
referenceId stringUnique identifier from the provider.
sipTrunk stringSIP Trunk domain or IP.
sipTrunkUser stringSIP authentication username.
sipTrunkPassword stringSIP authentication password.
type stringPhone type: private, shared, ordered.

Responses

JSON
{
  "uuid": "9z8y7x6w-5v4u-3t2s-1r0q-9p8o7n6m5l4k",
  "clientUuid": "2b91c27d-4f10-4d5e-6f7a-8b9c0d1e2f3a",
  "name": "Main Office Line",
  "number": "+16054440129",
  "referenceId": "d398f9d8d9f",
  "type": "private",
  "countryCode": "US",
  "sipTrunk": "sip.twillio.com",
  "provider": "twillio",
  "status": "active",
  "smsEnabled": false,
  "fallbackDestination": null,
  "server": {
    "url": "wss://api.callcamp.com/ws",
    "region": "us-east-1"
  },
  "hooks": {
    "on_call_end": "https://api.twillio.com/webhook"
  },
  "sipTrunkUser": "user_abc",
  "sipTrunkPassword": "••••••••",
  "sipTrunkProtocol": "udp",
  "parameters": {},
  "createdAt": "2026-01-10T12:00:00Z",
  "updatedAt": "2026-04-20T15:30:00Z"
}

Get a phone number

GEThttp://localhost:3000/api/phones/{uuid}

Retrieves detailed information about a specific phone number, including its provider data and current assignment.

Responses

JSON
{
  "uuid": "9z8y7x6w-5v4u-3t2s-1r0q-9p8o7n6m5l4k",
  "clientUuid": "2b91c27d-4f10-4d5e-6f7a-8b9c0d1e2f3a",
  "name": "Main Office Line",
  "number": "+16054440129",
  "referenceId": "d398f9d8d9f",
  "type": "private",
  "countryCode": "US",
  "sipTrunk": "sip.twillio.com",
  "provider": "twillio",
  "status": "active",
  "smsEnabled": false,
  "fallbackDestination": null,
  "server": {
    "url": "wss://api.callcamp.com/ws",
    "region": "us-east-1"
  },
  "hooks": {
    "on_call_end": "https://api.twillio.com/webhook"
  },
  "sipTrunkUser": "user_abc",
  "sipTrunkPassword": "••••••••",
  "sipTrunkProtocol": "udp",
  "parameters": {},
  "createdAt": "2026-01-10T12:00:00Z",
  "updatedAt": "2026-04-20T15:30:00Z"
}

Update a phone number

PATCHhttp://localhost:3000/api/phones/{uuid}

Updates the configuration of a phone number, such as its display name or internal tags.

Body Parameters

FieldTypeDescription
name stringDisplay name for the phone number.
status stringUpdate number status.

Responses

JSON
{
  "uuid": "9z8y7x6w-5v4u-3t2s-1r0q-9p8o7n6m5l4k",
  "clientUuid": "2b91c27d-4f10-4d5e-6f7a-8b9c0d1e2f3a",
  "name": "Main Office Line",
  "number": "+16054440129",
  "referenceId": "d398f9d8d9f",
  "type": "private",
  "countryCode": "US",
  "sipTrunk": "sip.twillio.com",
  "provider": "twillio",
  "status": "active",
  "smsEnabled": false,
  "fallbackDestination": null,
  "server": {
    "url": "wss://api.callcamp.com/ws",
    "region": "us-east-1"
  },
  "hooks": {
    "on_call_end": "https://api.twillio.com/webhook"
  },
  "sipTrunkUser": "user_abc",
  "sipTrunkPassword": "••••••••",
  "sipTrunkProtocol": "udp",
  "parameters": {},
  "createdAt": "2026-01-10T12:00:00Z",
  "updatedAt": "2026-04-20T15:30:00Z"
}

Delete a phone number

DELETEhttp://localhost:3000/api/phones/{uuid}

Removes a phone number from your account. This will also unassign it from any active campaigns.

Responses

// 204 No Content