API reference

Dialer

Outbound dialer and SMS campaigns, their numbers, caller IDs and results.

49 operationsBase URL https://packetexchange.io/api/v1Postman collection

BrowseDialer

Ask the dialer assistant a question or give it an instruction

POST/api/v1/dialer/agent/ask

Access: API key. Scoped keys need dialer:write.
Rate limit: 20 requests per minute

A conversational assistant that reads and operates YOUR dialer (campaigns, numbers, caller IDs). Send the history from the previous reply to continue a conversation. actions lists what it did, including any writes.

Request body (application/json)

Field	Type	Description
`message`required	string	-max 4000 chars
`history`	any[]	The `history` returned by the previous turn

Response 200

Field	Type	Description
`data`required	object	-
`reply`requireddata.reply	string	-
`actions`requireddata.actions	object[]	-
`tool`requireddata.actions[].tool	string	-
`ok`requireddata.actions[].ok	boolean	-
`write`requireddata.actions[].write	boolean	-
`suggestions`requireddata.suggestions	string[]	-
`history`requireddata.history	any[]	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/agent/ask" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "Hello from Acme"
}'

Run it here with a test key.

Get dialer analytics across all your campaigns

GET/api/v1/dialer/analytics/overview

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Defaults to the last 30 days when from/to are omitted.

Parameters

Name	In	Type	Description
`from`	query	string	ISO date/time
`to`	query	string	ISO date/time

Response 200

Field	Type	Description
`data`required	object	-
`window`requireddata.window	object	-
`from`requireddata.window.from	string (date-time)	ISO-8601 timestamp (UTC)
`to`requireddata.window.to	string (date-time)	ISO-8601 timestamp (UTC)
`campaigns`requireddata.campaigns	object	Campaign counts by status, plus `total`
`headline`requireddata.headline	object	-
`dialed`requireddata.headline.dialed	integer	-
`answered`requireddata.headline.answered	integer	-
`failed`requireddata.headline.failed	integer	-
`connectRate`requireddata.headline.connectRate	number	-
`acd`requireddata.headline.acd	number	-
`talkMinutes`requireddata.headline.talkMinutes	number	-
`spend`requireddata.headline.spend	number	USD, a display number
`costPerAnswered`requireddata.headline.costPerAnswered	number	-
`costPerMinute`requireddata.headline.costPerMinute	number	-
`topDestinations`requireddata.topDestinations	object[]	-
`dialed`requireddata.topDestinations[].dialed	integer	-
`answered`requireddata.topDestinations[].answered	integer	-
`asr`requireddata.topDestinations[].asr	number	-
`prefix`requireddata.topDestinations[].prefix	string	-
`byHour`requireddata.byHour	object[]	-
`daily`requireddata.daily	object[]	-
`dialed`requireddata.daily[].dialed	integer	-
`answered`requireddata.daily[].answered	integer	-
`asr`requireddata.daily[].asr	number	-
`day`requireddata.daily[].day	string	-
`topCampaigns`requireddata.topCampaigns	object[]	-
`dialed`requireddata.topCampaigns[].dialed	integer	-
`answered`requireddata.topCampaigns[].answered	integer	-
`asr`requireddata.topCampaigns[].asr	number	-
`id`requireddata.topCampaigns[].id	string (uuid)	-
`name`requireddata.topCampaigns[].name	string	-
`status`requireddata.topCampaigns[].status	string	-One of `draft`, `ready`, `running`, `paused`, `completed`, `failed`

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get detailed analytics for one campaign

