API reference

Route reports

Report a problem with a route you bought.

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

BrowseRoute reports

List route problem reports you raised or received

GET/api/v1/route-reports

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
`role`	query	string	-One of buyer, seller
`status`	query	string	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`routeId`requireddata[].routeId	string (uuid)	-
`routeName`requireddata[].routeName	string \| null	-
`role`requireddata[].role	string	-One of `buyer`, `seller`
`buyerId`requireddata[].buyerId	string (uuid) \| null	Null for the seller, who sees only the pseudonym
`buyerLabel`requireddata[].buyerLabel	string	-
`category`requireddata[].category	string	-One of `call_failure`, `connectivity`, `quality`, `other`
`subject`requireddata[].subject	string \| null	-
`status`requireddata[].status	string	-One of `open`, `acknowledged`, `resolved`, `confirmed`, `reopened`, `escalated`, `closed`
`evidence`data[].evidence	any	Call evidence; seller addresses are masked for the buyer
`verifyResult`data[].verifyResult	any	-
`escalated`requireddata[].escalated	boolean	-
`unread`requireddata[].unread	boolean	-
`lastActivityAt`requireddata[].lastActivityAt	string (date-time)	ISO-8601 timestamp (UTC)
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`resolvedAt`requireddata[].resolvedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`closedAt`requireddata[].closedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)

Errors

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

Report a problem with a route you bought

POST/api/v1/route-reports

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

Optionally attach a CDR and a fresh SIP trace. The seller sees you under a pseudonym.

Request body (application/json)

Field	Type	Description
`routeId`required	string (uuid)	-
`cdrId`	string (uuid)	-
`category`	string	-One of `call_failure`, `connectivity`, `quality`, `other`
`subject`	string	-max 200 chars
`message`required	string	-max 4000 chars
`attachSipTrace`	boolean	-

Response 201

Field	Type	Description
`data`required	object	Same fields as RouteReport, 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/route-reports" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "routeId": "<routeId>",
  "message": "Hello from Acme"
}'

Run it here with a test key.

Count route reports waiting on you

GET/api/v1/route-reports/action-counts

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	-
`seller`requireddata.seller	integer	-
`buyer`requireddata.buyer	integer	-
`total`requireddata.total	integer	-

Errors

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

Get a route report with its thread

GET/api/v1/route-reports/{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)	-
`routeId`requireddata.routeId	string (uuid)	-
`routeName`requireddata.routeName	string \| null	-
`role`requireddata.role	string	-One of `buyer`, `seller`
`buyerId`requireddata.buyerId	string (uuid) \| null	Null for the seller, who sees only the pseudonym
`buyerLabel`requireddata.buyerLabel	string	-
`category`requireddata.category	string	-One of `call_failure`, `connectivity`, `quality`, `other`
`subject`requireddata.subject	string \| null	-
`status`requireddata.status	string	-One of `open`, `acknowledged`, `resolved`, `confirmed`, `reopened`, `escalated`, `closed`
`evidence`data.evidence	any	Call evidence; seller addresses are masked for the buyer
`verifyResult`data.verifyResult	any	-
`escalated`requireddata.escalated	boolean	-
`unread`requireddata.unread	boolean	-
`lastActivityAt`requireddata.lastActivityAt	string (date-time)	ISO-8601 timestamp (UTC)
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`resolvedAt`requireddata.resolvedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`closedAt`requireddata.closedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`messages`requireddata.messages	object[]	-
`id`requireddata.messages[].id	string (uuid)	-
`role`requireddata.messages[].role	string	-One of `buyer`, `seller`, `system`, `staff`
`kind`requireddata.messages[].kind	string	-One of `message`, `status_change`, `verification`
`authorLabel`requireddata.messages[].authorLabel	string	-
`mine`requireddata.messages[].mine	boolean	-
`body`requireddata.messages[].body	string	-
`meta`data.messages[].meta	any	-
`createdAt`requireddata.messages[].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.

Reply on a route report

POST/api/v1/route-reports/{id}/messages

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
`body`required	string	-max 4000 chars

Response 201

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

Errors

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

HTTP

curl -X POST "https://packetexchange.io/api/v1/route-reports/<id>/messages" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Hello from Acme"
}'

Run it here with a test key.

Acknowledge a route report (seller)

POST/api/v1/route-reports/{id}/acknowledge

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

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

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

Mark a route report resolved (seller)

POST/api/v1/route-reports/{id}/resolve

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
`note`	string	-max 4000 chars

Response 200

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

Errors

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

HTTP

curl -X POST "https://packetexchange.io/api/v1/route-reports/<id>/resolve" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Example"
}'

Run it here with a test key.

Confirm a route report is fixed (buyer)

POST/api/v1/route-reports/{id}/confirm

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

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

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

Reopen a resolved route report (buyer)

POST/api/v1/route-reports/{id}/reopen

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
`note`	string	-max 4000 chars

Response 200

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

Errors

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

HTTP

curl -X POST "https://packetexchange.io/api/v1/route-reports/<id>/reopen" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Example"
}'

Run it here with a test key.

Escalate a route report to support

POST/api/v1/route-reports/{id}/escalate

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
`note`	string	-max 4000 chars

Response 200

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

Errors

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

HTTP

curl -X POST "https://packetexchange.io/api/v1/route-reports/<id>/escalate" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Example"
}'

Run it here with a test key.