API reference

Revenue share numbers

Revenue share number pools, IVR and payouts.

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

BrowseRevenue share numbers

Browse the revenue share number pool

GET/api/v1/revshare/numbers

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

Cheapest first. Rates shown are what you earn per minute at the best payment term.

Parameters

Name	In	Type	Description
`country`	query	string	Country name contains
`countryCode`	query	string	-
`q`	query	string	Number starts with these digits
`numberFrom`	query	string	-
`numberTo`	query	string	-
`maxRate`	query	number	-
`status`	query	string	Default availableOne of available, taken, retired
`limit`	query	integer	-
`offset`	query	integer	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`number`requireddata[].number	string	-
`country`requireddata[].country	string \| null	-
`countryCode`requireddata[].countryCode	string \| null	-
`carrier`requireddata[].carrier	string \| null	-
`rangeLabel`requireddata[].rangeLabel	string \| null	-
`groupKey`requireddata[].groupKey	string	-
`status`requireddata[].status	string	-One of `available`, `taken`, `retired`
`ratePerMin`requireddata[].ratePerMin	money	What you earn per minute at the best payment term USD as a decimal string with exactly 6 places, e.g. "0.012500".
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`total`	integer	-
`limit`	integer	-
`offset`	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.

Take a revenue share number

POST/api/v1/revshare/numbers/{id}/take

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

You earn on every inbound minute to it. At most 5 numbers of one type per account.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`term`required	string	-One of `1_1`, `7_1`, `15_15`

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`numberId`requireddata.numberId	string (uuid)	-
`userId`requireddata.userId	string (uuid)	-
`paymentTerm`requireddata.paymentTerm	string	Payout cadence: 1_1 any day, 7_1 weekly, 15_15 twice monthlyOne of `1_1`, `7_1`, `15_15`
`effectiveRate`requireddata.effectiveRate	money	What you earn per minute on this number USD as a decimal string with exactly 6 places, e.g. "0.012500".
`ivrConfigId`requireddata.ivrConfigId	string (uuid) \| null	-
`ivrMode`requireddata.ivrMode	string	-One of `single`, `split`, `geo`
`status`requireddata.status	string	-One of `active`, `released`
`callsCount`requireddata.callsCount	integer	-
`minutesTotal`requireddata.minutesTotal	string	-
`earningsTotal`requireddata.earningsTotal	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`lastCallAt`requireddata.lastCallAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`takenAt`requireddata.takenAt	string (date-time)	ISO-8601 timestamp (UTC)
`releasedAt`requireddata.releasedAt	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.
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/revshare/numbers/<id>/take" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "term": "1_1"
}'

Run it here with a test key.

Take one number of every available type

POST/api/v1/revshare/take-one-of-each

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

Skips types where you already hold the maximum.

Request body (application/json)

Field	Type	Description
`term`required	string	-One of `1_1`, `7_1`, `15_15`

Response 200

Field	Type	Description
`data`required	object	-
`taken`requireddata.taken	integer	-
`groups`requireddata.groups	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/revshare/take-one-of-each" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "term": "1_1"
}'

Run it here with a test key.

Release a revenue share number back to the pool

POST/api/v1/revshare/takings/{id}/release

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	-

Response 200

Field	Type	Description
`data`required	object	Same fields as RevshareTaking, 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 the revenue share numbers you hold

GET/api/v1/revshare/my-numbers

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

Active and released numbers with running call, minute and earnings totals.

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`numberId`requireddata[].numberId	string (uuid)	-
`number`requireddata[].number	string	-
`country`requireddata[].country	string \| null	-
`countryCode`requireddata[].countryCode	string \| null	-
`carrier`requireddata[].carrier	string \| null	-
`paymentTerm`requireddata[].paymentTerm	string	Payout cadence: 1_1 any day, 7_1 weekly, 15_15 twice monthlyOne of `1_1`, `7_1`, `15_15`
`ratePerMin`requireddata[].ratePerMin	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`status`requireddata[].status	string	-One of `active`, `released`
`callsCount`requireddata[].callsCount	integer	-
`minutesTotal`requireddata[].minutesTotal	string	-
`earningsTotal`requireddata[].earningsTotal	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`lastCallAt`requireddata[].lastCallAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`ivrConfigId`requireddata[].ivrConfigId	string (uuid) \| null	-
`ivrMode`requireddata[].ivrMode	string	-One of `single`, `split`, `geo`
`takenAt`requireddata[].takenAt	string (date-time)	ISO-8601 timestamp (UTC)
`releasedAt`requireddata[].releasedAt	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.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List calls to your revenue share numbers