GET/api/v1/dialer/campaigns/{id}/analytics

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`campaign`requireddata.campaign	object	-
`id`requireddata.campaign.id	string (uuid)	-
`name`requireddata.campaign.name	string	-
`status`requireddata.campaign.status	string	-One of `draft`, `ready`, `running`, `paused`, `completed`, `failed`
`kind`requireddata.campaign.kind	string	-One of `voice`, `sms`
`headline`requireddata.headline	object	-
`dialed`requireddata.headline.dialed	integer	-
`answered`requireddata.headline.answered	integer	-
`failed`requireddata.headline.failed	integer	-
`connectRate`requireddata.headline.connectRate	number	-
`acd`requireddata.headline.acd	number	-
`talkMinutes`requireddata.headline.talkMinutes	number	-
`spend`requireddata.headline.spend	number	USD, a display number
`costPerAnswered`requireddata.headline.costPerAnswered	number	-
`costPerMinute`requireddata.headline.costPerMinute	number	-
`totalNumbers`requireddata.headline.totalNumbers	integer	-
`pending`requireddata.headline.pending	integer	-
`asr`requireddata.headline.asr	number	-
`bestHour`requireddata.headline.bestHour	object \| null	-
`hour`requireddata.headline.bestHour.hour	integer	-
`asr`requireddata.headline.bestHour.asr	number	-
`tz`requireddata.headline.bestHour.tz	string	-
`dispositions`requireddata.dispositions	object[]	-
`status`requireddata.dispositions[].status	string	-
`count`requireddata.dispositions[].count	integer	-
`pct`requireddata.dispositions[].pct	number	-
`failureCauses`requireddata.failureCauses	object[]	-
`code`requireddata.failureCauses[].code	integer	-
`label`requireddata.failureCauses[].label	string	-
`count`requireddata.failureCauses[].count	integer	-
`byHour`requireddata.byHour	object[]	-
`byDayOfWeek`requireddata.byDayOfWeek	object[]	-
`dialed`requireddata.byDayOfWeek[].dialed	integer	-
`answered`requireddata.byDayOfWeek[].answered	integer	-
`asr`requireddata.byDayOfWeek[].asr	number	-
`dow`requireddata.byDayOfWeek[].dow	integer	-
`byDestination`requireddata.byDestination	object[]	-
`dialed`requireddata.byDestination[].dialed	integer	-
`answered`requireddata.byDestination[].answered	integer	-
`asr`requireddata.byDestination[].asr	number	-
`prefix`requireddata.byDestination[].prefix	string	-
`acd`requireddata.byDestination[].acd	number	-
`retryEffectiveness`requireddata.retryEffectiveness	object[]	-
`dialed`requireddata.retryEffectiveness[].dialed	integer	-
`answered`requireddata.retryEffectiveness[].answered	integer	-
`asr`requireddata.retryEffectiveness[].asr	number	-
`attempt`requireddata.retryEffectiveness[].attempt	integer	-
`daily`requireddata.daily	object[]	-
`dialed`requireddata.daily[].dialed	integer	-
`answered`requireddata.daily[].answered	integer	-
`asr`requireddata.daily[].asr	number	-
`day`requireddata.daily[].day	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List your dialer and SMS campaigns

GET/api/v1/dialer/campaigns

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`status`	query	string	-One of draft, ready, running, paused, completed, failed
`search`	query	string	-
`cursor`	query	string (uuid)	-
`limit`	query	integer	-Default 25

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`userId`requireddata[].userId	string (uuid)	-
`routeId`requireddata[].routeId	string (uuid) \| null	The purchased route the campaign sends over
`name`requireddata[].name	string	-
`kind`requireddata[].kind	string	-One of `voice`, `sms`
`environment`requireddata[].environment	string	test = created with a test key; simulated, never really dialled or billedOne of `live`, `test`
`status`requireddata[].status	string	-One of `draft`, `ready`, `running`, `paused`, `completed`, `failed`
`messageBody`requireddata[].messageBody	string \| null	SMS campaigns: the message text
`senderId`requireddata[].senderId	string \| null	SMS campaigns: the sender ID
`aiAgentId`requireddata[].aiAgentId	string (uuid) \| null	Voice campaigns: the AI voice agent that handles answered calls
`concurrency`requireddata[].concurrency	integer	-
`maxCallDuration`requireddata[].maxCallDuration	integer	Seconds
`callInterval`requireddata[].callInterval	integer	-
`platformFeePerCall`requireddata[].platformFeePerCall	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`totalNumbers`requireddata[].totalNumbers	integer	-
`totalClis`requireddata[].totalClis	integer	-
`cliSetId`requireddata[].cliSetId	string (uuid) \| null	-
`cliStrategy`requireddata[].cliStrategy	object \| null	Caller-ID rotation strategy, when a caller-ID set is assigned
`numbersDialed`requireddata[].numbersDialed	integer	-
`numbersAnswered`requireddata[].numbersAnswered	integer	-
`numbersFailed`requireddata[].numbersFailed	integer	-
`totalDurationSeconds`requireddata[].totalDurationSeconds	integer	-
`windowStartHour`requireddata[].windowStartHour	integer \| null	-
`windowEndHour`requireddata[].windowEndHour	integer \| null	-
`windowTz`requireddata[].windowTz	string \| null	-
`maxAttempts`requireddata[].maxAttempts	integer	-
`retryDelayMinutes`requireddata[].retryDelayMinutes	integer	-
`maxSpend`requireddata[].maxSpend	money \| null	Budget cap; the campaign pauses when reached USD as a decimal string with exactly 6 places, e.g. "0.012500".
`scheduleAt`requireddata[].scheduleAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`startedAt`requireddata[].startedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`completedAt`requireddata[].completedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata[].updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`nextCursor`required	string \| null	Pass as `cursor` to fetch the next page; null on the last page.
`hasMore`required	boolean	True when another page exists.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Create a dialer or SMS campaign

