Get the status of a phone number provisioning request

What it does

Returns the details of the provisioning request for the provided requestId.

Endpoint

GET

/byon/provisioning/v1/{requestId}

Request Querystring Parameters

Attributes

Description

requestId
required (path)

A unique identifier based on the requestId (string) field.

Curl

curl -X GET "https://api.tyntec.com/byon/provisioning/v1/26c99e4d97b44c9aa50bf7fb29801ebe" -H  "accept: application/json" -H  "apiKey: ds9SomeApiKeyl337"


Responses

Code

Details

200

The provisioning request
Example Value
{
  "accountId": "string",
  "contactId": "string",
  "friendlyName": "string",
  "requestId": "string",
  "status": "string",
  "dateProvisioningRequest": 0,
  "dateProvisioningUpdated": 0,
  "dateProvisioningCompleted": 0,
  "loaId": "string",
  "loaStatus": "string"
}

Example

{
  "accountId": "CPaasAccountName",
  "contactId": "26c99e4d97b44c9aa50bf7fb29801ebe",
  "requestId": "2cfa638e3d9c4da399c4fa70a3698717",
  "friendlyName": "myFrienldyName",
  "status": "LOA_READY",
  "dateProvisioningRequest": 1521205266416,
  "dateProvisioningUpdated": 1521455979757,
  "dateProvisioningCompleted": 0,
  "loaId": "313e1006-703a-4720-bf01-1d2b6305f45a",
  "loaStatus": "Completed"
}

400

Your request was not valid

401

Unauthorized

403

Forbidden

404

Contact not found

500

Something went wrong :-(Example Value{  "code": "string",  "message": "string",  "timestamp": 0}