API reference

Marketplace routes

Browse, resolve, list and manage voice and SMS termination routes.

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

BrowseMarketplace routes

Browse the route marketplace

GET/api/v1/routes

Access: Key optional. A key or token personalises the answer.
Rate limit: 100 requests per second (the default)

Public. Every row is anonymous: no seller name, id or endpoint. Signed-in callers get the full stats block; anonymous callers get counts only. Money fields are 6-decimal USD strings. Each row carries measured (ASR, ACD, NER and PDD measured from real calls, or null) beside the seller-stated expectedAsr/expectedAcd/expectedPdd; anonymous callers get the attempt count as a band and no buyer count. Sort by measured quality with sort=measured_asr_desc|measured_asr_asc|measured_acd_desc|measured_acd_asc|ner_desc|ner_asc, or quality_desc (measured NER then ASR where measured, else stated ASR): listings with measured figures come first.

Parameters

Name	In	Type	Description
`type`	query	string	-One of voice, sms
`country`	query	string	-
`countryCode`	query	string	-
`cliType`	query	string	-One of full_cli, local_cli, mixed_cli, ncli, partial_cli
`routeType`	query	string	-One of direct, premium, standard, ncli
`minPrice`	query	string	-
`maxPrice`	query	string	-
`minAsr`	query	string	-
`minAcd`	query	string	-
`maxPdd`	query	string	-
`minScore`	query	integer	-
`minCapacity`	query	integer	-
`billing`	query	string	-One of per_second, per_minute
`wholesale`	query	string	-One of true, false
`callcenter`	query	string	-One of true, false
`retail`	query	string	-One of true, false
`otp`	query	string	-One of true, false
`openRtp`	query	string	-One of true, false
`dialer`	query	string	-One of true, false
`a2p`	query	string	-One of true, false
`bundlesOnly`	query	string	-One of true, false
`search`	query	string	-
`sort`	query	string	-One of price_asc, price_desc, asr_desc, asr_asc, acd_desc, acd_asc, pdd_asc, pdd_desc, capacity_desc, created_desc, country_asc, score_desc, score_asc, measured_asr_desc, measured_asr_asc, measured_acd_desc, measured_acd_asc, ner_desc, ner_asc, quality_desc
`cursor`	query	string (uuid)	-
`limit`	query	integer	-Default 25

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`kind`requireddata[].kind	string	-One of `single`, `blend`
`type`requireddata[].type	string	-One of `voice`, `sms`
`country`requireddata[].country	string	-
`countryCode`requireddata[].countryCode	string	E.164 country calling code, digits only
`prefix`requireddata[].prefix	string[]	Dial prefixes the route covers
`destinationName`requireddata[].destinationName	string	The listing name. For anyone but the seller it is GENERATED by the platform from its own data, never the seller's text: "<Country> <Operator?> <Mobile\|Fixed\|All Networks>" for one destination (e.g. "Niger Mobile", "Kenya Safaricom Mobile"), "A-Z Voice · <tier> · <CLI> · Ref XXXX" or "A-Z SMS · <quality> · Ref XXXX" for an A-Z bundle. The seller sees the name they gave it.
`cliType`requireddata[].cliType	string	-One of `full_cli`, `ncli`, `partial_cli`, `local_cli`, `mixed_cli`
`routeType`requireddata[].routeType	string	Quality tierOne of `direct`, `premium`, `standard`, `ncli`
`pricePerUnit`requireddata[].pricePerUnit	money	USD per minute (voice) or per message segment (SMS). On an A-Z deck (rateCount > 0) the per-destination rates apply instead. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata[].billingIncrement	string \| null	First/subsequent increment in seconds, e.g. "60/60"
`capacity`requireddata[].capacity	integer	Channels (voice) or messages per second (SMS)
`expectedAsr`requireddata[].expectedAsr	string \| null	Seller-stated ASR %. The measured figure is in `measured.asr`
`expectedAcd`requireddata[].expectedAcd	string \| null	Seller-stated ACD in seconds
`expectedPdd`requireddata[].expectedPdd	string \| null	Seller-stated PDD in seconds
`minAcd`requireddata[].minAcd	integer \| null	-
`minAsr`requireddata[].minAsr	string \| null	Decimal as a string, e.g. "92.50"
`visibility`requireddata[].visibility	string	-One of `public`, `private`
`status`requireddata[].status	string	-One of `active`, `paused`, `suspended`, `pending_review`
`wholesaleCompatible`requireddata[].wholesaleCompatible	boolean	-
`callcenterCompatible`requireddata[].callcenterCompatible	boolean	-
`dialerCompatible`requireddata[].dialerCompatible	boolean	-
`retailCompatible`requireddata[].retailCompatible	boolean	-
`otpCompatible`requireddata[].otpCompatible	boolean	-
`notes`requireddata[].notes	string \| null	-
`smsType`data[].smsType	string \| null	-One of `a2p`, `p2p`, `both`
`exchangeScore`requireddata[].exchangeScore	integer \| null	Exchange Score 1-100, null until the route has carried real traffic. Uses the measured ASR, NER, ACD and PDD in place of the stated ones when the listing has recent measured figures
`lastQcAt`requireddata[].lastQcAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`measured`data[].measured	object \| null	Measured quality from real calls; null until the listing has enough traffic from enough buyers
`window`requireddata[].measured.window	string	Evidence window: the last 7 days if enough, else the last 30, else `last` = the most recent 30-day stretch that had enoughOne of `7d`, `30d`, `last`
`from`requireddata[].measured.from	string	First UTC day of the evidence, YYYY-MM-DD
`to`requireddata[].measured.to	string	Last UTC day of the evidence, YYYY-MM-DD
`sessions`requireddata[].measured.sessions	integer	Call attempts on this listing the figures are built from (at least 50). For anonymous callers, floored to a band (50, 100, 250, 500, 1000, 5000, ...) with `sessionsBanded: true`
`sessionsBanded`data[].measured.sessionsBanded	boolean	True when `sessions` is a band floor (anonymous callers)
`buyers`requireddata[].measured.buyers	integer \| null	Distinct buying accounts behind the figures (at least 2). Null for anonymous callers
`asr`requireddata[].measured.asr	number \| null	Answer-seizure ratio %: answered attempts / attempts
`acd`requireddata[].measured.acd	number \| null	Average call duration of answered attempts, seconds of talk time
`ner`requireddata[].measured.ner	number \| null	Network effectiveness ratio %: attempts the network delivered to the handset (answered, user busy, no answer, callee rejected) / attempts
`pddMs`requireddata[].measured.pddMs	integer \| null	Median post-dial delay in milliseconds (to the nearest 100 ms); null when not captured
`routeChecks`data[].routeChecks	object \| null	Route checks on this listing in the last 7 days. Null when there were none.
`total`requireddata[].routeChecks.total	integer	Route checks in the last 7 days that count towards the listing's health (calls to registered test lines)
`answered`requireddata[].routeChecks.answered	integer	Of those, how many the test line answered through this route
`lastAt`requireddata[].routeChecks.lastAt	string (date-time) \| null	When the last check completed
`lastResult`requireddata[].routeChecks.lastResult	string \| null	The last check's verdict: working, no_capacity or not_delivered
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata[].updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`isOwn`requireddata[].isOwn	boolean	True only on your own listings
`listingRef`data[].listingRef	string	Anonymous short reference of the listing (4 characters, e.g. "7K2Q"): stable for the life of the listing, unique enough to tell two same-named listings apart, and derived from the listing alone (it says nothing about the seller). Absent on your own listings.
`sellerProfile`requireddata[].sellerProfile	object \| null	Trust signals only. The marketplace never names the seller behind a listing.
`verified`requireddata[].sellerProfile.verified	boolean	Seller identity verified
`sellerScore`requireddata[].sellerProfile.sellerScore	integer \| null	Average Exchange Score across the seller's trafficked routes
`rateCount`requireddata[].rateCount	integer	Active per-destination deck rows; > 0 means an A-Z deck
`priceTrend`data[].priceTrend	object \| null	Real 24h price movement from the price history; null when the route has not repriced
`changePct`requireddata[].priceTrend.changePct	number	-
`points`requireddata[].priceTrend.points	number[]	-
`nextCursor`	string \| null	-
`hasMore`	boolean	-
`total`	integer	Routes matching the filters across all pages
`stats`	object	-
`total`requiredstats.total	integer	-
`voiceCount`requiredstats.voiceCount	integer	-
`smsCount`requiredstats.smsCount	integer	-
`destinations`requiredstats.destinations	integer	-
`avgPrice`stats.avgPrice	number \| null	Signed-in callers only. Average list price (display figure)
`avgAsr`stats.avgAsr	number \| null	Signed-in only. Average seller-stated ASR %
`measuredAsr`stats.measuredAsr	number \| null	Signed-in only. Measured ASR % over 30 days of real calls
`avgScore`stats.avgScore	integer \| null	Signed-in only
`totalCapacity`stats.totalCapacity	integer	Signed-in only

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 a new route for sale

POST/api/v1/routes

Access: API key. Scoped keys need routes:write.
Rate limit: 30 requests per minute

Request body (application/json)

