API reference

Connections

Your SIP and SMPP connections to the exchange.

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

BrowseConnections

Look up the account behind a connect code

GET/api/v1/connections/lookup

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

Parameters

Name	In	Type	Description
`token`required	query	string	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`contactName`requireddata.contactName	string \| null	-
`companyName`requireddata.companyName	string \| null	-
`jobTitle`data.jobTitle	string \| null	-
`avatarUrl`data.avatarUrl	string \| null	-
`logoUrl`data.logoUrl	string \| null	-
`country`requireddata.country	string \| null	-
`verified`requireddata.verified	boolean	-
`memberSince`data.memberSince	string (date-time)	ISO-8601 timestamp (UTC)

Errors

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

Get your connect code

GET/api/v1/connections/code

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

Created on first read. Share it (or its QR) so another account can connect with you.

Response 200

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

Rotate your connect code

POST/api/v1/connections/code/rotate

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

The old code stops working. Existing connections are kept.

Response 200

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

Connect with another account by its code

POST/api/v1/connections/connect

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

Both sides can then see each other's public routes; the owner is notified.

Request body (application/json)

Field	Type	Description
`token`required	string	-max 64 chars

Response 200

Field	Type	Description
`data`required	object	-
`connectionId`requireddata.connectionId	string (uuid)	-
`counterparty`requireddata.counterparty	object	Same fields as ConnectionProfile, 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/connections/connect" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "<token>"
}'

Run it here with a test key.

List your connections

GET/api/v1/connections

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

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`counterparty`requireddata[].counterparty	object	Same fields as ConnectionProfile, shown earlier on this page.
`visibleRouteCount`requireddata[].visibleRouteCount	integer	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

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

Get a connection with the routes each side can see

GET/api/v1/connections/{id}

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

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`connectionId`requireddata.connectionId	string (uuid)	-
`counterparty`requireddata.counterparty	object	Same fields as ConnectionProfile, shown earlier on this page.
`theirRoutes`requireddata.theirRoutes	object[]	-
`id`requireddata.theirRoutes[].id	string (uuid)	-
`type`requireddata.theirRoutes[].type	string	-One of `voice`, `sms`
`country`requireddata.theirRoutes[].country	string \| null	-
`countryCode`requireddata.theirRoutes[].countryCode	string \| null	-
`prefix`requireddata.theirRoutes[].prefix	string[]	-
`destinationName`requireddata.theirRoutes[].destinationName	string \| null	-
`pricePerUnit`requireddata.theirRoutes[].pricePerUnit	money	Your negotiated price when the route was shared privately, else the list price USD as a decimal string with exactly 6 places, e.g. "0.012500".
`customPrice`requireddata.theirRoutes[].customPrice	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".
`cliType`requireddata.theirRoutes[].cliType	string \| null	-
`capacity`requireddata.theirRoutes[].capacity	integer \| null	-
`billingIncrement`requireddata.theirRoutes[].billingIncrement	string \| null	-
`expectedAsr`requireddata.theirRoutes[].expectedAsr	string \| null	-
`expectedAcd`requireddata.theirRoutes[].expectedAcd	string \| null	-
`routeType`requireddata.theirRoutes[].routeType	string \| null	-
`visibility`requireddata.theirRoutes[].visibility	string	-
`jingleSipIp`requireddata.theirRoutes[].jingleSipIp	enum \| null	-One of `null`
`supportedCodecs`requireddata.theirRoutes[].supportedCodecs	string[] \| null	-
`myRoutes`requireddata.myRoutes	object[]	-
`id`requireddata.myRoutes[].id	string (uuid)	-
`type`requireddata.myRoutes[].type	string	-One of `voice`, `sms`
`country`requireddata.myRoutes[].country	string \| null	-
`countryCode`requireddata.myRoutes[].countryCode	string \| null	-
`prefix`requireddata.myRoutes[].prefix	string[]	-
`destinationName`requireddata.myRoutes[].destinationName	string \| null	-
`pricePerUnit`requireddata.myRoutes[].pricePerUnit	money	Your negotiated price when the route was shared privately, else the list price USD as a decimal string with exactly 6 places, e.g. "0.012500".
`customPrice`requireddata.myRoutes[].customPrice	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".
`cliType`requireddata.myRoutes[].cliType	string \| null	-
`capacity`requireddata.myRoutes[].capacity	integer \| null	-
`billingIncrement`requireddata.myRoutes[].billingIncrement	string \| null	-
`expectedAsr`requireddata.myRoutes[].expectedAsr	string \| null	-
`expectedAcd`requireddata.myRoutes[].expectedAcd	string \| null	-
`routeType`requireddata.myRoutes[].routeType	string \| null	-
`visibility`requireddata.myRoutes[].visibility	string	-
`jingleSipIp`requireddata.myRoutes[].jingleSipIp	enum \| null	-One of `null`
`supportedCodecs`requireddata.myRoutes[].supportedCodecs	string[] \| null	-
`mySharesPrivate`requireddata.mySharesPrivate	boolean	-
`theySharePrivate`requireddata.theySharePrivate	boolean	-
`interconnect`requireddata.interconnect	object	-
`whitelistedIps`requireddata.interconnect.whitelistedIps	integer	-
`activePurchases`requireddata.interconnect.activePurchases	integer	-

Errors

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

Remove a connection

DELETE/api/v1/connections/{id}

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

Private route access granted through the connection is revoked on both sides.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`ok`requireddata.ok	boolean	-One of `true`

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.

Share or stop sharing your private routes with a connection

POST/api/v1/connections/{id}/share-private

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

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`enabled`required	boolean	-

Response 200

Field	Type	Description
`data`required	object	-
`ok`requireddata.ok	boolean	-One of `true`
`sharing`requireddata.sharing	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.

HTTP

curl -X POST "https://packetexchange.io/api/v1/connections/<id>/share-private" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'

Run it here with a test key.