POST/api/v1/dialer/campaigns

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Creates the campaign in draft. Add numbers (POST /campaigns/{id}/numbers or /contacts/import), then start it with POST /campaigns/{id}/control. A campaign created with a test key is simulated and never really dialled or billed.

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`routeId`required	string (uuid)	-
`kind`	string	-One of `voice`, `sms`
`messageBody`	string	-max 1600 chars
`senderId`	string	-max 20 chars
`targetAcd`	string	-
`targetAsr`	string	-
`concurrency`	integer	-1 to 128, default 1
`maxCallDuration`	integer	-1 to 3600, default 300
`callInterval`	integer	-0 to 60000, default 0
`notes`	string	-max 2000 chars
`windowStartHour`	integer	-0 to 23
`windowEndHour`	integer	-0 to 23
`windowTz`	string	-max 64 chars
`maxAttempts`	integer	-1 to 10, default 1
`retryDelayMinutes`	integer	-1 to 1440, default 60
`maxSpend`	string	-
`scheduleAt`	string (date-time)	-
`aiAgentId`	string (uuid) \| null	-

Response 201

Field	Type	Description
`data`required	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/campaigns" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "routeId": "<routeId>"
}'

Run it here with a test key.

Get a campaign

GET/api/v1/dialer/campaigns/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Update a campaign

PUT/api/v1/dialer/campaigns/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`name`	string	-max 255 chars
`messageBody`	string \| null	-max 1600 chars
`senderId`	string \| null	-max 20 chars
`targetAcd`	string \| null	-
`targetAsr`	string \| null	-
`concurrency`	integer	-1 to 128
`maxCallDuration`	integer	-1 to 3600
`callInterval`	integer	-0 to 60000
`notes`	string \| null	-max 2000 chars
`windowStartHour`	integer \| null	-0 to 23
`windowEndHour`	integer \| null	-0 to 23
`windowTz`	string \| null	-max 64 chars
`maxAttempts`	integer	-1 to 10
`retryDelayMinutes`	integer	-1 to 1440
`maxSpend`	string \| null	-
`scheduleAt`	string (date-time) \| null	-
`aiAgentId`	string (uuid) \| null	-

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PUT "https://packetexchange.io/api/v1/dialer/campaigns/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "messageBody": "<messageBody>"
}'

Run it here with a test key.

Delete a campaign

DELETE/api/v1/dialer/campaigns/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`message`requireddata.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Start, pause or stop a campaign

POST/api/v1/dialer/campaigns/{id}/control

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)
Real traffic: Starting a campaign dials real numbers or sends real messages, billed as they happen.

Starting spends money: calls and messages are billed to your balance as they happen. Start is refused with VALIDATION_ERROR when the balance is insufficient or the campaign has no numbers.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`action`required	string	-One of `start`, `pause`, `stop`

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/campaigns/<id>/control" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "start"
}'

Run it here with a test key.

Mark a draft campaign ready to start

POST/api/v1/dialer/campaigns/{id}/ready

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Status only; every start-time check still runs when you start it. Refused when the campaign has no contacts yet.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get live progress and spend for a campaign

GET/api/v1/dialer/campaigns/{id}/stats

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`totalNumbers`requireddata.totalNumbers	integer	-
`numbersDialed`requireddata.numbersDialed	integer	-
`numbersAnswered`requireddata.numbersAnswered	integer	-
`numbersFailed`requireddata.numbersFailed	integer	-
`numbersPending`requireddata.numbersPending	integer	-
`totalDurationSeconds`requireddata.totalDurationSeconds	integer	-
`asr`requireddata.asr	number	Answer-seizure ratio, percent
`acd`requireddata.acd	number	Average call duration, seconds
`progress`requireddata.progress	number	Percent of numbers dialled
`activeCalls`requireddata.activeCalls	integer	-
`totalSpend`requireddata.totalSpend	number	USD spent so far (a display number, not a 6-decimal string)
`maxSpend`requireddata.maxSpend	number \| null	Budget cap in USD, as a number
`budgetProgress`requireddata.budgetProgress	number \| null	Percent of the budget used

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Parse a contact file and suggest a column mapping

POST/api/v1/dialer/contacts/parse

Access: API key. Scoped keys need dialer:write.
Rate limit: 20 requests per minute

Upload a CSV or XLSX (multipart file part, or JSON contentBase64/content, up to about 12 MB). Returns the detected columns, a suggested mapping, a preview and the data rows to send back to /contacts/import. Nothing is saved.

Request body (application/json)

Field	Type	Description
`filename`	string	-max 255 chars
`contentBase64`	string	The file, base64-encoded
`content`	string	The file as plain text (CSV)

