ResumeSubscription

Overview

• Method: POST
• Endpoint: /api/ResumeSubscription
• Description: Resumes a previously suspended SIM card and phone number, restoring all traffic.

POST /api/ResumeSubscription
Content-Type: application/json
{
  "subscriptionId": "###3Vp17###7Xg79e",
  "referenceNumber": "Simcard back"
}

---

Request Body Parameters

The request body should be a JSON object with the following structure:

• subscriptionId (string, required if phoneNumber is not provided): Identifier for the subscription to resume.
• phoneNumber (string, required if subscriptionId is not provided): Phone number of the subscription to resume.
• referenceNumber (string, optional, max 15 characters): Reference number for tracking the resume request.

Info

At least one of the fields subscriptionId or phoneNumber must be provided to identify the subscription to be resumed.

---

Response Structure

The response returns an Activation object containing the details of the resume request:

{
    "id": "###aX5l4###DzNkS0",
    "createdAt": "2025-01-31T17:28:21.1378004+01:00",
    "modifiedAt": "2025-01-31T17:28:21.1378004+01:00",
    "status": "INIT",
    "activationType": "RESUME",
    "providerEnvironment": "SP16001",
    "referenceNumber": "Simcard back",
    "subscriptionId": "###3Vp17###7Xg79e",
    "phoneNumber": "06-######969",
    "info": {}
}

Field Descriptions

• id: A unique identifier for the resume request.
• createdAt: The timestamp when the resume request was created.
• modifiedAt: The timestamp of the last modification to the request.
• status: The current status of the resume request:
  • BUSY: The request is being processed.
  • DONE: The resume has been successfully completed.
  • ERROR: The resume request has failed.
• activationType: The type of activation (RESUME for this request).
• providerEnvironment: The Envirionment where the sim is registered at the provider.
• subscriptionId: The ID of the resumed subscription.
• phoneNumber: The phone number of the resumed subscription.
• referenceNumber: The reference number provided for tracking.
• info: Additional metadata related to the resume request.

Info

Only optional fields included in the request will appear in the response.

---

Usage Notes

• This endpoint is used to resume all traffic for a previously suspended SIM card and phone number.
• You must provide either subscriptionId or phoneNumber to identify the subscription to resume.
• The referenceNumber can be used for internal tracking.
• The response includes a unique id for tracking the resume request.
• Check the info field for additional details or error messages.

---

Querying Resume Status

To track the status of the resume request, use the QueryActivation API until the status field is set to DONE or ERROR.

GET /api/QueryActivation?Id=###aX5l4###DzNkS0

Example Response:

{
    "offset": 0,
    "total": 71,
    "results": [
        {
            "id": "###aX5l4###DzNkS0",
            "createdAt": "2025-01-31T17:28:21.137+01:00",
            "modifiedAt": "2025-01-31T17:31:32.69+01:00",
            "status": "DONE",
            "activationType": "RESUME",
            "providerEnvironment": "SP16001",
            "referenceNumber": "Simcard back",
            "providerOrderNumber": "03####0/2##5",
            "subscriptionId": "###3Vp17###7Xg79e",
            "phoneNumber": "06-######969",
            "activatedDate": "2025-01-31T18:28:44+01:00",
            "info": {}
        }
    ],
    "meta": {}
}

---

Summary

The /api/ResumeSubscription endpoint allows you to resume a previously suspended subscription, restoring all services for the SIM card and phone number.

• Requires either a subscriptionId or phoneNumber to identify the subscription.
• Returns a unique id for tracking.
• The resume status can be queried using QueryActivation.

Use this API to efficiently manage resumption of service for subscriptions.