GET/api/v1/revshare/cdrs

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

Newest first. format=csv downloads up to 5,000 rows as CSV.

Parameters

Name	In	Type	Description
`numberId`	query	string (uuid)	-
`from`	query	string	ISO date or timestamp
`to`	query	string	-
`format`	query	string	`csv` returns a CSV download instead of JSONOne of csv
`limit`	query	integer	-
`offset`	query	integer	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`numberId`requireddata[].numberId	string (uuid)	-
`fromCarrier`requireddata[].fromCarrier	string \| null	-
`toNetwork`requireddata[].toNetwork	string \| null	-
`prefix`requireddata[].prefix	string	-
`callerNumber`requireddata[].callerNumber	string \| null	The full number that called your number; null when no caller ID was presented
`ivrConfigId`requireddata[].ivrConfigId	string (uuid) \| null	Which of your IVR variants answered, when one did
`originIso`requireddata[].originIso	string \| null	-
`originCountry`requireddata[].originCountry	string \| null	-
`startedAt`requireddata[].startedAt	string (date-time)	ISO-8601 timestamp (UTC)
`durationSec`requireddata[].durationSec	integer	-
`ratePerMin`requireddata[].ratePerMin	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`earnedAmount`requireddata[].earnedAmount	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`total`	integer	-
`limit`	integer	-
`offset`	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.

Get the public revenue share call log

GET/api/v1/revshare/access-log

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

Recent calls across the pool, with origin and destination geography for mapping.

Parameters

Name	In	Type	Description
`country`	query	string	-
`since`	query	string	-
`limit`	query	integer	-
`offset`	query	integer	-

Response 200

Field	Type	Description
`data`required	object[]	-
`fromCarrier`requireddata[].fromCarrier	string \| null	-
`toNetwork`requireddata[].toNetwork	string \| null	-
`prefix`requireddata[].prefix	string	-
`country`requireddata[].country	string \| null	-
`startedAt`requireddata[].startedAt	string (date-time)	ISO-8601 timestamp (UTC)
`toIso`requireddata[].toIso	string \| null	-
`toLat`requireddata[].toLat	number \| null	-
`toLng`requireddata[].toLng	number \| null	-
`fromIso`requireddata[].fromIso	string \| null	-
`fromLat`requireddata[].fromLat	number \| null	-
`fromLng`requireddata[].fromLng	number \| null	-
`fromCountry`requireddata[].fromCountry	string \| null	-
`limit`	integer	-
`offset`	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.

List the carrier paths that reach the pool

GET/api/v1/revshare/access-paths

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
`country`	query	string	-
`limit`	query	integer	-

Response 200

Field	Type	Description
`data`required	object[]	-
`fromCarrier`requireddata[].fromCarrier	string \| null	-
`toNetwork`requireddata[].toNetwork	string \| null	-
`country`requireddata[].country	string \| null	-
`countryCode`requireddata[].countryCode	string \| null	-
`numbers`requireddata[].numbers	integer	-
`toIso`requireddata[].toIso	string \| null	-
`toLat`requireddata[].toLat	number \| null	-
`toLng`requireddata[].toLng	number \| null	-
`fromIso`requireddata[].fromIso	string \| null	-
`fromLat`requireddata[].fromLat	number \| null	-
`fromLng`requireddata[].fromLng	number \| null	-
`fromCountry`requireddata[].fromCountry	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.

List revenue share rates by number type