Response 200

Field	Type	Description
`data`required	object	-
`hasHeader`requireddata.hasHeader	boolean	-
`columns`requireddata.columns	object[]	-
`index`requireddata.columns[].index	integer	-
`label`requireddata.columns[].label	string	-
`sampleRows`requireddata.sampleRows	string[][]	-
`dataRows`requireddata.dataRows	string[][]	-
`suggestedMapping`requireddata.suggestedMapping	object	-
`headerRowIndex`requireddata.suggestedMapping.headerRowIndex	integer	0-based header row, or -1 when the file has none
`columns`requireddata.suggestedMapping.columns	object	-
`phone`requireddata.suggestedMapping.columns.phone	integer	-
`name`requireddata.suggestedMapping.columns.name	integer \| null	-
`firstName`requireddata.suggestedMapping.columns.firstName	integer \| null	-
`lastName`requireddata.suggestedMapping.columns.lastName	integer \| null	-
`extraColumns`requireddata.suggestedMapping.extraColumns	integer[]	Columns kept as per-contact fields
`notes`data.suggestedMapping.notes	string	-
`rowCount`requireddata.rowCount	integer	-
`truncated`requireddata.truncated	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/contacts/parse" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "filename": "<filename>",
  "contentBase64": "<contentBase64>"
}'

Run it here with a test key.

Import mapped contacts into a campaign or a saved list

POST/api/v1/dialer/contacts/import

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Rows are re-normalised to E.164 and de-duplicated server-side, so what the preview showed is what is stored.

Request body (application/json)

Field	Type	Description
`rows`required	string[][]	The dataRows returned by /contacts/parse
`mapping`required	object	Same fields as DialerContactMapping, shown earlier on this page.
`columnLabels`	object[]	-
`index`requiredcolumnLabels[].index	integer	-
`label`requiredcolumnLabels[].label	string	-max 255 chars
`campaignId`	string (uuid)	-
`listId`	string (uuid)	-
`saveAsListName`	string	-max 255 chars
`keepDraft`	boolean	-

Response 201

Field	Type	Description
`data`required	object	-
`imported`requireddata.imported	integer	-
`skippedInvalid`requireddata.skippedInvalid	integer	-
`skippedDup`requireddata.skippedDup	integer	-
`sample`requireddata.sample	object[]	-
`number`requireddata.sample[].number	string	-
`name`requireddata.sample[].name	string \| null	-
`fields`requireddata.sample[].fields	object \| null	-
`rejects`requireddata.rejects	object[]	-
`row`requireddata.rejects[].row	integer	-
`value`requireddata.rejects[].value	string	-
`reason`requireddata.rejects[].reason	string	-
`savedListId`data.savedListId	string (uuid) \| null	-
`campaign`data.campaign	object	Same fields as DialerCampaign, shown earlier on this page.
`totalNumbers`data.totalNumbers	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/contacts/import" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "rows": [
    [
      "<row>"
    ]
  ],
  "mapping": {
    "headerRowIndex": 1,
    "columns": {
      "phone": 1,
      "name": 1,
      "firstName": 1,
      "lastName": 1
    },
    "extraColumns": [
      1
    ]
  }
}'

Run it here with a test key.

List a campaign’s numbers with their call outcome

GET/api/v1/dialer/campaigns/{id}/numbers

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-
`status`	query	string	-One of pending, dialing, answered, no_answer, busy, failed, skipped
`cursor`	query	string (uuid)	-
`limit`	query	integer	-Default 25

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`campaignId`requireddata[].campaignId	string (uuid)	-
`number`requireddata[].number	string	-
`status`requireddata[].status	string	-One of `pending`, `dialing`, `answered`, `no_answer`, `busy`, `failed`, `skipped`
`sipResponseCode`requireddata[].sipResponseCode	integer \| null	-
`durationSeconds`requireddata[].durationSeconds	integer \| null	-
`attempt`requireddata[].attempt	integer	-
`nextAttemptAt`requireddata[].nextAttemptAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`dialedAt`requireddata[].dialedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`answeredAt`requireddata[].answeredAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`completedAt`requireddata[].completedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`cost`requireddata[].cost	money \| null	Cost of the latest call to this number, when there is one USD as a decimal string with exactly 6 places, e.g. "0.012500".
`cli`requireddata[].cli	string \| null	Caller ID presented on the latest call
`sipCause`requireddata[].sipCause	string \| null	-
`nextCursor`required	string \| null	Pass as `cursor` to fetch the next page; null on the last page.
`hasMore`required	boolean	True when another page exists.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Add destination numbers to a campaign