Field	Type	Description
`type`required	string	-One of `voice`, `sms`
`country`required	string	-max 100 chars
`countryCode`required	string	-
`prefix`required	string[]	-
`destinationName`required	string	-max 255 chars
`pricePerUnit`required	string	-
`cliType`required	string	-One of `full_cli`, `local_cli`, `mixed_cli`, `ncli`, `partial_cli`
`capacity`required	integer	-0 to 1000000
`expectedAsr`	string	-
`expectedAcd`	string	-
`expectedPdd`	string	-
`minAsr`	string	-
`minAcd`	integer	-min 0
`billingIncrement`required	string	-
`routeType`required	string	-One of `direct`, `premium`, `standard`, `ncli`
`wholesaleCompatible`	boolean	-default true
`callcenterCompatible`	boolean	-default true
`dialerCompatible`	boolean	-default true
`retailCompatible`	boolean	-default true
`otpCompatible`	boolean	-default true
`openRtp`	boolean	-default false
`visibility`	string	-default "public"One of `public`, `private`
`jingleEnabled`	boolean	-default false
`jingleApiUrl`	string (uri) \| null	-
`smsDeliveryUrl`	string (uri) \| null	-
`smsDeliveryMethod`	string	-One of `http`, `smpp`
`smppHost`	string \| null	-
`smppPort`	integer \| null	-1 to 65535
`smppSystemId`	string \| null	-
`smppPassword`	string \| null	-max 64 chars
`smppBindType`	string \| null	-One of `transceiver`, `transmitter`
`smppSystemType`	string \| null	-max 13 chars
`smppTps`	integer \| null	-1 to 1000
`smppSourceTon`	integer \| null	-0 to 6
`smppSourceNpi`	integer \| null	-0 to 18
`smppDestTon`	integer \| null	-0 to 6
`smppDestNpi`	integer \| null	-0 to 18
`jingleSipIp`	string \| null	-
`sipPort`	integer \| null	-1 to 65535
`sipAuthUsername`	string \| null	-max 128 chars
`sipAuthPassword`	string \| null	-max 128 chars
`techPrefix`	string \| null	-
`numberFormat`	object \| null	-
`mode`numberFormat.mode	string	-One of `custom`
`nationalPrefix`numberFormat.nationalPrefix	string	-
`strip`numberFormat.strip	integer	-0 to 10
`add`numberFormat.add	string	-
`t38Support`	boolean	-default false
`supportedCodecs`	string[]	-
`maxCallDuration`	integer	-min 0
`smsType`	string	-One of `a2p`, `p2p`, `both`
`smsDlrSupport`	boolean	-
`smsConcatSupport`	boolean	-
`smsSenderIdType`	string	-One of `alphanumeric`, `numeric`, `preregistered`
`smsContentRestrictions`	string	-
`smsRouteQuality`	string \| null	-One of `hq`, `direct`, `aggregator`, `sim`
`smsSenderIdBehavior`	string \| null	-One of `alphanumeric_preserved`, `numeric_long`, `overwritten`, `not_guaranteed`
`smsDlrLevel`	string \| null	-One of `real_operator`, `intermediate`, `submit_only`, `none`
`smsDlrPercent`	string \| null	-
`smsUnicodeSupport`	boolean \| null	-
`smsAcceptedTraffic`	string[] \| null	-One of `wholesale`, `transactional`, `otp`, `marketing`, `promo_shortcode`
`timeOfDayPricing`	object	-
`notes`	string	-max 2000 chars

Response 201

Field	Type	Description
`data`required	object	A route you listed, as only you (the seller) see it. Passwords are never returned.
`id`requireddata.id	string (uuid)	-
`kind`requireddata.kind	string	-One of `single`, `blend`
`type`requireddata.type	string	-One of `voice`, `sms`
`country`requireddata.country	string	-
`countryCode`requireddata.countryCode	string	E.164 country calling code, digits only
`prefix`requireddata.prefix	string[]	Dial prefixes the route covers
`destinationName`requireddata.destinationName	string	The listing name. For anyone but the seller it is GENERATED by the platform from its own data, never the seller's text: "<Country> <Operator?> <Mobile\|Fixed\|All Networks>" for one destination (e.g. "Niger Mobile", "Kenya Safaricom Mobile"), "A-Z Voice · <tier> · <CLI> · Ref XXXX" or "A-Z SMS · <quality> · Ref XXXX" for an A-Z bundle. The seller sees the name they gave it.
`cliType`requireddata.cliType	string	-One of `full_cli`, `ncli`, `partial_cli`, `local_cli`, `mixed_cli`
`routeType`requireddata.routeType	string	Quality tierOne of `direct`, `premium`, `standard`, `ncli`
`pricePerUnit`requireddata.pricePerUnit	money	USD per minute (voice) or per message segment (SMS). On an A-Z deck (rateCount > 0) the per-destination rates apply instead. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata.billingIncrement	string \| null	First/subsequent increment in seconds, e.g. "60/60"
`capacity`requireddata.capacity	integer	Channels (voice) or messages per second (SMS)
`expectedAsr`requireddata.expectedAsr	string \| null	Seller-stated ASR %. The measured figure is in `measured.asr`
`expectedAcd`requireddata.expectedAcd	string \| null	Seller-stated ACD in seconds
`expectedPdd`requireddata.expectedPdd	string \| null	Seller-stated PDD in seconds
`minAcd`requireddata.minAcd	integer \| null	-
`minAsr`requireddata.minAsr	string \| null	Decimal as a string, e.g. "92.50"
`visibility`requireddata.visibility	string	-One of `public`, `private`
`status`requireddata.status	string	-One of `active`, `paused`, `suspended`, `pending_review`
`wholesaleCompatible`requireddata.wholesaleCompatible	boolean	-
`callcenterCompatible`requireddata.callcenterCompatible	boolean	-
`dialerCompatible`requireddata.dialerCompatible	boolean	-
`retailCompatible`requireddata.retailCompatible	boolean	-
`otpCompatible`requireddata.otpCompatible	boolean	-
`notes`requireddata.notes	string \| null	-
`smsType`data.smsType	string \| null	-One of `a2p`, `p2p`, `both`
`exchangeScore`requireddata.exchangeScore	integer \| null	Exchange Score 1-100, null until the route has carried real traffic. Uses the measured ASR, NER, ACD and PDD in place of the stated ones when the listing has recent measured figures
`lastQcAt`requireddata.lastQcAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`measured`data.measured	object \| null	Measured quality from real calls; null until the listing has enough traffic from enough buyersSame fields as MeasuredRouteQuality, shown earlier on this page.
`routeChecks`data.routeChecks	object \| null	Route checks on this listing in the last 7 days. Null when there were none.Same fields as RouteCheckRecord, shown earlier on this page.
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`sellerId`requireddata.sellerId	string (uuid)	Your own account id
`isOwner`data.isOwner	boolean	-One of `true`
`parentRouteId`requireddata.parentRouteId	string (uuid) \| null	-
`isBundle`requireddata.isBundle	boolean	-
`jingleSipIp`requireddata.jingleSipIp	string \| null	Your SIP endpoint
`sipPort`requireddata.sipPort	integer \| null	-
`techPrefix`requireddata.techPrefix	string \| null	-
`sipAuthUsername`requireddata.sipAuthUsername	string \| null	-
`sipAuthPasswordSet`requireddata.sipAuthPasswordSet	boolean	A SIP digest password is stored (never returned)
`smsDeliveryMethod`data.smsDeliveryMethod	string \| null	-One of `http`, `smpp`
`smsDeliveryUrl`requireddata.smsDeliveryUrl	string \| null	-
`smppHost`requireddata.smppHost	string \| null	-
`smppPort`requireddata.smppPort	integer \| null	-
`smppSystemId`requireddata.smppSystemId	string \| null	-
`smppPasswordSet`requireddata.smppPasswordSet	boolean	An SMPP password is stored (never returned)
`endpointReachable`requireddata.endpointReachable	boolean \| null	-
`endpointCheckedAt`requireddata.endpointCheckedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`sellerProfile`data.sellerProfile	object \| null	Trust signals only. The marketplace never names the seller behind a listing.Same fields as MarketplaceSellerProfile, shown earlier on this page.
`rateCount`data.rateCount	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/routes" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "voice",
  "country": "United Kingdom",
  "countryCode": "GB",
  "prefix": [
    "44"
  ],
  "destinationName": "<destinationName>",
  "pricePerUnit": "<pricePerUnit>",
  "cliType": "full_cli",
  "capacity": 1,
  "billingIncrement": "<billingIncrement>",
  "routeType": "direct"
}'

Run it here with a test key.

Get marketplace totals for a filter

GET/api/v1/routes/stats

Access: Key optional. A key or token personalises the answer.
Rate limit: 100 requests per second (the default)

Same filters as the listing. Anonymous callers get counts only; price, ASR, score and capacity figures need a signed-in caller.

Parameters

Name	In	Type	Description
`type`	query	string	-One of voice, sms
`country`	query	string	-
`countryCode`	query	string	-
`cliType`	query	string	-One of full_cli, local_cli, mixed_cli, ncli, partial_cli
`routeType`	query	string	-One of direct, premium, standard, ncli
`minPrice`	query	string	-
`maxPrice`	query	string	-
`minAsr`	query	string	-
`minAcd`	query	string	-
`maxPdd`	query	string	-
`minScore`	query	integer	-
`minCapacity`	query	integer	-
`billing`	query	string	-One of per_second, per_minute
`wholesale`	query	string	-One of true, false
`callcenter`	query	string	-One of true, false
`retail`	query	string	-One of true, false
`otp`	query	string	-One of true, false
`openRtp`	query	string	-One of true, false
`dialer`	query	string	-One of true, false
`a2p`	query	string	-One of true, false
`bundlesOnly`	query	string	-One of true, false
`search`	query	string	-
`sort`	query	string	-One of price_asc, price_desc, asr_desc, asr_asc, acd_desc, acd_asc, pdd_asc, pdd_desc, capacity_desc, created_desc, country_asc, score_desc, score_asc, measured_asr_desc, measured_asr_asc, measured_acd_desc, measured_acd_asc, ner_desc, ner_asc, quality_desc
`cursor`	query	string (uuid)	-
`limit`	query	integer	-Default 25

Response 200

Field	Type	Description
`data`required	object	Same fields as MarketplaceStats, 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.

Price a phone number across the marketplace

GET/api/v1/routes/price-number