GET/api/v1/revshare/rates

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

Available count and what you earn per minute at the best payment term. format=csv downloads CSV.

Parameters

Name	In	Type	Description
`country`	query	string	-
`countryCode`	query	string	-
`maxRate`	query	number	-
`format`	query	string	`csv` returns a CSV download instead of JSONOne of csv
`limit`	query	integer	-
`offset`	query	integer	-

Response 200

Field	Type	Description
`data`required	object[]	-
`groupKey`requireddata[].groupKey	string	-
`country`requireddata[].country	string \| null	-
`countryCode`requireddata[].countryCode	string \| null	-
`isoCountry`requireddata[].isoCountry	string \| null	-
`lat`requireddata[].lat	number \| null	-
`lng`requireddata[].lng	number \| null	-
`availableCount`requireddata[].availableCount	integer	-
`ratePerMin`requireddata[].ratePerMin	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".

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 your revenue share balance

GET/api/v1/revshare/balance

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

available = earned minus paid, requested and forfeited.

Response 200

Field	Type	Description
`data`required	object	-
`earned`requireddata.earned	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`paid`requireddata.paid	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`requested`requireddata.requested	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`available`requireddata.available	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".

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 when each payout term next opens

GET/api/v1/revshare/schedule

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[]	-
`term`requireddata[].term	string	Payout cadence: 1_1 any day, 7_1 weekly, 15_15 twice monthlyOne of `1_1`, `7_1`, `15_15`
`label`requireddata[].label	string	-
`cadence`requireddata[].cadence	string	-
`nextOpen`requireddata[].nextOpen	string (date-time)	ISO-8601 timestamp (UTC)
`openNow`requireddata[].openNow	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.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get a revenue share earnings statement

GET/api/v1/revshare/statement

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

Totals by number and by origin carrier for a period. format=csv downloads CSV.

Parameters

Name	In	Type	Description
`from`	query	string	-
`to`	query	string	-
`format`	query	string	`csv` returns a CSV download instead of JSONOne of csv

Response 200

Field	Type	Description
`data`required	object	-
`period`requireddata.period	object	-
`from`requireddata.period.from	string (date-time) \| null	ISO-8601 timestamp (UTC)
`to`requireddata.period.to	string (date-time) \| null	ISO-8601 timestamp (UTC)
`totals`requireddata.totals	object	-
`calls`requireddata.totals.calls	integer	-
`minutes`requireddata.totals.minutes	number	-
`earned`requireddata.totals.earned	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`byNumber`requireddata.byNumber	object[]	-
`number`requireddata.byNumber[].number	string	-
`country`requireddata.byNumber[].country	string \| null	-
`calls`requireddata.byNumber[].calls	integer	-
`minutes`requireddata.byNumber[].minutes	number	-
`earned`requireddata.byNumber[].earned	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`byOrigin`requireddata.byOrigin	object[]	-
`fromCarrier`requireddata.byOrigin[].fromCarrier	string \| null	-
`calls`requireddata.byOrigin[].calls	integer	-
`minutes`requireddata.byOrigin[].minutes	number	-
`earned`requireddata.byOrigin[].earned	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".

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.

List your revenue share payout requests

GET/api/v1/revshare/payouts

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)	-
`amount`requireddata[].amount	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`cryptoAsset`requireddata[].cryptoAsset	string \| null	-
`network`requireddata[].network	string \| null	-
`address`requireddata[].address	string \| null	-
`term`requireddata[].term	string	Payout cadence: 1_1 any day, 7_1 weekly, 15_15 twice monthlyOne of `1_1`, `7_1`, `15_15`
`status`requireddata[].status	string	-One of `requested`, `approved`, `paid`, `rejected`
`txRef`requireddata[].txRef	string \| null	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`paidAt`requireddata[].paidAt	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.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Request a revenue share payout

POST/api/v1/revshare/payouts

Access: Dashboard session. API keys are refused with 403. Use a login access token.
Rate limit: 100 requests per second (the default)
Moves money: Requests a payout of your balance.