POST/api/v1/dialer/campaigns/{id}/numbers

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Invalid and duplicate numbers are skipped and reported in rejects, not failed. The campaign becomes ready unless keepDraft is set.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`numbers`required	string[]	-
`keepDraft`	boolean	-

Response 201

Field	Type	Description
`data`required	object	-
`count`requireddata.count	integer	Same as `inserted` (kept for existing clients)
`inserted`requireddata.inserted	integer	-
`skipped`requireddata.skipped	integer	-
`rejects`requireddata.rejects	object[]	Up to 200 rejected entries with the reason
`value`requireddata.rejects[].value	string	-
`reason`requireddata.rejects[].reason	string	-
`totalNumbers`requireddata.totalNumbers	integer	-
`campaign`requireddata.campaign	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/campaigns/<id>/numbers" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "numbers": [
    "+447700900123"
  ]
}'

Run it here with a test key.

Remove every number from a campaign

DELETE/api/v1/dialer/campaigns/{id}/numbers

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as Message, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Remove one number from a campaign

DELETE/api/v1/dialer/campaigns/{id}/numbers/{numberId}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-
`numberId`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X DELETE "https://packetexchange.io/api/v1/dialer/campaigns/<id>/numbers/<numberId>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

List a campaign’s caller IDs

GET/api/v1/dialer/campaigns/{id}/clis

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`campaignId`requireddata[].campaignId	string (uuid)	-
`cli`requireddata[].cli	string	-
`status`requireddata[].status	string	-One of `pending`, `verified`, `failed`
`verified`requireddata[].verified	boolean	-
`verifiedAt`requireddata[].verifiedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Add caller IDs to a campaign

POST/api/v1/dialer/campaigns/{id}/clis

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Up to 100 per request. Caller IDs rotate round-robin across calls unless a caller-ID set is assigned.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`clis`required	string[]	-

Response 201

Field	Type	Description
`data`required	object	-
`count`requireddata.count	integer	-
`inserted`requireddata.inserted	integer	-
`skipped`requireddata.skipped	integer	-
`rejects`requireddata.rejects	object[]	-
`value`requireddata.rejects[].value	string	-
`reason`requireddata.rejects[].reason	string	-
`totalClis`requireddata.totalClis	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/campaigns/<id>/clis" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "clis": [
    "+447700900123"
  ]
}'

Run it here with a test key.

Remove every caller ID from a campaign

DELETE/api/v1/dialer/campaigns/{id}/clis

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as Message, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List your caller-ID sets

GET/api/v1/dialer/caller-ids

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`userId`requireddata[].userId	string (uuid)	-
`name`requireddata[].name	string	-
`description`requireddata[].description	string \| null	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata[].updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`cliCount`requireddata[].cliCount	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Create a caller-ID set

POST/api/v1/dialer/caller-ids

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`description`	string	-max 2000 chars

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`userId`requireddata.userId	string (uuid)	-
`name`requireddata.name	string	-
`description`requireddata.description	string \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/caller-ids" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme"
}'

Run it here with a test key.

Get a caller-ID set

GET/api/v1/dialer/caller-ids/{id}

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCallerIdSet, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Rename or describe a caller-ID set

PATCH/api/v1/dialer/caller-ids/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`name`	string	-max 255 chars
`description`	string \| null	-max 2000 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCallerIdSet, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PATCH "https://packetexchange.io/api/v1/dialer/caller-ids/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "description": "Example"
}'

Run it here with a test key.

Delete a caller-ID set

DELETE/api/v1/dialer/caller-ids/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Campaigns using the set are detached from it and fall back to their own caller-ID list.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List the caller IDs in a set, with usage stats

GET/api/v1/dialer/caller-ids/{id}/numbers

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`setId`requireddata[].setId	string (uuid)	-
`cli`requireddata[].cli	string	-
`label`requireddata[].label	string \| null	-
`country`requireddata[].country	string \| null	-
`countryCode`requireddata[].countryCode	string \| null	-
`areaCode`requireddata[].areaCode	string \| null	-
`source`requireddata[].source	string	-One of `upload`, `paste`, `manual`, `revshare`, `did`
`enabled`requireddata[].enabled	boolean	-
`weight`requireddata[].weight	integer	-
`dailyCap`requireddata[].dailyCap	integer \| null	-
`campaignCap`requireddata[].campaignCap	integer \| null	-
`hourlyCap`requireddata[].hourlyCap	integer \| null	-
`cooldownSec`requireddata[].cooldownSec	integer \| null	-
`status`requireddata[].status	string	-One of `active`, `resting`, `retired`
`tags`requireddata[].tags	string[]	-
`notes`requireddata[].notes	string \| null	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`stats`requireddata[].stats	object	-
`calls`requireddata[].stats.calls	integer	-
`connects`requireddata[].stats.connects	integer	-
`connectRate`requireddata[].stats.connectRate	number	Percent
`avgSec`requireddata[].stats.avgSec	number	-
`todayUsed`requireddata[].stats.todayUsed	integer	-
`campaignUsed`requireddata[].stats.campaignUsed	integer	-
`lastUsedAt`requireddata[].stats.lastUsedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Add caller IDs to a set