Access: Key optional. A key or token personalises the answer.
Rate limit: 30 requests per minute

Every buyer-visible route that serves the number, at the rate it would actually charge for it, cheapest first. A route with a rate sheet is priced by its longest matching active prefix (if that row is blocked the route does not serve the number); a single-price route serves it when a listed prefix, or failing that its country code, starts the number. This is the public list price: negotiated prices and private grants are not applied. SMS prices are by destination network on routes that price a country per mobile network: network says which network rate is for and countryRate is the price for other or unknown networks. The network is determined from the number's range (ported numbers may be priced at the network the range belongs to). The number is normalised to digits (a leading 00 is dropped). At most 100 routes are returned; total counts all of them. An embargoed destination returns no routes and notice: "sanctioned". Seller identities are never included.

Parameters

Name	In	Type	Description
`number`required	query	string	A full number or dial code, any formatting
`type`	query	string	-One of voice, smsDefault "voice"

Response 200

Field	Type	Description
`data`required	object	-
`number`requireddata.number	string	The number as priced: digits only
`type`requireddata.type	string	-One of `voice`, `sms`
`unit`requireddata.unit	string	What `rate` is per: a minute (voice) or a message (SMS)One of `min`, `msg`
`total`requireddata.total	integer	Routes that serve the number, before the 100-row cap
`routes`requireddata.routes	object[]	Cheapest first
`id`requireddata.routes[].id	string (uuid)	-
`type`requireddata.routes[].type	string	-One of `voice`, `sms`
`name`requireddata.routes[].name	string	The listing name as a buyer reads it: generated by the platform, never the seller's text, and ending in the listing reference (e.g. "Niger Mobile · Ref 7K2Q", "A-Z Voice · Premium · Full CLI · Ref 3MX9"). Your own listings keep the name you gave them.
`listingRef`data.routes[].listingRef	string	Anonymous short reference of the listing (4 characters, e.g. "7K2Q"): stable for the life of the listing, unique enough to tell two same-named listings apart, and derived from the listing alone (it says nothing about the seller). Absent on your own listings.
`country`requireddata.routes[].country	string	-
`countryCode`requireddata.routes[].countryCode	string	E.164 country calling code, digits only
`matchedPrefix`requireddata.routes[].matchedPrefix	string	The dial prefix the number matched on this route (the longest one, on a deck)
`destination`requireddata.routes[].destination	string	The destination that prefix belongs to, e.g. "United Kingdom-Mobile"; the country for a flat-priced listing
`rate`requireddata.routes[].rate	money	What this route charges for THIS number: USD per minute (voice) or per message (SMS) USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata.routes[].billingIncrement	string \| null	e.g. "60/60" or "1/1"; null when the listing does not state one
`pricedBy`requireddata.routes[].pricedBy	string	deck = priced by the matching rate-sheet row; flat = the listing's single priceOne of `deck`, `flat`
`expectedAsr`requireddata.routes[].expectedAsr	string \| null	Seller-stated ASR %. The measured figure is in `measured.asr`
`expectedAcd`requireddata.routes[].expectedAcd	string \| null	Seller-stated ACD in seconds
`cliType`requireddata.routes[].cliType	string	-
`routeType`requireddata.routes[].routeType	string	Quality tier
`capacity`requireddata.routes[].capacity	integer	Channels (voice) or messages per second (SMS)
`exchangeScore`requireddata.routes[].exchangeScore	integer \| null	Exchange Score 1-100; null ("New") until the route has carried traffic
`measured`requireddata.routes[].measured	object \| null	Measured quality of the listing from real calls; null until it has enough traffic from enough buyersSame fields as MeasuredRouteQuality, shown earlier on this page.
`routeChecks`requireddata.routes[].routeChecks	object \| null	Route checks on this listing in the last 7 days. Null when there were none.Same fields as RouteCheckRecord, shown earlier on this page.
`isOwn`requireddata.routes[].isOwn	boolean	True only on your own listing (signed-in callers), so you are not offered your own route
`network`data.routes[].network	object \| null	SMS routes that price the country per mobile network: which network `rate` is for. Absent otherwise
`mccMnc`requireddata.routes[].network.mccMnc	string \| null	Mobile network code (MCC-MNC) `rate` is for, e.g. "234-10"; null when unknown
`operator`requireddata.routes[].network.operator	string \| null	Network name from public number-range data, e.g. "O2"
`source`requireddata.routes[].network.source	string	range = number-range data; none = not determinedOne of `range`, `hlr`, `none`
`rateBasis`requireddata.routes[].network.rateBasis	string	network = that network's own rate; all_operators = the route's rate for networks it does not list separately; country = the price for other or unknown networksOne of `network`, `all_operators`, `country`
`countryRate`data.routes[].countryRate	money \| null	SMS routes that price per network: the price for other or unknown networks USD as a decimal string with exactly 6 places, e.g. "0.012500".
`notice`requireddata.notice	string \| null	Why the list is empty when it is empty for a reason other than "no route covers it"One of `sanctioned`

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 destinations on the marketplace

GET/api/v1/routes/countries

Access: Public. No key needed.
Rate limit: 100 requests per second (the default)

Every country with at least one live public route, with its route count, A to Z.

Response 200

Field	Type	Description
`data`required	object[]	-
`country`requireddata[].country	string	-
`countryCode`requireddata[].countryCode	string	-
`count`requireddata[].count	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get a route

GET/api/v1/routes/{id}

Access: Key optional. A key or token personalises the answer.
Rate limit: 100 requests per second (the default)

Public for live public routes. The seller gets the full owner view; a granted buyer sees a private route; any other signed-in caller gets an access stub for a private route. Carries measured (quality measured from real calls, or null) and routeChecks (the last 7 days of route checks, or null).

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`id`data.id	string (uuid)	-
`kind`data.kind	string	-One of `single`, `blend`
`type`data.type	string	-One of `voice`, `sms`
`country`data.country	string	-
`countryCode`data.countryCode	string	-
`prefix`data.prefix	string[]	Dial prefixes the route covers
`destinationName`data.destinationName	string	The listing name. For anyone but the seller it is GENERATED by the platform from its own data, never the seller's text: "<Country> <Operator?> <Mobile\|Fixed\|All Networks>" for one destination (e.g. "Niger Mobile", "Kenya Safaricom Mobile"), "A-Z Voice · <tier> · <CLI> · Ref XXXX" or "A-Z SMS · <quality> · Ref XXXX" for an A-Z bundle. The seller sees the name they gave it.
`cliType`data.cliType	string	-One of `full_cli`, `ncli`, `partial_cli`, `local_cli`, `mixed_cli`
`routeType`data.routeType	string	Quality tierOne of `direct`, `premium`, `standard`, `ncli`
`pricePerUnit`data.pricePerUnit	money	USD per minute (voice) or per message segment (SMS). On an A-Z deck (rateCount > 0) the per-destination rates apply instead. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`data.billingIncrement	string \| null	First/subsequent increment in seconds, e.g. "60/60"
`capacity`data.capacity	integer	Channels (voice) or messages per second (SMS)
`expectedAsr`data.expectedAsr	string \| null	Seller-stated ASR %. The measured figure is in `measured.asr`
`expectedAcd`data.expectedAcd	string \| null	Seller-stated ACD in seconds
`expectedPdd`data.expectedPdd	string \| null	Seller-stated PDD in seconds
`minAcd`data.minAcd	integer \| null	-
`minAsr`data.minAsr	string \| null	Decimal as a string, e.g. "92.50"
`visibility`data.visibility	string	-One of `private`
`status`data.status	string	-One of `active`, `paused`, `suspended`, `pending_review`
`wholesaleCompatible`data.wholesaleCompatible	boolean	-
`callcenterCompatible`data.callcenterCompatible	boolean	-
`dialerCompatible`data.dialerCompatible	boolean	-
`retailCompatible`data.retailCompatible	boolean	-
`otpCompatible`data.otpCompatible	boolean	-
`notes`data.notes	string \| null	-
`smsType`data.smsType	string \| null	-One of `a2p`, `p2p`, `both`
`exchangeScore`data.exchangeScore	integer \| null	Exchange Score 1-100, null until the route has carried real traffic. Uses the measured ASR, NER, ACD and PDD in place of the stated ones when the listing has recent measured figures
`lastQcAt`data.lastQcAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`measured`data.measured	object \| null	Measured quality from real calls; null until the listing has enough traffic from enough buyersSame fields as MeasuredRouteQuality, shown earlier on this page.
`routeChecks`data.routeChecks	object \| null	Route checks on this listing in the last 7 days. Null when there were none.Same fields as RouteCheckRecord, shown earlier on this page.
`createdAt`data.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`data.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`isOwn`data.isOwn	boolean	True only on your own listings
`listingRef`data.listingRef	string	Anonymous short reference of the listing (4 characters, e.g. "7K2Q"): stable for the life of the listing, unique enough to tell two same-named listings apart, and derived from the listing alone (it says nothing about the seller). Absent on your own listings.
`sellerProfile`data.sellerProfile	object \| null	Trust signals only. The marketplace never names the seller behind a listing.Same fields as MarketplaceSellerProfile, shown earlier on this page.
`rateCount`data.rateCount	integer	-
`priceTrend`data.priceTrend	object \| null	Real 24h price movement from the price history; null when the route has not repriced
`changePct`requireddata.priceTrend.changePct	number	-
`points`requireddata.priceTrend.points	number[]	-
`sellerId`data.sellerId	string (uuid)	Your own account id
`isOwner`data.isOwner	boolean	-One of `true`
`parentRouteId`data.parentRouteId	string (uuid) \| null	-
`isBundle`data.isBundle	boolean	-
`jingleSipIp`data.jingleSipIp	string \| null	Your SIP endpoint
`sipPort`data.sipPort	integer \| null	-
`techPrefix`data.techPrefix	string \| null	-
`sipAuthUsername`data.sipAuthUsername	string \| null	-
`sipAuthPasswordSet`data.sipAuthPasswordSet	boolean	A SIP digest password is stored (never returned)
`smsDeliveryMethod`data.smsDeliveryMethod	string \| null	-One of `http`, `smpp`
`smsDeliveryUrl`data.smsDeliveryUrl	string \| null	-
`smppHost`data.smppHost	string \| null	-
`smppPort`data.smppPort	integer \| null	-
`smppSystemId`data.smppSystemId	string \| null	-
`smppPasswordSet`data.smppPasswordSet	boolean	An SMPP password is stored (never returned)
`endpointReachable`data.endpointReachable	boolean \| null	-
`endpointCheckedAt`data.endpointCheckedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`accessRequired`data.accessRequired	boolean	-One of `true`
`accessRequestPending`data.accessRequestPending	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.
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 route you listed

