api:number:prereserve
Table of Contents
API : Number Pre Reserve
Introduction
This request will mark a number or the series it belongs to as pre-reserved.
This is used by resellers to reserve numbers for a potential customer. A pre-reservation will last for 14 days before it is terminated and the numbers are available to everyone again.
This request can also release a pre-reserved number if it should not be reserved anymore.
Request
| URL | https://api.telecomx.dk/number/NUMBER_ID/preReserve | |
|---|---|---|
| Method | GET | |
| Access level | ADMIN. | |
| Param | NUMBER_ID | The number (E.164 format) to pre-reserve |
| Query | release | True if the number(s) should not be reserved anymore |
Query example
GET https://api.telecomx.dk/number/+4570305050/preReserve GET https://api.telecomx.dk/number/+4570305050/preReserve?release=true
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Number not found in request URI |
| 409 | id | Number(s) are not available for pre reservation |
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Number not found |
api/number/prereserve.txt · Last modified: 2014/06/17 14:44 by Per Møller