POST/api/v1/dialer/caller-ids/{id}/numbers

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Send ONE of: clis (a list), paste (free text), a file (multipart file part, or contentBase64/content). Numbers must be E.164; invalid and duplicate entries are reported in rejects.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`clis`	string \| object[]	A manual list of E.164 caller IDs, bare or with a label
`cli`clis[].cli	string	-
`label`clis[].label	string \| null	-max 120 chars
`paste`	string	A pasted block of numbersmax 2000000 chars
`filename`	string	-max 255 chars
`contentBase64`	string	A CSV/XLSX file, base64-encoded
`content`	string	A CSV file as plain text

Response 201

Field	Type	Description
`data`required	object	-
`inserted`requireddata.inserted	integer	-
`skipped`requireddata.skipped	integer	-
`rejects`requireddata.rejects	object[]	-
`value`requireddata.rejects[].value	string	-
`reason`requireddata.rejects[].reason	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/caller-ids/<id>/numbers" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "clis": [
    "+447700900123"
  ],
  "paste": "<paste>"
}'

Run it here with a test key.

Add your revenue share numbers to a caller-ID set

POST/api/v1/dialer/caller-ids/{id}/from-revshare

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Omit takingIds (or pass "all") to add every active revenue share number you hold.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`takingIds`	string (uuid)[] \| string	-

Response 201

Field	Type	Description
`data`required	object	Same fields as DialerCallerIdAddResult, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/caller-ids/<id>/from-revshare" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "takingIds": [
    "<takingId>"
  ]
}'

Run it here with a test key.

Update one caller ID in a set

PATCH/api/v1/dialer/caller-ids/{id}/numbers/{nid}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Enable or disable it, and set its weight, caps, cooldown, status, tags, label or notes.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-
`nid`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`enabled`	boolean	-
`weight`	integer	-1 to 1000
`dailyCap`	integer \| null	-min 0
`campaignCap`	integer \| null	-min 0
`hourlyCap`	integer \| null	-min 0
`cooldownSec`	integer \| null	-min 0
`tags`	string[]	-
`status`	string	-One of `active`, `resting`, `retired`
`label`	string \| null	-max 120 chars
`notes`	string \| null	-max 2000 chars

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`setId`requireddata.setId	string (uuid)	-
`cli`requireddata.cli	string	-
`label`requireddata.label	string \| null	-
`country`requireddata.country	string \| null	-
`countryCode`requireddata.countryCode	string \| null	-
`areaCode`requireddata.areaCode	string \| null	-
`source`requireddata.source	string	-One of `upload`, `paste`, `manual`, `revshare`, `did`
`enabled`requireddata.enabled	boolean	-
`weight`requireddata.weight	integer	-
`dailyCap`requireddata.dailyCap	integer \| null	-
`campaignCap`requireddata.campaignCap	integer \| null	-
`hourlyCap`requireddata.hourlyCap	integer \| null	-
`cooldownSec`requireddata.cooldownSec	integer \| null	-
`status`requireddata.status	string	-One of `active`, `resting`, `retired`
`tags`requireddata.tags	string[]	-
`notes`requireddata.notes	string \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PATCH "https://packetexchange.io/api/v1/dialer/caller-ids/<id>/numbers/<nid>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "weight": 1
}'

Run it here with a test key.

Remove one caller ID from a set

DELETE/api/v1/dialer/caller-ids/{id}/numbers/{nid}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-
`nid`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Enable, disable or delete many caller IDs in a set

POST/api/v1/dialer/caller-ids/{id}/numbers/bulk

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`action`required	string	-One of `enable`, `disable`, `delete`
`cliIds`required	string (uuid)[]	-

Response 200

Field	Type	Description
`data`required	object	-
`affected`requireddata.affected	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/caller-ids/<id>/numbers/bulk" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "enable",
  "cliIds": [
    "<cliId>"
  ]
}'

Run it here with a test key.

Get usage stats for a caller-ID set

GET/api/v1/dialer/caller-ids/{id}/stats

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`totalClis`requireddata.totalClis	integer	-
`activeClis`requireddata.activeClis	integer	-
`restingClis`requireddata.restingClis	integer	-
`retiredClis`requireddata.retiredClis	integer	-
`calls`requireddata.calls	integer	-
`connects`requireddata.connects	integer	-
`connectRate`requireddata.connectRate	number	Percent
`avgSec`requireddata.avgSec	number	-
`campaigns`requireddata.campaigns	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Assign a caller-ID set and rotation strategy to a campaign

