import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.portingOrders.retrieveRequirements('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(response.data);{
"data": [
{
"field_type": "document",
"field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
"requirement_type": {
"acceptance_criteria": {
"acceptable_values": []
},
"description": "A copy of the latest phone bill from the current provider",
"example": "Most recent phone bill",
"id": "53970723-fbff-4f46-a975-f62be6c1a585",
"name": "Latest Invoice",
"type": "document"
},
"requirement_status": "approved",
"record_type": "porting_requirement"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Returns a list of all requirements based on country/number type for this porting order.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.portingOrders.retrieveRequirements('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(response.data);{
"data": [
{
"field_type": "document",
"field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
"requirement_type": {
"acceptance_criteria": {
"acceptable_values": []
},
"description": "A copy of the latest phone bill from the current provider",
"example": "Most recent phone bill",
"id": "53970723-fbff-4f46-a975-f62be6c1a585",
"name": "Latest Invoice",
"type": "document"
},
"requirement_status": "approved",
"record_type": "porting_requirement"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Porting Order id
Successful response
Show child attributes
Type of value expected on field_value field
document, textual "document"
Identifies the document that satisfies this requirement
"9787fb5f-cbe5-4de4-b765-3303774ee9fe"
Identifies the requirement type that meets this requirement
Show child attributes
The acceptance criteria for the requirement type
{ "acceptable_values": [] }A description of the requirement type
"A copy of the latest phone bill from the current provider"
An example of the requirement type
"Most recent phone bill"
Identifies the requirement type
"53970723-fbff-4f46-a975-f62be6c1a585"
The name of the requirement type
"Latest Invoice"
The type of the requirement type
"document"
Status of the requirement
"approved"
Identifies the type of the resource.
"porting_requirement"
Was this page helpful?