PUT/api/v1/routes/{id}

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

The price of an ACTIVE route cannot change in place (400 VALIDATION_ERROR): schedule the change with POST /routes/{id}/rate-changes/flat, or pause the route first. On a paused route a price increase pauses buyers who pay the list rate until they accept it (see POST /purchases/{id}/accept-rate).

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`type`	string	-One of `voice`, `sms`
`country`	string	-max 100 chars
`countryCode`	string	-
`prefix`	string[]	-
`destinationName`	string	-max 255 chars
`pricePerUnit`	string	-
`cliType`	string	-One of `full_cli`, `local_cli`, `mixed_cli`, `ncli`, `partial_cli`
`capacity`	integer	-0 to 1000000
`expectedAsr`	string	-
`expectedAcd`	string	-
`expectedPdd`	string	-
`minAsr`	string	-
`minAcd`	integer	-min 0
`billingIncrement`	string	-
`routeType`	string	-One of `direct`, `premium`, `standard`, `ncli`
`wholesaleCompatible`	boolean	-default true
`callcenterCompatible`	boolean	-default true
`dialerCompatible`	boolean	-default true
`retailCompatible`	boolean	-default true
`otpCompatible`	boolean	-default true
`openRtp`	boolean	-default false
`visibility`	string	-default "public"One of `public`, `private`
`jingleEnabled`	boolean	-default false
`jingleApiUrl`	string (uri) \| null	-
`smsDeliveryUrl`	string (uri) \| null	-
`smsDeliveryMethod`	string	-One of `http`, `smpp`
`smppHost`	string \| null	-
`smppPort`	integer \| null	-1 to 65535
`smppSystemId`	string \| null	-
`smppPassword`	string \| null	-max 64 chars
`smppBindType`	string \| null	-One of `transceiver`, `transmitter`
`smppSystemType`	string \| null	-max 13 chars
`smppTps`	integer \| null	-1 to 1000
`smppSourceTon`	integer \| null	-0 to 6
`smppSourceNpi`	integer \| null	-0 to 18
`smppDestTon`	integer \| null	-0 to 6
`smppDestNpi`	integer \| null	-0 to 18
`jingleSipIp`	string \| null	-
`sipPort`	integer \| null	-1 to 65535
`sipAuthUsername`	string \| null	-max 128 chars
`sipAuthPassword`	string \| null	-max 128 chars
`techPrefix`	string \| null	-
`numberFormat`	object \| null	-
`mode`numberFormat.mode	string	-One of `custom`
`nationalPrefix`numberFormat.nationalPrefix	string	-
`strip`numberFormat.strip	integer	-0 to 10
`add`numberFormat.add	string	-
`t38Support`	boolean	-default false
`supportedCodecs`	string[]	-
`maxCallDuration`	integer	-min 0
`smsType`	string	-One of `a2p`, `p2p`, `both`
`smsDlrSupport`	boolean	-
`smsConcatSupport`	boolean	-
`smsSenderIdType`	string	-One of `alphanumeric`, `numeric`, `preregistered`
`smsContentRestrictions`	string	-
`smsRouteQuality`	string \| null	-One of `hq`, `direct`, `aggregator`, `sim`
`smsSenderIdBehavior`	string \| null	-One of `alphanumeric_preserved`, `numeric_long`, `overwritten`, `not_guaranteed`
`smsDlrLevel`	string \| null	-One of `real_operator`, `intermediate`, `submit_only`, `none`
`smsDlrPercent`	string \| null	-
`smsUnicodeSupport`	boolean \| null	-
`smsAcceptedTraffic`	string[] \| null	-One of `wholesale`, `transactional`, `otp`, `marketing`, `promo_shortcode`
`timeOfDayPricing`	object	-
`notes`	string	-max 2000 chars
`status`	string	-One of `active`, `paused`

Response 200

Field	Type	Description
`data`required	object	A route you listed, as only you (the seller) see it. Passwords are never returned.Same fields as OwnRoute, 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/routes/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "voice",
  "country": "United Kingdom"
}'

Run it here with a test key.

Delete a route you listed

DELETE/api/v1/routes/{id}

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

Restorable for restoreWindowDays via POST /routes/{id}/restore.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`message`requireddata.message	string	-
`restorable`requireddata.restorable	boolean	-One of `true`
`restoreWindowDays`requireddata.restoreWindowDays	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.

Draft a listing from a rate sheet

POST/api/v1/routes/autopilot/draft

Access: API key. Scoped keys need routes:write.
Rate limit: 10 requests per minute

Upload a CSV or Excel sheet (multipart field file, optional note). Returns a proposed listing and the questions a sheet cannot answer. Writes nothing.

Request body (multipart/form-data)

Field	Type	Description
`file`required	string	CSV or Excel rate sheet (binary)
`note`	string	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	A proposed listing form plus open questions

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/routes/autopilot/draft" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -F "file=@rates.csv" \
  -F "note=..."

Run it here with a test key.

Test an endpoint before listing a route

POST/api/v1/routes/probe-endpoint

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

Sends a real SIP probe (voice), SMPP bind (SMS over SMPP) or URL check (SMS over HTTP) to the details you enter. Nothing is stored.

Request body (application/json)

Field	Type	Description
`type`required	string	-One of `voice`, `sms`
`jingleSipIp`	string \| null	-max 255 chars
`sipPort`	integer \| null	-1 to 65535
`techPrefix`	string \| null	-max 24 chars
`smsDeliveryUrl`	string \| null	-max 2048 chars
`smsDeliveryMethod`	string \| null	-One of `http`, `smpp`
`smppHost`	string \| null	-max 255 chars
`smppPort`	integer \| null	-1 to 65535
`smppSystemId`	string \| null	Short account code your SMS supplier issued (max 16 chars). An email address is rejected.max 16 chars
`smppPassword`	string \| null	Used for one bind attempt, never storedmax 64 chars
`smppBindType`	string \| null	-One of `transceiver`, `transmitter`
`smppSystemType`	string \| null	-max 13 chars

Response 200

Field	Type	Description
`data`required	object	-
`pass`requireddata.pass	boolean	True when the endpoint answered from every one of our media addresses
`barred`data.barred	boolean	Reachable but refusing our calls
`degraded`data.degraded	boolean	Refusing some of our source addresses
`checks`requireddata.checks	object[]	-
`label`requireddata.checks[].label	string	-
`value`requireddata.checks[].value	string	-
`ok`requireddata.checks[].ok	boolean	-
`egressAddresses`requireddata.egressAddresses	string	The addresses our traffic comes from; whitelist these
`gatewayIp`requireddata.gatewayIp	string	Deprecated alias of egressAddresses
`diagnostics`data.diagnostics	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.
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/routes/probe-endpoint" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "voice"
}'

Run it here with a test key.

List your call-centre routes and their call screening

GET/api/v1/routes/callguard

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

Response 200

Field	Type	Description
`data`required	object[]	-
`routeId`requireddata[].routeId	string (uuid)	-
`name`requireddata[].name	string	-
`country`requireddata[].country	string	-
`enabled`requireddata[].enabled	boolean	-
`consentAt`requireddata[].consentAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`status`requireddata[].status	string	-One of `active`, `paused`, `suspended`, `pending_review`

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 call screening settings, stats and flagged calls

GET/api/v1/routes/{id}/screening

Access: API key. Scoped keys need routes:read.
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	Screening config, statistics and the flagged calls

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.

Turn call screening on or off for a route

PATCH/api/v1/routes/{id}/screening

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

Only for call-centre voice routes. Turning it on records your recording consent.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`enabled`required	boolean	-

Response 200

Field	Type	Description
`data`required	object	-

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/routes/<id>/screening" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'

Run it here with a test key.

Classify a sample transcript with call screening

POST/api/v1/routes/{id}/screening/test

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

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`transcript`required	string	-max 20000 chars

Response 200

Field	Type	Description
`data`required	object	The classification the transcript would receive

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/routes/<id>/screening/test" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "transcript": "<transcript>"
}'

Run it here with a test key.

List your saved listing presets

GET/api/v1/routes/listing-presets

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

Response 200

Field	Type	Description
`data`required	object	-
`presets`requireddata.presets	object[]	-
`name`requireddata.presets[].name	string	-
`values`requireddata.presets[].values	object	-

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.

Save a listing preset

PUT/api/v1/routes/listing-presets

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

Upserts by name; keeps your 12 most recent presets.

Request body (application/json)

Field	Type	Description
`name`required	string	-max 60 chars
`values`required	object	-

Response 200

Field	Type	Description
`data`required	object	-
`presets`requireddata.presets	object[]	-
`name`requireddata.presets[].name	string	-
`values`requireddata.presets[].values	object	-

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 PUT "https://packetexchange.io/api/v1/routes/listing-presets" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "values": {}
}'

Run it here with a test key.

Delete a listing preset

DELETE/api/v1/routes/listing-presets/{name}

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

