TSG Global API Documentation
  • Get Started
  • ISO/IEC/SOC Certification
  • Staging Environment Access
  • API Reference
    • Programmable SMS
      • Send an SMS Message
      • Receive an SMS Message
      • Delivery Receipts (DLRs)
      • SMPP
        • Headers
        • Errors
    • Programmable MMS
      • Send an MMS Message
      • Receive an MMS Message
      • Receive DLRs
      • SMTP
    • Phone Numbers
      • Search For New Available Numbers
      • Add Number to Cart
      • Get Reserved Numbers In Cart
      • Remove Reserved Number From Cart
      • Checkout Numbers in Cart
      • Disconnect Number
      • Get Number Information
      • Manage Number for SMS & 10DLC
        • Enable SMS/10DLC on a Number
        • Disable SMS on a Number
        • Update inbound SMS webhook/URI
      • Manage Number for MMS
        • Enable MMS on a Number
        • Disable MMS on a Number
        • Update inbound MMS webhook/URI
      • Manage Number for Voice
        • List Destination Priority
        • Add Destination Priority
        • Update Destination Priority
        • Delete Destination Priority
      • Protect your phone number
        • TextProtect Webhook
      • Toll-free phone numbers - search & ordering
    • Data Services
      • CNAM Lookup
      • Lookup SMS Carrier
    • Reports
      • CDR Records
        • Get Count of CDR Records
        • Get CDR Records
    • Compliance & Identity
      • Business Identity & 10DLC (TNID v1)
      • Toll-Free Verified Sender (Order)
      • Short Code Submission (Order)
  • GraphQL API & Authentication
Powered by GitBook
On this page
  • Overview
  • Authentication
  • Example Mutation
  • Example Response

Was this helpful?

  1. API Reference
  2. Phone Numbers

Disconnect Number

Overview

Disconnect a number currently assigned to your account.

Authentication

This function is available via our new GraphQL API. You can read more about how to authenticate to this API here.

Per your MSA, there is a 90 day number holding requirement. You can not specify a disconnect date, and the number will be disconnected at the earliest possible time (immediately if outside of the 90 day window).

Example Mutation

# if a number is 12345600000
mutation {
  disconnectNumbers(numbers: ["12345600000"]) {
    internalId
    orderId
    orderName
    requests {
      disconnectAt
      numbers
      requestId
      requestName
      requestNotes
    }
  }
}

Example Response

This is an example of a response - this one will disconnect right away (a disconnectAt timestamp is provided to provide some info for the user):

{
  "data": {
    "disconnectNumbers": {
      "internalId": "999000053-ORD",
      "orderId": "a0d0512f-7b61-4517-9e23-fd708344d52e",
      "orderName": "Disconnect order",
      "requests": [
        {
          "disconnectAt": "2021-09-21T13:52:36.664129Z",
          "numbers": [
            "15013929384"
          ],
          "requestId": "2551e1c6-b99b-469a-b4b0-10439685f536",
          "requestName": "Disconnect request",
          "requestNotes": "Disconnect request will be executed right away"
        }
      ]
    }
  }
}

Another response example - this one has a delayed disconnect request:

{
  "data": {
    "disconnectNumbers": {
      "internalId": "999000030-ORD",
      "orderId": "bf8a1a4d-9d4c-48e6-9feb-720bb3fc529e",
      "orderName": "Disconnect order",
      "requests": [
        {
          "disconnectAt": "2021-09-15T23:49:59.000000Z",
          "numbers": [
            "15013929405"
          ],
          "requestId": "f9cd9320-a32f-43d6-bcf3-90652446e3a5",
          "requestName": "Delayed disconnect request",
          "requestNotes": "Disconnect request delayed due to too recent activation date (90 day disconnect rule)"
        }
      ]
    }
  }
}

PreviousCheckout Numbers in CartNextGet Number Information

Last updated 8 months ago

Was this helpful?