Telephony

Start a number compliance or porting case

Starts a project-scoped workflow for a new number or port-in request in the US, Canada, India, the UK, or Australia. The applicable requirements and execution budgets are frozen at creation. Missing market rules fail closed. Requires telephony:manage and an Idempotency-Key.

post/v1/telephony/compliance-cases

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/telephony/compliance-cases
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Headers

Idempotency-Keystring required

Request body

kind'new_number' | 'port_in' required
country'US' | 'CA' | 'IN' | 'GB' | 'AU' required
number_typestring required

Requested market number type, such as local, mobile, or toll_free.

capabilitiesstring[] required
use_casestring required

Customer-declared use case used to select requirements.

Example request

{
  "capabilities": [
    "voice",
    "sms"
  ]
}

Response

Case created or idempotently replayed

idstring required
object'telephony.compliance_case' required
project_idstring required
kind'new_number' | 'port_in' required
country'US' | 'CA' | 'IN' | 'GB' | 'AU' required
number_typestring
capabilitiesstring[]
use_casestring
network_statusstring
state'collecting_evidence' | 'extracting' | 'needs_review' | 'ready_for_submission' | 'submitted' | 'cancelled' required
continuation_reasonstring nullable
terminal_reason'network_review_submitted' | 'cancelled_by_customer' | 'null' nullable
correctionsobject[]

Correction audit metadata. Corrected PII values are intentionally omitted from API views.

matchesobject[]
attestationsobject[]
timelineobject[] required
created_atinteger
updated_atinteger
retention_delete_atinteger
versioninteger required

Example response

{
  "id": "ncc_..."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.