Paid in crypto to the address given. Subject to the minimum payout and, when enabled, identity verification.

Request body (application/json)

Field	Type	Description
`amount`required	number	-min 50
`cryptoAsset`	string	-max 40 chars
`network`	string	-max 40 chars
`address`	string	-max 200 chars
`term`required	string	-One of `1_1`, `7_1`, `15_15`

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`amount`requireddata.amount	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`cryptoAsset`requireddata.cryptoAsset	string \| null	-
`network`requireddata.network	string \| null	-
`address`requireddata.address	string \| null	-
`paymentTerm`requireddata.paymentTerm	string	Payout cadence: 1_1 any day, 7_1 weekly, 15_15 twice monthlyOne of `1_1`, `7_1`, `15_15`
`status`requireddata.status	string	-One of `requested`
`requestedAt`requireddata.requestedAt	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.
AlsoKYC_REQUIRED

HTTP

curl -X POST "https://packetexchange.io/api/v1/revshare/payouts" \
  -H "Authorization: Bearer $PACKETEXCHANGE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 50,
  "term": "1_1"
}'

Session-only: run it from the dashboard.

List your IVR configurations

GET/api/v1/revshare/ivr-configs

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)	-
`takingId`requireddata[].takingId	string (uuid) \| null	-
`kind`requireddata[].kind	string	-One of `default_music`, `upload`, `tts`
`name`requireddata[].name	string \| null	-
`assetPath`requireddata[].assetPath	string \| null	-
`assetMime`requireddata[].assetMime	string \| null	Set when audio exists; stream it from the preview endpoint
`ttsText`requireddata[].ttsText	string \| null	-
`ttsVoiceId`requireddata[].ttsVoiceId	string \| null	-
`status`requireddata[].status	string	-One of `draft`, `active`
`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 IVR configuration

POST/api/v1/revshare/ivr-configs

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

Request body (application/json)

Field	Type	Description
`kind`required	string	-One of `default_music`, `upload`, `tts`
`takingId`	string (uuid) \| null	-
`name`	string \| null	-max 120 chars
`assetPath`	string \| null	-max 1024 chars
`ttsText`	string \| null	-max 4000 chars
`ttsVoiceId`	string \| null	-max 120 chars
`status`	string	-One of `draft`, `active`

Response 201

Field	Type	Description
`data`required	object	Same fields as RevshareIvrConfig, 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/revshare/ivr-configs" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "default_music"
}'

Run it here with a test key.

Update an IVR configuration

PATCH/api/v1/revshare/ivr-configs/{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	-

Request body (application/json)

Field	Type	Description
`kind`	string	-One of `default_music`, `upload`, `tts`
`takingId`	string (uuid) \| null	-
`name`	string \| null	-max 120 chars
`assetPath`	string \| null	-max 1024 chars
`ttsText`	string \| null	-max 4000 chars
`ttsVoiceId`	string \| null	-max 120 chars
`status`	string	-One of `draft`, `active`

Response 200

Field	Type	Description
`data`required	object	Same fields as RevshareIvrConfig, 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/revshare/ivr-configs/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "default_music",
  "takingId": "<takingId>"
}'

Run it here with a test key.

Delete an IVR configuration

DELETE/api/v1/revshare/ivr-configs/{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	-

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.

Preview text-to-speech audio before saving

POST/api/v1/revshare/ivr-configs/preview

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 20 requests per minute

Request body (application/json)

Field	Type	Description
`kind`	string	-
`ttsText`required	string	-max 600 chars
`ttsVoiceId`required	string	-

Response 200 (audio/mpeg)

The spoken text as MP3 audio.

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/revshare/ivr-configs/preview" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ttsText": "<ttsText>",
  "ttsVoiceId": "<ttsVoiceId>"
}'

Run it here with a test key.

Generate the audio for a text-to-speech IVR

POST/api/v1/revshare/ivr-configs/{id}/generate

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

Renders and stores the audio, and returns it.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200 (audio/mpeg)

The generated audio.

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.

Play an IVR configuration's audio

GET/api/v1/revshare/ivr-configs/{id}/preview

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	-

Response 200 (audio/mpeg)

The stored audio, in the media type it was saved with.

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.

Upload audio for an IVR

POST/api/v1/revshare/ivr-configs/upload

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

Send a multipart file (with optional takingId and name fields), or JSON with contentBase64 as below.

Request body (application/json)

Field	Type	Description
`contentBase64`	string	-
`contentType`	string \| null	-max 120 chars
`takingId`	string (uuid) \| null	-
`name`	string \| null	-max 120 chars

Response 201

Field	Type	Description
`data`required	object	Same fields as RevshareIvrConfig, 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/revshare/ivr-configs/upload" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contentBase64": "<contentBase64>",
  "contentType": "<contentType>"
}'

Run it here with a test key.

Attach an IVR to a number you hold

PATCH/api/v1/revshare/takings/{id}

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

Send ivrConfigId: null to fall back to the default music loop.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`ivrConfigId`	string (uuid) \| null	-

Response 200

Field	Type	Description
`data`required	object	Same fields as RevshareTaking, 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/revshare/takings/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ivrConfigId": "<ivrConfigId>"
}'

Run it here with a test key.

Get the IVR set on a number you hold

GET/api/v1/revshare/takings/{id}/ivr

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	-

Response 200

Field	Type	Description
`data`required	object	-
`mode`requireddata.mode	string	-One of `single`, `split`, `geo`
`variants`requireddata.variants	object[]	-
`id`requireddata.variants[].id	string (uuid)	-
`ivrConfigId`requireddata.variants[].ivrConfigId	string (uuid)	-
`name`requireddata.variants[].name	string	-
`kind`requireddata.variants[].kind	string \| null	-One of `default_music`, `upload`, `tts`
`weightPct`requireddata.variants[].weightPct	integer \| null	-
`originIso`requireddata.variants[].originIso	string \| null	-
`originCountry`requireddata.variants[].originCountry	string \| null	-
`enabled`requireddata.variants[].enabled	boolean \| 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.

Replace the IVR set on a number you hold

PUT/api/v1/revshare/takings/{id}/ivr

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

single: exactly one variant. split: two or more, each with a weight. geo: one per caller country plus at most one default.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`mode`required	string	-One of `single`, `split`, `geo`
`variants`required	object[]	-
`ivrConfigId`requiredvariants[].ivrConfigId	string (uuid)	-
`weightPct`variants[].weightPct	integer \| null	-1 to 100
`originIso`variants[].originIso	string \| null	-max 2 chars
`originCountry`variants[].originCountry	string \| null	-max 120 chars
`enabled`variants[].enabled	boolean \| null	-

Response 200

Field	Type	Description
`data`required	object	Same fields as RevshareIvrSet, 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/revshare/takings/<id>/ivr" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "single",
  "variants": [
    {
      "ivrConfigId": "<ivrConfigId>"
    }
  ]
}'

Run it here with a test key.

Compare IVR variants on a number you hold

GET/api/v1/revshare/takings/{id}/ivr-stats

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

Calls, minutes and earnings per variant and per caller country, with the best-earning variant once two have calls.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`from`	query	string	-
`to`	query	string	-

Response 200

Field	Type	Description
`data`required	object	-
`period`requireddata.period	object	-
`from`requireddata.period.from	string (date-time) \| null	ISO-8601 timestamp (UTC)
`to`requireddata.period.to	string (date-time) \| null	ISO-8601 timestamp (UTC)
`byVariant`requireddata.byVariant	object[]	-
`byCountry`requireddata.byCountry	object[]	-
`iso`requireddata.byCountry[].iso	string \| null	-
`country`requireddata.byCountry[].country	string \| null	-
`calls`requireddata.byCountry[].calls	integer	-
`minutes`requireddata.byCountry[].minutes	number	-
`earnings`requireddata.byCountry[].earnings	number	-
`winner`requireddata.winner	string (uuid) \| 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.