Parameters

Name	In	Type	Description
`name`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`presets`requireddata.presets	object[]	-
`name`requireddata.presets[].name	string	-
`values`requireddata.presets[].values	object	-

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 the listings publishing a deck will create

GET/api/v1/routes/{id}/split-preview

Access: API key. Scoped keys need routes:read.
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	Per-country listings that publishing would produce

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 recently deleted routes

GET/api/v1/routes/deleted

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

Response 200

Field	Type	Description
`data`required	object	-
`routes`requireddata.routes	object[]	-
`id`data.routes[].id	string (uuid)	-
`kind`data.routes[].kind	string	-One of `single`, `blend`
`type`data.routes[].type	string	-One of `voice`, `sms`
`country`data.routes[].country	string	-
`countryCode`data.routes[].countryCode	string	E.164 country calling code, digits only
`prefix`data.routes[].prefix	string[]	Dial prefixes the route covers
`destinationName`data.routes[].destinationName	string	The listing name. For anyone but the seller it is GENERATED by the platform from its own data, never the seller's text: "<Country> <Operator?> <Mobile\|Fixed\|All Networks>" for one destination (e.g. "Niger Mobile", "Kenya Safaricom Mobile"), "A-Z Voice · <tier> · <CLI> · Ref XXXX" or "A-Z SMS · <quality> · Ref XXXX" for an A-Z bundle. The seller sees the name they gave it.
`cliType`data.routes[].cliType	string	-One of `full_cli`, `ncli`, `partial_cli`, `local_cli`, `mixed_cli`
`routeType`data.routes[].routeType	string	Quality tierOne of `direct`, `premium`, `standard`, `ncli`
`pricePerUnit`data.routes[].pricePerUnit	money	USD per minute (voice) or per message segment (SMS). On an A-Z deck (rateCount > 0) the per-destination rates apply instead. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`data.routes[].billingIncrement	string \| null	First/subsequent increment in seconds, e.g. "60/60"
`capacity`data.routes[].capacity	integer	Channels (voice) or messages per second (SMS)
`expectedAsr`data.routes[].expectedAsr	string \| null	Seller-stated ASR %. The measured figure is in `measured.asr`
`expectedAcd`data.routes[].expectedAcd	string \| null	Seller-stated ACD in seconds
`expectedPdd`data.routes[].expectedPdd	string \| null	Seller-stated PDD in seconds
`minAcd`data.routes[].minAcd	integer \| null	-
`minAsr`data.routes[].minAsr	string \| null	Decimal as a string, e.g. "92.50"
`visibility`data.routes[].visibility	string	-One of `public`, `private`
`status`data.routes[].status	string	-One of `active`, `paused`, `suspended`, `pending_review`
`wholesaleCompatible`data.routes[].wholesaleCompatible	boolean	-
`callcenterCompatible`data.routes[].callcenterCompatible	boolean	-
`dialerCompatible`data.routes[].dialerCompatible	boolean	-
`retailCompatible`data.routes[].retailCompatible	boolean	-
`otpCompatible`data.routes[].otpCompatible	boolean	-
`notes`data.routes[].notes	string \| null	-
`smsType`data.routes[].smsType	string \| null	-One of `a2p`, `p2p`, `both`
`exchangeScore`data.routes[].exchangeScore	integer \| null	Exchange Score 1-100, null until the route has carried real traffic. Uses the measured ASR, NER, ACD and PDD in place of the stated ones when the listing has recent measured figures
`lastQcAt`data.routes[].lastQcAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`measured`data.routes[].measured	object \| null	Measured quality from real calls; null until the listing has enough traffic from enough buyersSame fields as MeasuredRouteQuality, shown earlier on this page.
`routeChecks`data.routes[].routeChecks	object \| null	Route checks on this listing in the last 7 days. Null when there were none.Same fields as RouteCheckRecord, shown earlier on this page.
`createdAt`data.routes[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`data.routes[].updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`sellerId`data.routes[].sellerId	string (uuid)	Your own account id
`isOwner`data.routes[].isOwner	boolean	-One of `true`
`parentRouteId`data.routes[].parentRouteId	string (uuid) \| null	-
`isBundle`data.routes[].isBundle	boolean	-
`jingleSipIp`data.routes[].jingleSipIp	string \| null	Your SIP endpoint
`sipPort`data.routes[].sipPort	integer \| null	-
`techPrefix`data.routes[].techPrefix	string \| null	-
`sipAuthUsername`data.routes[].sipAuthUsername	string \| null	-
`sipAuthPasswordSet`data.routes[].sipAuthPasswordSet	boolean	A SIP digest password is stored (never returned)
`smsDeliveryMethod`data.routes[].smsDeliveryMethod	string \| null	-One of `http`, `smpp`
`smsDeliveryUrl`data.routes[].smsDeliveryUrl	string \| null	-
`smppHost`data.routes[].smppHost	string \| null	-
`smppPort`data.routes[].smppPort	integer \| null	-
`smppSystemId`data.routes[].smppSystemId	string \| null	-
`smppPasswordSet`data.routes[].smppPasswordSet	boolean	An SMPP password is stored (never returned)
`endpointReachable`data.routes[].endpointReachable	boolean \| null	-
`endpointCheckedAt`data.routes[].endpointCheckedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`sellerProfile`data.routes[].sellerProfile	object \| null	Trust signals only. The marketplace never names the seller behind a listing.Same fields as MarketplaceSellerProfile, shown earlier on this page.
`rateCount`data.routes[].rateCount	integer	-
`restoreWindowDays`requireddata.restoreWindowDays	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.

Restore a deleted route

POST/api/v1/routes/{id}/restore

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

The route comes back paused and private; publish it again when ready.

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.

List your saved SIP endpoints

GET/api/v1/routes/my-endpoints

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

Response 200

Field	Type	Description
`data`required	object[]	-
`id`data[].id	string (uuid) \| null	-
`ip`requireddata[].ip	string	-
`label`data[].label	string \| null	-
`routeCount`data[].routeCount	integer	How many of your routes use this IP
`usedBy`data[].usedBy	string \| null	Name of the newest route using this IP

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.

Save a SIP endpoint

POST/api/v1/routes/my-endpoints

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

Request body (application/json)

Field	Type	Description
`ip`required	string	-
`label`	string \| null	-max 60 chars

Response 200

Field	Type	Description
`data`required	object	-
`id`data.id	string (uuid) \| null	-
`ip`requireddata.ip	string	-
`label`data.label	string \| null	-
`routeCount`data.routeCount	integer	How many of your routes use this IP
`usedBy`data.usedBy	string \| null	Name of the newest route using this IP

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/routes/my-endpoints" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ip": "203.0.113.10"
}'

Run it here with a test key.

Label a saved SIP endpoint

PATCH/api/v1/routes/my-endpoints/{id}

Access: API key. Scoped keys need routes:write.
Rate limit: 60 requests per minute

Sets the label shown next to the IP in "My IPs" and in the SIP endpoint pickers, so a seller with several switches can tell them apart. The label is trimmed, control and bidirectional-override characters are removed, and it is cut to 60 characters; an empty string or null clears it. Only saved endpoints (those with an id in GET /routes/my-endpoints) can be labelled; an unknown id, or someone else's, answers 404.

Parameters

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

Request body (application/json)

Field	Type	Description
`label`required	string \| null	The new label; "" or null clears itmax 60 chars

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`ip`requireddata.ip	string	-
`label`requireddata.label	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.
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/routes/my-endpoints/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Acme"
}'

Run it here with a test key.

Remove a saved SIP endpoint

DELETE/api/v1/routes/my-endpoints/{id}

Access: API key. Scoped keys need routes:write.
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	-

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 which route would carry a destination

GET/api/v1/routes/resolve

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

Resolves as your account (including private routes you bought). price is a 6-decimal USD string.

Parameters

Name	In	Type	Description
`to`required	query	string	Destination number or prefix
`type`	query	string	-One of voice, smsDefault "voice"
`strategy`	query	string	-One of cheapest, best_quality, balancedDefault "balanced"

Response 200

Field	Type	Description
`data`required	object	-
`strategy`requireddata.strategy	string	-One of `cheapest`, `best_quality`, `balanced`
`selected`requireddata.selected	object \| null	-
`id`requireddata.selected.id	string (uuid)	-
`destinationName`requireddata.selected.destinationName	string	The listing name as a buyer reads it: generated by the platform, never the seller's text, and ending in the listing reference (e.g. "Niger Mobile · Ref 7K2Q", "A-Z Voice · Premium · Full CLI · Ref 3MX9"). Your own listings keep the name you gave them.
`country`requireddata.selected.country	string	-
`countryCode`requireddata.selected.countryCode	string	-
`type`requireddata.selected.type	string	-One of `voice`, `sms`
`cliType`requireddata.selected.cliType	string \| null	-
`price`requireddata.selected.price	money	Rate for this destination: USD per minute or message, 6-decimal string USD as a decimal string with exactly 6 places, e.g. "0.012500".
`asr`requireddata.selected.asr	number \| null	-
`acd`requireddata.selected.acd	number \| null	-
`matchedPrefix`requireddata.selected.matchedPrefix	string \| null	-
`alternatives`requireddata.alternatives	object[]	Same fields as ResolvedRoute, shown earlier on this page.
`count`requireddata.count	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.

Test connectivity to your route endpoint

POST/api/v1/routes/{id}/test

Access: API key. Scoped keys need routes:write.
Rate limit: 100 requests per second (the default)
Real traffic: Places a real test call over the route.

Sends a real SIP probe to the route endpoint from every one of our media addresses.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	Same fields as ConnectivityTestResult, 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.

Capture a SIP trace of a test call on a route

POST/api/v1/routes/{id}/sip-trace

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 10 requests per minute
Real traffic: Places a real test call over the route.

