API reference

Route blends

Blended routes that spread traffic across several member routes.

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

Preview a blended route

POST/api/v1/routes/blends/preview

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

Request body (application/json)

Field	Type	Description
`members`required	object[]	-
`memberRouteId`members[].memberRouteId	string (uuid) \| null	-
`memberVendorTrunkId`members[].memberVendorTrunkId	string (uuid) \| null	-
`rate`requiredmembers[].rate	number	-min 0
`weightPct`requiredmembers[].weightPct	number	-0 to 100
`routeType`members[].routeType	string	-One of `direct`, `premium`, `standard`, `ncli`
`capacity`members[].capacity	integer	-min 0
`maxCps`members[].maxCps	integer	-min 0
`priority`members[].priority	integer	-1 to 20
`enabled`members[].enabled	boolean	-
`type`	string	-One of `voice`, `sms`
`countryCode`	string	-
`numberType`	string	-One of `mobile`, `fixed`, `both`

Response 200

Field	Type	Description
`data`required	object	-
`blendedRate`requireddata.blendedRate	number	Weighted rate (display figure)
`capacity`requireddata.capacity	number	-
`memberCount`requireddata.memberCount	integer	-
`members`requireddata.members	object[]	-
`coverage`requireddata.coverage	object \| null	-
`coverageSummary`requireddata.coverageSummary	string \| null	-

Errors

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

HTTP

curl -X POST "https://packetexchange.io/api/v1/routes/blends/preview" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "members": [
    {
      "rate": 1,
      "weightPct": 1
    }
  ]
}'

Run it here with a test key.

Propose the cheapest complete blend for a destination

POST/api/v1/routes/blends/propose

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

Request body (application/json)

Field	Type	Description
`type`	string	-default "voice"One of `voice`, `sms`
`countryCode`required	string	-
`numberType`	string	-default "both"One of `mobile`, `fixed`, `both`

Response 200

Field	Type	Description
`data`required	object	Proposed members, their coverage and a coverage summary

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/blends/propose" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "countryCode": "GB"
}'

Run it here with a test key.

List your blended routes

GET/api/v1/routes/blends

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[]	-

Errors

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

Create a blended route

POST/api/v1/routes/blends

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

Refused when no member is enabled, or when the blend cannot carry the destination it claims unless acknowledgeIncomplete is set.

Request body (application/json)

Field	Type	Description
`name`required	string	-max 255 chars
`type`required	string	-One of `voice`, `sms`
`country`required	string	-max 100 chars
`countryCode`required	string	-
`prefix`	string[]	-
`destinationName`	string	-max 255 chars
`cliType`	string	-One of `full_cli`, `ncli`, `local_cli`, `mixed_cli`
`billingIncrement`	string	-
`visibility`	string	-One of `public`, `private`
`dialerCompatible`	boolean	-
`members`required	object[]	-
`memberRouteId`members[].memberRouteId	string (uuid) \| null	-
`memberVendorTrunkId`members[].memberVendorTrunkId	string (uuid) \| null	-
`rate`requiredmembers[].rate	number	-min 0
`weightPct`requiredmembers[].weightPct	number	-0 to 100
`routeType`members[].routeType	string	-One of `direct`, `premium`, `standard`, `ncli`
`capacity`members[].capacity	integer	-min 0
`maxCps`members[].maxCps	integer	-min 0
`priority`members[].priority	integer	-1 to 20
`enabled`members[].enabled	boolean	-
`numberType`	string	-One of `mobile`, `fixed`, `both`
`acknowledgeIncomplete`	boolean	-

Response 201

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.
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/blends" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "type": "voice",
  "country": "United Kingdom",
  "countryCode": "GB",
  "members": [
    {
      "rate": 1,
      "weightPct": 1
    }
  ]
}'

Run it here with a test key.

Get a blended route

GET/api/v1/routes/blends/{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	-
`id`requireddata.id	string (uuid)	-
`name`requireddata.name	string	-
`type`requireddata.type	string	-One of `voice`, `sms`
`country`requireddata.country	string	-
`countryCode`requireddata.countryCode	string	-
`visibility`requireddata.visibility	string	-One of `public`, `private`
`status`requireddata.status	string	-One of `active`, `paused`, `suspended`, `pending_review`
`numberType`requireddata.numberType	string \| null	-
`coverage`requireddata.coverage	object \| null	-
`coverageSummary`requireddata.coverageSummary	string \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

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

Update a blended route

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

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

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`name`	string	-max 255 chars
`visibility`	string	-One of `public`, `private`
`dialerCompatible`	boolean	-
`members`	object[]	-
`memberRouteId`members[].memberRouteId	string (uuid) \| null	-
`memberVendorTrunkId`members[].memberVendorTrunkId	string (uuid) \| null	-
`rate`requiredmembers[].rate	number	-min 0
`weightPct`requiredmembers[].weightPct	number	-0 to 100
`routeType`members[].routeType	string	-One of `direct`, `premium`, `standard`, `ncli`
`capacity`members[].capacity	integer	-min 0
`maxCps`members[].maxCps	integer	-min 0
`priority`members[].priority	integer	-1 to 20
`enabled`members[].enabled	boolean	-
`numberType`	string	-One of `mobile`, `fixed`, `both`
`acknowledgeIncomplete`	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/blends/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "visibility": "public"
}'

Run it here with a test key.

Archive a blended route

DELETE/api/v1/routes/blends/{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	-
`archived`requireddata.archived	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.