PUT/api/v1/dialer/campaigns/{id}/cli

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`cliSetId`required	string (uuid) \| null	null clears the assignment (the campaign falls back to its own caller-ID list)
`strategy`	object	-
`mode`requiredstrategy.mode	string	-One of `random`, `round_robin`, `per_day_cap`, `per_campaign_cap`, `hourly_cap`, `cooldown`, `sticky_dest`, `area_match`, `country_match`, `weighted`, `lru`, `best_perf` and 1 more
`dailyCap`strategy.dailyCap	integer \| null	-min 0
`campaignCap`strategy.campaignCap	integer \| null	-min 0
`hourlyCap`strategy.hourlyCap	integer \| null	-min 0
`cooldownSec`strategy.cooldownSec	integer \| null	-min 0
`restBelowAsr`strategy.restBelowAsr	number \| null	Rest a caller ID whose ASR falls below this percent0 to 100
`weightsRespected`strategy.weightsRespected	boolean	-

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCampaign, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PUT "https://packetexchange.io/api/v1/dialer/campaigns/<id>/cli" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cliSetId": "<cliSetId>"
}'

Run it here with a test key.

Build a call-back list from callers to your revenue share numbers

POST/api/v1/dialer/target-lists/from-revshare-cdr

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Returns the distinct inbound callers in the window. Revenue share call records keep only a MASKED prefix of each caller, so entries are marked dialable: false and are not saved as a dial list; limitation explains this when it applies.

Request body (application/json)

Field	Type	Description
`takingIds`	string (uuid)[] \| string	-
`from`	string	ISO date/time
`to`	string	ISO date/time
`minDurationSec`	integer	-min 0
`saveAsListName`	string	-max 255 chars

Response 200

Field	Type	Description
`data`required	object	-
`total`requireddata.total	integer	-
`dialableCount`requireddata.dialableCount	integer	-
`callers`requireddata.callers	object[]	-
`prefix`requireddata.callers[].prefix	string	The MASKED leading digits of the caller; full numbers are never stored
`fromCarrier`requireddata.callers[].fromCarrier	string \| null	-
`originIso`requireddata.callers[].originIso	string \| null	-
`originCountry`requireddata.callers[].originCountry	string \| null	-
`originDialCode`requireddata.callers[].originDialCode	string \| null	-
`callCount`requireddata.callers[].callCount	integer	-
`lastCallAt`requireddata.callers[].lastCallAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`dialable`requireddata.callers[].dialable	boolean	False for masked prefixes, which is currently always the case
`saved`requireddata.saved	object \| null	The saved contact list, when saveAsListName was given and there was something dialable to save
`list`requireddata.saved.list	object	-
`id`requireddata.saved.list.id	string (uuid)	-
`userId`requireddata.saved.list.userId	string (uuid)	-
`name`requireddata.saved.list.name	string	-
`count`requireddata.saved.list.count	integer	-
`createdAt`requireddata.saved.list.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`saved`requireddata.saved.saved	integer	-
`skipped`requireddata.saved.skipped	integer	-
`limitation`requireddata.limitation	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/target-lists/from-revshare-cdr" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "takingIds": [
    "<takingId>"
  ],
  "from": "+447700900123"
}'

Run it here with a test key.

Match inbound callers to the caller IDs in a set

GET/api/v1/dialer/target-lists/compatible

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

For each caller ID in the set, the inbound callers reachable from its country. takingIds may be comma-separated.

Parameters

Name	In	Type	Description
`cliSetId`required	query	string (uuid)	-
`takingIds`	query	string	"all" or comma-separated revenue share taking ids

Response 200

Field	Type	Description
`data`required	object	-
`setId`requireddata.setId	string (uuid)	-
`setName`requireddata.setName	string	-
`groups`requireddata.groups	object[]	-
`cli`requireddata.groups[].cli	string	-
`label`requireddata.groups[].label	string \| null	-
`country`requireddata.groups[].country	string \| null	-
`countryCode`requireddata.groups[].countryCode	string \| null	-
`targets`requireddata.groups[].targets	object[]	Same fields as DialerRevshareCaller, shown earlier on this page.
`saved`requireddata.saved	object \| null	The saved contact list, when saveAsListName was given and there was something dialable to save
`list`requireddata.saved.list	object	Same fields as DialerContactList, shown earlier on this page.
`saved`requireddata.saved.saved	integer	-
`skipped`requireddata.saved.skipped	integer	-
`limitation`requireddata.limitation	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl "https://packetexchange.io/api/v1/dialer/target-lists/compatible?cliSetId=%3CcliSetId%3E" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Match inbound callers to a caller-ID set and optionally save them

