Get Long Code Number Details

Get the details of a specific Long code nnumber that you own.

Get Workspace Long Code Number

GET/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}

Path parameters

workspaceId*string

longCodeNumberId*string

Response

200404

OK

Body

application/json

id*string (uuid)

endpointId*string (uuid)

numberString*string

countryCode*string (iso3166-1)

typeNumbers_LongCodeNumberType (enum)

localnationaltoll-freemobile

capabilities*Numbers_PhoneNumberCapabilities (object)

Capabilities of the phone number

createdAt*string (date-time)

updatedAt*string (date-time)

orderNumbers_LongCodeNumberOrder (object)

deprovisionAtstring (date-time)

endpoint*Numbers_EndpointFragment (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "endpointId": "123e4567-e89b-12d3-a456-426614174000",
  "numberString": "text",
  "countryCode": "text",
  "type": "local",
  "capabilities": {
    "voice": {
      "inbound": false,
      "outbound": false
    },
    "sms": {
      "inbound": false,
      "outbound": false
    },
    "mms": {
      "inbound": false,
      "outbound": false
    }
  },
  "createdAt": "2024-11-21T09:02:28.620Z",
  "updatedAt": "2024-11-21T09:02:28.620Z",
  "order": {
    "countryCode": "text",
    "type": "local",
    "capabilities": [
      "voice"
    ],
    "prefix": "text",
    "status": "draft",
    "createdAt": "2024-11-21T09:02:28.620Z",
    "updatedAt": "2024-11-21T09:02:28.620Z"
  },
  "deprovisionAt": "2024-11-21T09:02:28.620Z",
  "endpoint": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "long-code-number",
    "instanceId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "capabilities": [
      {
        "name": "sms",
        "inbound": {
          "status": "active",
          "issues": [
            "subscription-is-not-active"
          ]
        },
        "outbound": {
          "status": "active",
          "destinationStatuses": {
            "active": 0,
            "inactive": 0,
            "available": 0,
            "unavailable": 0
          },
          "supportsDestinations": false,
          "issues": [
            "subscription-is-not-active"
          ]
        }
      }
    ],
    "dependencies": [
      {
        "type": "connector",
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text",
        "capabilities": [
          "voice"
        ]
      }
    ],
    "issues": [
      "subscription-is-not-active"
    ],
    "provisioningStatus": "provisioned",
    "createdAt": "2024-11-21T09:02:28.620Z",
    "updatedAt": "2024-11-21T09:02:28.620Z"
  }
}