For the seller or an active buyer. Optionally dials a real number. Buyers receive the trace with seller addresses masked.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`number`	string	-

Response 200

Field	Type	Description
`data`required	object	The SIP ladder: messages, timings and the final response

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/routes/<id>/sip-trace" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "+447700900123"
}'

Run it here with a test key.

Get a route's price history

GET/api/v1/routes/{id}/price-history

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

For the seller and buyers of the route. Newest first.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`routeId`requireddata[].routeId	string (uuid)	-
`oldPrice`requireddata[].oldPrice	money \| null	US dollars as a decimal string with exactly 6 decimal places, e.g. "0.012500". Do money arithmetic with a decimal type, not floating point. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`newPrice`requireddata[].newPrice	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`changedAt`requireddata[].changedAt	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.

Get traffic and revenue stats for your route

GET/api/v1/routes/{id}/stats

Access: API key. Scoped keys need routes:read.
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	-
`activePurchases`requireddata.activePurchases	integer	-
`volume`requireddata.volume	object	Keyed 24h, 7d, 30d. revenue is USD (display figure, 2 decimals)
`measuredAsr`requireddata.measuredAsr	number \| null	-
`measuredAcd`requireddata.measuredAcd	number \| null	-
`recentOffers`requireddata.recentOffers	object[]	-
`id`requireddata.recentOffers[].id	string (uuid)	-
`proposedPrice`requireddata.recentOffers[].proposedPrice	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`agreedPrice`requireddata.recentOffers[].agreedPrice	money \| null	US dollars as a decimal string with exactly 6 decimal places, e.g. "0.012500". Do money arithmetic with a decimal type, not floating point. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`status`requireddata.recentOffers[].status	string	-
`lastActor`requireddata.recentOffers[].lastActor	string	-
`createdAt`requireddata.recentOffers[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.recentOffers[].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.
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 the routes you sell

GET/api/v1/routes/my/list

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

Two modes. Cursor mode (only cursor, limit, includeChildren): newest first, A-Z deck children hidden unless includeChildren=true. Paged mode (any of offset, search, type, status, visibility, live, hiddenReason, scope, endpoint, deck, sort, dir): up to 200 rows a page, with total, and each row carries origin (its endpoint, your label for it, and the deck and rate sheet it came from). scope=listings lists every row a buyer could see as a listing (single routes and deck children); hiddenReason lists exactly the routes counted under that reason by GET /routes/my/listing-health. search matches the route name, country, endpoint IP or host, your IP label, the deck name and a route id prefix; a number such as +44 is a dial code (country code or coverage prefix). endpoint and deck take a group key from GET /routes/my/groups.

Parameters

Name	In	Type	Description
`cursor`	query	string (uuid)	-
`limit`	query	integer	Cursor mode: default 25, max 100. Paged mode: default 50, max 200.
`includeChildren`	query	string	Include the per-country children of A-Z decksOne of true, false, 1, 0
`search`	query	string	-
`type`	query	string	-One of voice, sms
`status`	query	string	-One of active, paused, pending_review, suspended
`visibility`	query	string	-One of public, private
`live`	query	boolean \| string	-
`hiddenReason`	query	string	-One of sms_no_delivery, voice_no_endpoint
`scope`	query	string	-One of listings, decks
`endpoint`	query	string	-
`deck`	query	string (uuid) \| string	-
`offset`	query	integer	-
`sort`	query	string	-One of created, name, country, type, price, status
`dir`	query	string	-One of asc, desc

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`kind`requireddata[].kind	string	-One of `single`, `blend`
`type`requireddata[].type	string	-One of `voice`, `sms`
`country`requireddata[].country	string	-
`countryCode`requireddata[].countryCode	string	E.164 country calling code, digits only
`prefix`requireddata[].prefix	string[]	Dial prefixes the route covers
`destinationName`requireddata[].destinationName	string	The listing name. For anyone but the seller it is GENERATED by the platform from its own data, never the seller's text: "<Country> <Operator?> <Mobile\|Fixed\|All Networks>" for one destination (e.g. "Niger Mobile", "Kenya Safaricom Mobile"), "A-Z Voice · <tier> · <CLI> · Ref XXXX" or "A-Z SMS · <quality> · Ref XXXX" for an A-Z bundle. The seller sees the name they gave it.
`cliType`requireddata[].cliType	string	-One of `full_cli`, `ncli`, `partial_cli`, `local_cli`, `mixed_cli`
`routeType`requireddata[].routeType	string	Quality tierOne of `direct`, `premium`, `standard`, `ncli`
`pricePerUnit`requireddata[].pricePerUnit	money	USD per minute (voice) or per message segment (SMS). On an A-Z deck (rateCount > 0) the per-destination rates apply instead. USD as a decimal string with exactly 6 places, e.g. "0.012500".
`billingIncrement`requireddata[].billingIncrement	string \| null	First/subsequent increment in seconds, e.g. "60/60"
`capacity`requireddata[].capacity	integer	Channels (voice) or messages per second (SMS)
`expectedAsr`requireddata[].expectedAsr	string \| null	Seller-stated ASR %. The measured figure is in `measured.asr`
`expectedAcd`requireddata[].expectedAcd	string \| null	Seller-stated ACD in seconds
`expectedPdd`requireddata[].expectedPdd	string \| null	Seller-stated PDD in seconds
`minAcd`requireddata[].minAcd	integer \| null	-
`minAsr`requireddata[].minAsr	string \| null	Decimal as a string, e.g. "92.50"
`visibility`requireddata[].visibility	string	-One of `public`, `private`
`status`requireddata[].status	string	-One of `active`, `paused`, `suspended`, `pending_review`
`wholesaleCompatible`requireddata[].wholesaleCompatible	boolean	-
`callcenterCompatible`requireddata[].callcenterCompatible	boolean	-
`dialerCompatible`requireddata[].dialerCompatible	boolean	-
`retailCompatible`requireddata[].retailCompatible	boolean	-
`otpCompatible`requireddata[].otpCompatible	boolean	-
`notes`requireddata[].notes	string \| null	-
`smsType`data[].smsType	string \| null	-One of `a2p`, `p2p`, `both`
`exchangeScore`requireddata[].exchangeScore	integer \| null	Exchange Score 1-100, null until the route has carried real traffic. Uses the measured ASR, NER, ACD and PDD in place of the stated ones when the listing has recent measured figures
`lastQcAt`requireddata[].lastQcAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`measured`data[].measured	object \| null	Measured quality from real calls; null until the listing has enough traffic from enough buyersSame fields as MeasuredRouteQuality, shown earlier on this page.
`routeChecks`data[].routeChecks	object \| null	Route checks on this listing in the last 7 days. Null when there were none.Same fields as RouteCheckRecord, shown earlier on this page.
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata[].updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`sellerId`requireddata[].sellerId	string (uuid)	Your own account id
`isOwner`data[].isOwner	boolean	-One of `true`
`parentRouteId`requireddata[].parentRouteId	string (uuid) \| null	-
`isBundle`requireddata[].isBundle	boolean	-
`jingleSipIp`requireddata[].jingleSipIp	string \| null	Your SIP endpoint
`sipPort`requireddata[].sipPort	integer \| null	-
`techPrefix`requireddata[].techPrefix	string \| null	-
`sipAuthUsername`requireddata[].sipAuthUsername	string \| null	-
`sipAuthPasswordSet`requireddata[].sipAuthPasswordSet	boolean	A SIP digest password is stored (never returned)
`smsDeliveryMethod`data[].smsDeliveryMethod	string \| null	-One of `http`, `smpp`
`smsDeliveryUrl`requireddata[].smsDeliveryUrl	string \| null	-
`smppHost`requireddata[].smppHost	string \| null	-
`smppPort`requireddata[].smppPort	integer \| null	-
`smppSystemId`requireddata[].smppSystemId	string \| null	-
`smppPasswordSet`requireddata[].smppPasswordSet	boolean	An SMPP password is stored (never returned)
`endpointReachable`requireddata[].endpointReachable	boolean \| null	-
`endpointCheckedAt`requireddata[].endpointCheckedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`sellerProfile`data[].sellerProfile	object \| null	Trust signals only. The marketplace never names the seller behind a listing.Same fields as MarketplaceSellerProfile, shown earlier on this page.
`rateCount`data[].rateCount	integer	-
`revenue30d`requireddata[].revenue30d	number	USD seller credit over 30 days (display figure, 2 decimals)
`liveChannels`requireddata[].liveChannels	integer	-
`childCount`requireddata[].childCount	integer	Per-country child listings created from this deck
`origin`data[].origin	object	Paged mode only: where the route terminates and where it came from
`endpointKey`requireddata[].origin.endpointKey	string	The endpoint group key: the host, "~none" (no endpoint) or "~blend". Pass it as ?endpoint= to list every route on it
`kind`requireddata[].origin.kind	string	sip = voice SIP endpoint, smpp = SMSC bind, http = delivery URL, blend = terminates via its members, none = no endpoint yetOne of `sip`, `smpp`, `http`, `blend`, `none`
`host`requireddata[].origin.host	string \| null	The SIP IP, the SMSC host, or the delivery URL's host
`port`requireddata[].origin.port	integer \| null	SIP port (default 5060) or SMPP port (default 2775)
`systemId`requireddata[].origin.systemId	string \| null	SMPP only: the System ID bound with
`label`requireddata[].origin.label	string \| null	Your own label for this IP (see GET /routes/my-endpoints), voice only
`deckId`requireddata[].origin.deckId	string (uuid) \| null	The A-Z deck this route was split out of, when it was
`deckName`requireddata[].origin.deckName	string \| null	-
`sheetName`requireddata[].origin.sheetName	string \| null	File name of the latest applied rate sheet behind the deck (or behind the route itself)
`nextCursor`required	string \| null	Cursor mode only; always null in paged mode
`hasMore`required	boolean	-
`total`	integer	Paged mode only: rows matching the filters across all pages
`offset`	integer	Paged mode only
`limit`	integer	Paged mode only (max 200)

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.

Count your SMS routes hidden for lack of an endpoint

GET/api/v1/routes/sms-endpoint-gap

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

Response 200

Field	Type	Description
`data`required	object	-
`count`requireddata.count	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.

Set one delivery endpoint on all your endpoint-less SMS routes

POST/api/v1/routes/sms-endpoint/bulk

Access: API key. Scoped keys need routes:write.
Rate limit: 6 requests per minute

An SMPP method runs a real bind first; if it fails nothing changes and error.details carries the reason and the addresses to whitelist.

Request body (application/json)

Field	Type	Description
`method`required	string	-One of `http`, `smpp`
`smsDeliveryUrl`	string	-
`smppHost`	string	-
`smppPort`	integer	-
`smppSystemId`	string	-
`smppPassword`	string	-
`smppBindType`	string	-One of `transceiver`, `transmitter`
`smppSystemType`	string	-
`routeIds`	string (uuid)[]	Narrow to these routes; never widens the set

Response 200

Field	Type	Description
`data`required	object	-
`updated`requireddata.updated	integer	-
`method`requireddata.method	string	-One of `http`, `smpp`
`bind`data.bind	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.
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/routes/sms-endpoint/bulk" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "http"
}'