POST/api/v1/dialer/target-lists/compatible

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Request body (application/json)

Field	Type	Description
`cliSetId`required	string (uuid)	-
`takingIds`	string (uuid)[] \| string	-
`saveAsListName`	string	-max 255 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerCompatibleTargets, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/target-lists/compatible" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cliSetId": "<cliSetId>"
}'

Run it here with a test key.

Preview a cleaned number list

POST/api/v1/dialer/target-lists/refine

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

De-duplicates, filters by country dial code or prefix, and optionally removes do-not-call entries. Nothing is saved.

Request body (application/json)

Field	Type	Description
`numbers`required	string[]	-
`countryCode`	string	Country dial code, e.g. "44"max 8 chars
`prefix`	string	-max 24 chars
`suppressDnc`	boolean	-

Response 200

Field	Type	Description
`data`required	object	-
`kept`requireddata.kept	string[]	E.164 numbers that survived
`invalid`requireddata.invalid	integer	-
`dup`requireddata.dup	integer	-
`filtered`requireddata.filtered	integer	-
`suppressed`requireddata.suppressed	integer	-
`total`requireddata.total	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/target-lists/refine" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "numbers": [
    "+447700900123"
  ]
}'

Run it here with a test key.

Save numbers as a contact list

POST/api/v1/dialer/target-lists/save

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Only valid full E.164 numbers are stored.

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`numbers`required	string[]	-

Response 201

Field	Type	Description
`data`required	object	-
`list`requireddata.list	object	Same fields as DialerContactList, shown earlier on this page.
`saved`requireddata.saved	integer	-
`skipped`requireddata.skipped	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/target-lists/save" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "numbers": [
    "+447700900123"
  ]
}'

Run it here with a test key.

List your SMS templates

GET/api/v1/dialer/templates

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`userId`requireddata[].userId	string (uuid)	-
`name`requireddata[].name	string	-
`body`requireddata[].body	string	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Create an SMS template

POST/api/v1/dialer/templates

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

{{variable}} placeholders are stored as written; per-recipient merge is not applied yet.

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`body`required	string	-max 1600 chars

Response 201

Field	Type	Description
`data`required	object	Same fields as DialerSmsTemplate, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/templates" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "body": "Hello from Acme"
}'

Run it here with a test key.

Update an SMS template

PATCH/api/v1/dialer/templates/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Request body (application/json)

Field	Type	Description
`name`	string	-max 255 chars
`body`	string	-max 1600 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as DialerSmsTemplate, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PATCH "https://packetexchange.io/api/v1/dialer/templates/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "body": "Hello from Acme"
}'

Run it here with a test key.

Delete an SMS template

DELETE/api/v1/dialer/templates/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as Message, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List your saved contact lists

GET/api/v1/dialer/contact-lists

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object[]	Same fields as DialerContactList, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Create a saved contact list

POST/api/v1/dialer/contact-lists

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`numbers`required	string[]	-

Response 201

Field	Type	Description
`data`required	object	Same fields as DialerContactList, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/contact-lists" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "numbers": [
    "+447700900123"
  ]
}'

Run it here with a test key.

Get a saved contact list with its numbers

GET/api/v1/dialer/contact-lists/{id}

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`userId`requireddata.userId	string (uuid)	-
`name`requireddata.name	string	-
`count`requireddata.count	integer	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`numbers`requireddata.numbers	string[]	Bare numbers (kept for existing clients)
`contacts`requireddata.contacts	object[]	-
`number`requireddata.contacts[].number	string	-
`name`requireddata.contacts[].name	string \| null	-
`fields`requireddata.contacts[].fields	object \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Delete a saved contact list

DELETE/api/v1/dialer/contact-lists/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as Message, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List your simple caller-ID lists

GET/api/v1/dialer/cli-sets

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

The older named caller-ID lists used by the campaign wizard. For rotation, caps and stats use /dialer/caller-ids.

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`userId`requireddata[].userId	string (uuid)	-
`name`requireddata[].name	string	-
`clis`requireddata[].clis	string	The caller IDs, newline-separated
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Create a simple caller-ID list

POST/api/v1/dialer/cli-sets

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`clis`required	string[]	-

Response 201

Field	Type	Description
`data`required	object	Same fields as DialerCliSet, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/dialer/cli-sets" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "clis": [
    "+447700900123"
  ]
}'

Run it here with a test key.

Delete a simple caller-ID list

DELETE/api/v1/dialer/cli-sets/{id}

Access: API key. Scoped keys need dialer:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	-

Response 200

Field	Type	Description
`data`required	object	Same fields as Message, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.