Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Numbers

Get the details of a specific dedicated number

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/undefined/getDedicatedNumber" target="_blank">Try in sandbox</a><br>

get/api/v2/numbers/{id}

Path parameters

idinteger required

Response

Requested dedicated number data returned with success.

idinteger required

Dedicated number ID.

displayTimeFormatstring

Format for representation of time.

phonestring

Dedicated phone number.

purchasedAtstring date-time required

Time when the dedicated number was purchased.

expireAtstring date-time required

Dedicated number subscription expiration time.

status'U' | 'A' required

Number status:

  • U for Unused. No messages have been sent from (or received to) this number;
  • A for Active.

Example response

{
  "id": 305,
  "displayTimeFormat": "24h",
  "phone": "447860021130",
  "user": {
    "id": 305,
    "displayTimeFormat": "24h",
    "username": "charles.conway",
    "firstName": "Charles",
    "lastName": "Conway",
    "email": "charles@example.com",
    "status": "A",
    "balance": 208.64,
    "phone": "447860021130",
    "company": "Example Ltd.",
    "currency": {
      "id": "GBP",
      "unicodeSymbol": "£",
      "htmlSymbol": "&pound;"
    },
    "country": {
      "id": "US",
      "name": "India"
    },
    "timezone": {
      "id": 55,
      "area": "Europe",
      "dst": 1,
      "offset": 10800,
      "timezone": "Europe\\/Tallinn"
    },
    "subaccountType": "P",
    "emailAccepted": true,
    "phoneAccepted": true,
    "avatar": {
      "href": "avatars/lav5d8de21d89971646555094.png"
    }
  },
  "purchasedAt": "2014-10-02T11:07:04+0000",
  "expireAt": "2014-10-02T11:07:04+0000",
  "status": "U",
  "country": {
    "id": "US",
    "name": "India"
  }
}