Run it here with a test key.

Count your listed routes that are live, and why the rest are hidden

GET/api/v1/routes/my/listing-health

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

Answers "why does my route count differ from the marketplace?". listed counts your active, public routes (A-Z deck parents excluded); live counts the ones buyers can see, using the marketplace's own filters, so the two numbers cannot disagree with the board. Each reason carries a count, a label and the fix. The routes behind sms_no_delivery and voice_no_endpoint can be listed with GET /routes/my/list?hiddenReason=<key> and fixed in one call with POST /routes/my/bulk-sms-delivery or /routes/my/bulk-sip-endpoint.

Response 200

Field	Type	Description
`data`required	object	-
`listed`requireddata.listed	integer	Your routes that are active, public and not an A-Z deck parent: what you have put on sale
`live`requireddata.live	integer	How many of those buyers can actually see on the marketplace (counted with the marketplace's own filters)
`hidden`requireddata.hidden	integer	listed - live
`reasons`requireddata.reasons	object[]	Why the hidden routes are hidden, in the order to fix them. Only reasons with a non-zero count are present.
`key`requireddata.reasons[].key	string	sms_no_delivery and voice_no_endpoint can be listed with GET /routes/my/list?hiddenReason=<key> and fixed in bulk; restricted = a destination the exchange does not carryOne of `sms_no_delivery`, `voice_no_endpoint`, `restricted`
`count`requireddata.reasons[].count	integer	-
`label`requireddata.reasons[].label	string	The reason in plain words
`fix`requireddata.reasons[].fix	string	What to do about it

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.

Set one SMS delivery method on many of your SMS routes

POST/api/v1/routes/my/bulk-sms-delivery

Access: API key. Scoped keys need routes:write.
Rate limit: 10 requests per minute

Applies one delivery method (SMPP or HTTP) to a selection of your SMS routes: an explicit routeIds list, or every route matching filter (at most 5,000). Only your own live routes are touched; each route that is not eligible is returned in skipped with a reason. Send dryRun: true first to see how many would change: nothing is probed or written. On a real run the endpoint is checked ONCE for the whole batch: SMPP gets a real bind (no message is sent) and HTTP gets a URL check. If the bind is refused NO route is changed and the call answers 400 VALIDATION_ERROR with error.details = { kind: "smpp_bind_failed", host, port, systemId, bindType, reason, whitelistIps, failoverIps }: whitelistIps is the one SMS source address your SMSC must allow (every bind and message leaves from it); failoverIps are used only while that address is down, so allowing them is optional. A field that fails validation answers 400 with one { path, message } per field. All routes change in one transaction.

Request body (application/json)

Field	Type	Description
`routeIds`	string (uuid)[]	An explicit selection of your route ids (max 5000). Send this OR filter, not both.
`filter`	object	"Every route matching this filter", re-derived on the server with the same rules as GET /routes/my/list (scope defaults to listings). Refused when it matches more than 5,000 routes.
`search`filter.search	string	-max 100 chars
`type`filter.type	string	-One of `voice`, `sms`
`status`filter.status	string	-One of `active`, `paused`, `pending_review`, `suspended`
`visibility`filter.visibility	string	-One of `public`, `private`
`live`filter.live	boolean \| string	-
`hiddenReason`filter.hiddenReason	string	-One of `sms_no_delivery`, `voice_no_endpoint`
`scope`filter.scope	string	-One of `listings`, `decks`
`endpoint`filter.endpoint	string	-max 255 chars
`deck`filter.deck	string (uuid) \| string	-
`dryRun`	boolean	Count and classify only: nothing is probed or written, and the answer carries wouldUpdate
`delivery`required	object	The SMS delivery method to set, validated exactly as PUT /routes/{id} validates it. It must be complete: smsDeliveryMethod "smpp" needs smppHost and smppSystemId; "http" needs smsDeliveryUrl. A blank smppPassword keeps each route's stored one; null clears it.
`smsDeliveryMethod`delivery.smsDeliveryMethod	string	-One of `http`, `smpp`
`smsDeliveryUrl`delivery.smsDeliveryUrl	string (uri) \| null	-
`smppHost`delivery.smppHost	string \| null	-
`smppPort`delivery.smppPort	integer \| null	-1 to 65535
`smppSystemId`delivery.smppSystemId	string \| null	-
`smppPassword`delivery.smppPassword	string \| null	-max 64 chars
`smppBindType`delivery.smppBindType	string \| null	-One of `transceiver`, `transmitter`
`smppSystemType`delivery.smppSystemType	string \| null	-max 13 chars

Response 200

Field	Type	Description
`data`required	object	-
`updated`requireddata.updated	integer	Routes changed. Always 0 on a dry run.
`wouldUpdate`data.wouldUpdate	integer	Dry run (or nothing eligible): how many routes the call would change
`skipped`requireddata.skipped	object[]	Routes left untouched, each with the reason
`id`requireddata.skipped[].id	string (uuid)	-
`reason`requireddata.skipped[].reason	string	not_found: not one of your live routes. not_sms / not_voice: wrong route type for this action. deck_parent: set it on the deck's own Edit page. blend: a blend has no endpoint of its own. duplicate_listing (SIP only): another of your routes already lists this country and prefixes on that IP and tech prefix.One of `not_found`, `not_sms`, `not_voice`, `deck_parent`, `blend`, `duplicate_listing`
`check`data.check	object	The one endpoint check run for the whole batch (an SMPP bind, a URL check or a SIP probe). pass is false only when confirmUnreachable applied a SIP endpoint anyway.
`pass`requireddata.check.pass	boolean	-
`message`requireddata.check.message	string	-
`dryRun`data.dryRun	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/routes/my/bulk-sms-delivery" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "delivery": {
    "smsDeliveryMethod": "http",
    "smsDeliveryUrl": "https://example.com/webhooks/packetexchange"
  }
}'

Run it here with a test key.

Set one SIP endpoint on many of your voice routes

POST/api/v1/routes/my/bulk-sip-endpoint

Access: API key. Scoped keys need routes:write.
Rate limit: 10 requests per minute

Applies one SIP endpoint (IP or host, port, technical prefix and optional digest credentials) to a selection of your voice routes: an explicit routeIds list, or every route matching filter (at most 5,000). Only your own live routes are touched; routes that are not eligible, or that would duplicate another of your listings on the same IP and tech prefix (same country and prefixes), are returned in skipped. Send dryRun: true first to see how many would change. An invalid, private or reserved address, or one of our own addresses, is refused outright (400, on jingleSipIp). Otherwise one SIP probe is sent to the endpoint; if it gets no answer the call answers 400 VALIDATION_ERROR with error.details = { kind: "sip_probe_failed", message, checks } and nothing changes. Repeat with confirmUnreachable: true to apply anyway (a single-route edit never probes, so bulk is never stricter). The IP is also added to your saved endpoints. All routes change in one transaction.

Request body (application/json)

Field	Type	Description
`routeIds`	string (uuid)[]	An explicit selection of your route ids (max 5000). Send this OR filter, not both.
`filter`	object	"Every route matching this filter", re-derived on the server with the same rules as GET /routes/my/list (scope defaults to listings). Refused when it matches more than 5,000 routes.
`search`filter.search	string	-max 100 chars
`type`filter.type	string	-One of `voice`, `sms`
`status`filter.status	string	-One of `active`, `paused`, `pending_review`, `suspended`
`visibility`filter.visibility	string	-One of `public`, `private`
`live`filter.live	boolean \| string	-
`hiddenReason`filter.hiddenReason	string	-One of `sms_no_delivery`, `voice_no_endpoint`
`scope`filter.scope	string	-One of `listings`, `decks`
`endpoint`filter.endpoint	string	-max 255 chars
`deck`filter.deck	string (uuid) \| string	-
`dryRun`	boolean	Count and classify only: nothing is probed or written, and the answer carries wouldUpdate
`delivery`required	object	The SIP endpoint to set, validated exactly as PUT /routes/{id} validates it. jingleSipIp is required. A blank sipAuthPassword keeps each route's stored one; null clears it.
`jingleSipIp`delivery.jingleSipIp	string \| null	-
`sipPort`delivery.sipPort	integer \| null	-1 to 65535
`techPrefix`delivery.techPrefix	string \| null	-
`sipAuthUsername`delivery.sipAuthUsername	string \| null	-max 128 chars
`sipAuthPassword`delivery.sipAuthPassword	string \| null	-max 128 chars
`confirmUnreachable`	boolean	Apply even though the SIP probe got no answer (the first attempt is refused with the probe's diagnosis in error.details)

Response 200

Field	Type	Description
`data`required	object	Same fields as BulkEndpointResult, 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/routes/my/bulk-sip-endpoint" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "delivery": {
    "jingleSipIp": "<jingleSipIp>",
    "sipPort": 1
  }
}'

