Create a DID order for an available DID or an existing reservation.

POST

https://api.veloconnect.me/api/did/purchase

Telephony

Last modified:2026-06-01 19:28:25

Example request using an available DID:

POST /api/did/purchase
{
"tenantId": 42,
"externalDidId": "available_did_123456",
"numberE164": "+12015550123",
"skuId": "sku_123456",
"allowBackOrdering": false
}

Example request using a reservation:

POST /api/did/purchase
{
"tenantId": 42,
"didReservationId": "reservation_123456",
"numberE164": "+12015550123",
"skuId": "sku_123456",
"allowBackOrdering": false
}

Authentication: Requires JWT bearer token.

Request body: DidPurchaseRequestDto

Success response (200): SuccessResponseModelOfDidPurchaseResultDto

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

cURLHttpiewget

curl --location 'https://api.veloconnect.me/api/did/purchase' \
--header 'Content-Type: application/json' \
--data '{
    "tenantId": 0,
    "externalDidId": "string",
    "numberE164": "string",
    "skuId": "sku_123456",
    "didReservationId": "reservation_123456",
    "allowBackOrdering": true,
    "qty": 1,
    "nanpaPrefixId": "string",
    "amount": 0,
    "currency": "string"
}'

Response Example

200 - Success Example

{
    "data": [
        {
            "succeeded": true,
            "status": "string",
            "message": "string",
            "purchaseOrderId": 0
        }
    ]
}

Modified at 2026-06-01 19:28:25

Provision DID into SIP

List DID assignments owned by the caller's scope, optionally filtered by tenant or assigned user.