TEtelgea
User Plans

Restore a customer's number

Undoes a suspension made with POST /v1/user-plans/{userId}/suspension, and returns once the line is live again at the network.

Restoring a number that is not suspended returns 409.

delete/v1/user-plans/{userId}/suspension

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Path parameters

userIdstring uuid required

UUID of the user whose plan this is.

Example:9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01

Query parameters

numberIdstring uuid required

UUID of the number to restore.

Example:8238c1b9-c2c0-4455-9b03-4bd787052709

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Response

Number restored. Lists the number the restore reached.

numbersstring[] required

The phone numbers the request actually reached at the network.

Example response

{
  "numbers": [
    "+4520123456"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.