Run it here with a test key.

Group the routes you sell by endpoint or by A-Z deck

GET/api/v1/routes/my/groups

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

Your routes matching the same filters as GET /routes/my/list (paged mode), grouped by by=endpoint (the SIP IP, SMSC host or delivery URL host, with your label for the IP) or by=deck (the A-Z deck a route was split out of, with the rate sheet behind it). Each group has total, live and hidden counts. List a group's routes with GET /routes/my/list?endpoint=<key> or ?deck=<key>; the bulk actions accept the same keys in filter. Only your own routes are counted.

Parameters

Name	In	Type	Description
`search`	query	string	-
`type`	query	string	-One of voice, sms
`status`	query	string	-One of active, paused, pending_review, suspended
`visibility`	query	string	-One of public, private
`live`	query	boolean \| string	-
`hiddenReason`	query	string	-One of sms_no_delivery, voice_no_endpoint
`scope`	query	string	-One of listings, decks
`endpoint`	query	string	-
`deck`	query	string (uuid) \| string	-
`by`required	query	string	-One of endpoint, deck

Response 200

Field	Type	Description
`data`required	object	-
`by`requireddata.by	string	-One of `endpoint`, `deck`
`groups`requireddata.groups	object[]	Largest group first, at most 500
`key`requireddata.groups[].key	string	Pass back as ?endpoint= (by=endpoint) or ?deck= (by=deck) on GET /routes/my/list to page this group's routes. Sentinels: "~none", "~blend", "~single"
`kind`requireddata.groups[].kind	string	by=endpoint: how routes on this host are handed over (mixed when a host serves more than one kind). by=deck: deck, or single for routes listed on their ownOne of `sip`, `smpp`, `http`, `mixed`, `blend`, `none`, `deck`, `single`
`host`requireddata.groups[].host	string \| null	-
`label`requireddata.groups[].label	string \| null	Your label for this IP
`port`requireddata.groups[].port	integer \| null	The port when every route in the group uses the same one
`systemId`requireddata.groups[].systemId	string \| null	SMPP: the System ID when every route in the group uses the same one
`deckId`requireddata.groups[].deckId	string (uuid) \| null	-
`deckName`requireddata.groups[].deckName	string \| null	-
`sheetName`requireddata.groups[].sheetName	string \| null	File name of the deck's latest applied rate sheet
`total`requireddata.groups[].total	integer	-
`live`requireddata.groups[].live	integer	Visible to buyers, by the marketplace's own filters
`hidden`requireddata.groups[].hidden	integer	total - live
`total`requireddata.total	integer	Routes across the returned groups
`truncated`requireddata.truncated	boolean	More than 500 groups matched; narrow the filter

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.

Check whether your switches are refusing our calls

GET/api/v1/routes/my/endpoint-status

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

One entry per SIP endpoint (IP or host) used by your active voice routes. refusing is true when we have evidence your switch is turning our calls away: calls we sent it in the last 6 hours answered with SIP 401, 403 or 407 (at least 3 of them, and at least half of the calls that got an answer), or our own test call to it was barred or refused from some of our addresses (partial, with the refused addresses in refusedIps when known). evidence is that finding in one sentence, routeId is a route on the endpoint you can test from, and since is when the current incident was first seen. allow lists the addresses to allow on your switch: every one of egressIps, for SIP on sipPort (UDP and TCP) and RTP media on the UDP rtpPortRange, the same values GET /sip/network-info publishes. Only your own endpoints and your own calls are counted.

Response 200

Field	Type	Description
`data`required	object	-
`endpoints`requireddata.endpoints	object[]	-
`endpointKey`requireddata.endpoints[].endpointKey	string	-
`host`requireddata.endpoints[].host	string	-
`endpoint`requireddata.endpoints[].endpoint	string	-
`kind`requireddata.endpoints[].kind	string	-One of `voice`
`routeCount`requireddata.endpoints[].routeCount	integer	-
`routeId`requireddata.endpoints[].routeId	string (uuid)	-
`refusing`requireddata.endpoints[].refusing	boolean	-
`partial`requireddata.endpoints[].partial	boolean	-
`refusedIps`requireddata.endpoints[].refusedIps	string[]	-
`evidence`requireddata.endpoints[].evidence	string \| null	-
`source`requireddata.endpoints[].source	string \| null	-One of `traffic`, `probe`
`since`requireddata.endpoints[].since	string (date-time) \| null	ISO-8601 timestamp (UTC)
`allow`requireddata.allow	object	-
`egressIps`requireddata.allow.egressIps	string[]	-
`sipPort`requireddata.allow.sipPort	integer	-
`rtpPortRange`requireddata.allow.rtpPortRange	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.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List the buyers of your route

GET/api/v1/routes/{id}/buyers

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

Owner only: anyone other than the route's seller gets 403 FORBIDDEN. One row per buyer, identified only by a pseudonym scoped to this route (the same "Buyer #3F2A" that appears on offers for the route), so it cannot be matched to an account or across your other routes. No account id, name, company, email, IP or dialled number is returned. Figures cover the last 30 days; for an A-Z deck they include its per-country listings. status is the buyer's current relationship (ended = cancelled; ended buyers with no traffic in the window are left out). asr30d and calls30d are voice only, counted per call attempt group, and null until a call has been measured. Sorted by revenue.

Parameters

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

Response 200

Field	Type	Description
`data`required	object	-
`windowDays`requireddata.windowDays	integer	-
`unit`requireddata.unit	string	-One of `minutes`, `messages`
`buyers`requireddata.buyers	object[]	-
`buyer`requireddata.buyers[].buyer	string	Pseudonym, stable per route
`status`requireddata.buyers[].status	string	-One of `active`, `paused`, `pending_review`, `ended`
`volume30d`requireddata.buyers[].volume30d	number	-
`revenue30d`requireddata.buyers[].revenue30d	number	USD (display figure, 2 decimals)
`asr30d`requireddata.buyers[].asr30d	number \| null	-
`calls30d`requireddata.buyers[].calls30d	integer \| 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.

Show the billing increments your rate sheet sets

GET/api/v1/routes/{id}/rate-increments

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

Owner only: anyone other than the route's seller gets 403 FORBIDDEN. Groups the route's active rate rows by billing increment (e.g. 1/1 on some destinations, 60/60 on others). Rows with a null increment inherit fallback, the route-level increment.

Parameters

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

Response 200

Field	Type	Description
`data`required	object	-
`mix`requireddata.mix	object[]	-
`increment`requireddata.mix[].increment	string \| null	e.g. "60/60"; null = the row uses the route fallback
`destinations`requireddata.mix[].destinations	integer	Active rate rows with this increment
`fallback`requireddata.fallback	string \| null	The route-level billing increment

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.

Read a rate sheet into a draft listing (no account needed)

POST/api/v1/public/listings/parse

Access: Public. No key needed.
Rate limit: 6 requests per minute

Multipart upload (field file, optional note). Returns the proposed listing and parsed rates; stores nothing.

Request body (multipart/form-data)

Field	Type	Description
`file`required	string	CSV or Excel rate sheet (binary)
`note`	string	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	Proposed listing, parsed rates and `truncated`

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
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.

Save a draft listing to claim after sign-up

POST/api/v1/public/listings

Access: Public. No key needed.
Rate limit: 10 requests per 10 minutes

Returns a token; the listing is created only when a signed-in account claims it.

Request body (application/json)

Field	Type	Description
`payload`	any	-
`rates`	object[]	-
`destinationName`rates[].destinationName	string	-
`operator`rates[].operator	string \| null	-
`prefix`requiredrates[].prefix	string	-
`ratePerUnit`requiredrates[].ratePerUnit	string	-
`billingIncrement`rates[].billingIncrement	string \| null	-
`minDuration`rates[].minDuration	number \| null	-
`sourceFilename`	string	-max 512 chars
`contactEmail`	string (email)	-max 255 chars
`contactCompany`	string	-max 255 chars

Response 200

Field	Type	Description
`data`required	object	-
`token`requireddata.token	string	-
`expiresAt`requireddata.expiresAt	string (date-time)	ISO-8601 timestamp (UTC)
`rateCount`requireddata.rateCount	integer	-
`destinationName`requireddata.destinationName	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
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/public/listings" \
  -H "Content-Type: application/json" \
  -d '{
  "payload": "<payload>",
  "rates": [
    {
      "prefix": "44",
      "ratePerUnit": "<ratePerUnit>"
    }
  ]
}'

Run it here, no key needed.

Look at a saved draft listing

GET/api/v1/public/listings/{token}

Access: Public. No key needed.
Rate limit: 30 requests per minute

Parameters

Name	In	Type	Description
`token`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`alreadyClaimed`requireddata.alreadyClaimed	boolean	-
`routeId`data.routeId	string (uuid) \| null	-
`destinationName`data.destinationName	string	-
`type`data.type	string	-One of `voice`, `sms`
`country`data.country	string	-
`rateCount`data.rateCount	integer	-
`sourceFilename`data.sourceFilename	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
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.

Create a route from a saved draft listing

POST/api/v1/listings/{token}/claim

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

Idempotent per token: claiming twice returns the route already created.

Parameters

Name	In	Type	Description
`token`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`routeId`requireddata.routeId	string (uuid) \| null	-
`rateCount`requireddata.rateCount	integer	-
`alreadyClaimed`requireddata.alreadyClaimed	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.
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.