Get the number

Get the number

Path Parameters

id string required

The ID of the number to retrieve

Responses

• 200
• 401
• 404
• 500

---

Successfully retrieved the number

application/json

Schema

Example (from schema)

---

Schema

data object
id string
The ID of the number
label string nullable
The label of the number
number string
The phone number in E.164 format
localizedNumber string
The phone number in localized format
status string
Possible values: [ACTIVE, SUSPENDED, CANCELLED, PENDING_CANCEL, PARKED, PENDING_PARKING, PENDING_PORTING_IN, PENDING_REGION_VALIDATION, PENDING_ACTIVATION]
The status of the number
activationDate date-time nullable
The date and time the number was activated
cancelDate date-time nullable
The date and time the number was cancelled
activeUserIds string[]
An array of active user ids included in the forwarding / voice menu features.
insights object
enabled boolean
Default value: false
Whether or not insights are enabled for this number
dialPlanVersion integer
The version of the dial plan
dialPlan object
announcement object
enabled boolean
Whether or not the announcement is enabled
recordingId string nullable
The ID of the recording that is configured as announcement
businessHours object
enabled boolean
Whether or not business hours are enabled
schedule object[]
Array [
day string
Possible values: [sun, mon, tue, wed, thu, fri, sat]
The day of the week
openAllDay boolean
Whether or not the business is open all day on this day
closedAllDay boolean
Whether or not the business is closed all day on this day
times object[]
Array [
open string
The time the business opens
closed string
The time the business closes
]
]
unansweredOptions object
setting string required
Possible values: [hangup, voicemail, forward]
The unanswered option setting
recordingId string nullable
The ID of the recording that is used for the unanswered option, if applicable
forwardTarget object nullable
countryIsoCode string nullable
The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable
countryCallingCode number nullable
The country calling code of the contact phone number, if applicable
number string nullable
The phone number of the contact without country calling code, if applicable
e164 string nullable
The phone number of the target in E.164 format, if applicable
user string nullable
The ID of the user that is configured as target, if applicable
callForwarding object
enabled boolean
Whether or not call forwarding is enabled
ringMethod string
Possible values: [roundRobin, ringAll]
The method to use when forwarding calls
queue object
enabled boolean required
Whether or not the queue is enabled
maxTime integer required
Possible values: [60, 120, 180, 240, 300, 600, 900, 1200, 1500, 1800]
The maximum time in seconds a call can be in the queue
musicOnHoldId string nullable
The ID of the music on hold to be played, null to disable
announcementRecordingId string nullable
The ID of the recording that is configured as join announcement, null to disable
targets object[]
Array [
user string nullable
The ID of the user that is configured as target, if applicable
e164 string nullable
The phone number of the target in E.164 format
enabled boolean
Whether or not the target is enabled
]
unansweredOptions object
setting string required
Possible values: [hangup, voicemail, forward]
The unanswered option setting
recordingId string nullable
The ID of the recording that is used for the unanswered option, if applicable
forwardTarget object nullable
countryIsoCode string nullable
The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable
countryCallingCode number nullable
The country calling code of the contact phone number, if applicable
number string nullable
The phone number of the contact without country calling code, if applicable
e164 string nullable
The phone number of the target in E.164 format, if applicable
user string nullable
The ID of the user that is configured as target, if applicable
callRecording object
enabled boolean
Whether or not call recording is enabled
announcementRecordingId string nullable
The ID of the recording that is configured as announcement
preferences object
callerId string
Possible values: [caller, callee]
The caller ID to use on inbound calls
callerIdAnnounce boolean
When callerId is set to caller and this is set to true, an announcement will be played to the callee
ringTime integer
The time in seconds the forwarded calls will ring
voiceMenu object
enabled boolean
Whether or not the voice menu is enabled
announcementRecordingId string nullable
The ID of the announcement recording to play
repeatAnnouncement number
The number of times to repeat the announcement
options object[]
Array [
enabled boolean
Whether or not the voice menu option is enabled
default boolean
Whether or not the option is the default
dtmf string
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #]
The DTMF digit to press to select this option
setup boolean
Whether or not to the option is fully setup
voicemail boolean
Whether or not to send the call to voicemail
recordingId string nullable
The ID of the recording to play
callForwarding object
enabled boolean
Whether or not call forwarding is enabled
ringMethod string
Possible values: [roundRobin, ringAll]
The method to use when forwarding calls
queue object
enabled boolean required
Whether or not the queue is enabled
maxTime integer required
Possible values: [60, 120, 180, 240, 300, 600, 900, 1200, 1500, 1800]
The maximum time in seconds a call can be in the queue
musicOnHoldId string nullable
The ID of the music on hold to be played, null to disable
announcementRecordingId string nullable
The ID of the recording that is configured as join announcement, null to disable
targets object[]
Array [
user string nullable
The ID of the user that is configured as target, if applicable
e164 string nullable
The phone number of the target in E.164 format
enabled boolean
Whether or not the target is enabled
]
unansweredOptions object
setting string required
Possible values: [hangup, voicemail, forward]
The unanswered option setting
recordingId string nullable
The ID of the recording that is used for the unanswered option, if applicable
forwardTarget object nullable
countryIsoCode string nullable
The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable
countryCallingCode number nullable
The country calling code of the contact phone number, if applicable
number string nullable
The phone number of the contact without country calling code, if applicable
e164 string nullable
The phone number of the target in E.164 format, if applicable
user string nullable
The ID of the user that is configured as target, if applicable
]

{
  "data": {
    "id": "64b8e900cbe7501ee8467d3e",
    "label": "Rinkel",
    "number": "+31850609000",
    "localizedNumber": "085 060 9000",
    "status": "ACTIVE",
    "activationDate": "2020-01-01T12:00:00.000Z",
    "cancelDate": null,
    "activeUserIds": [
      "66ab605ddac0af208d5f0dab",
      "66ab6061210ac5e3539eec4f",
      "66ab606660166d5dd6779732"
    ],
    "insights": {
      "enabled": false
    },
    "dialPlanVersion": 1,
    "dialPlan": {
      "announcement": {
        "enabled": true,
        "recordingId": "654367fa9ee46392f4b84247"
      },
      "businessHours": {
        "enabled": true,
        "schedule": [
          {
            "day": "mon",
            "openAllDay": false,
            "closedAllDay": false,
            "times": [
              {
                "open": 900,
                "closed": "1700"
              }
            ]
          }
        ],
        "unansweredOptions": {
          "setting": "hangup",
          "recordingId": null,
          "forwardTarget": null
        }
      },
      "callForwarding": {
        "enabled": true,
        "ringMethod": "roundRobin",
        "queue": {
          "enabled": true,
          "maxTime": 60,
          "musicOnHoldId": "65438adbfe329346cc4af2f9",
          "announcementRecordingId": "654367fa9ee46392f4b84247"
        },
        "targets": [
          {
            "user": null,
            "e164": "+31612345678",
            "enabled": true
          }
        ],
        "unansweredOptions": {
          "setting": "hangup",
          "recordingId": null,
          "forwardTarget": null
        }
      },
      "callRecording": {
        "enabled": true,
        "announcementRecordingId": "654367fa9ee46392f4b84247"
      },
      "preferences": {
        "callerId": "caller",
        "callerIdAnnounce": false,
        "ringTime": 20
      },
      "voiceMenu": {
        "enabled": true,
        "announcementRecordingId": "654367fa9ee46392f4b84247",
        "repeatAnnouncement": 3,
        "options": [
          {
            "enabled": true,
            "default": true,
            "dtmf": "1",
            "setup": true,
            "voicemail": true,
            "recordingId": "654367fa9ee46392f4b84247",
            "callForwarding": {
              "enabled": true,
              "ringMethod": "roundRobin",
              "queue": {
                "enabled": true,
                "maxTime": 60,
                "musicOnHoldId": "65438adbfe329346cc4af2f9",
                "announcementRecordingId": "654367fa9ee46392f4b84247"
              },
              "targets": [
                {
                  "user": null,
                  "e164": "+31612345678",
                  "enabled": true
                }
              ],
              "unansweredOptions": {
                "setting": "hangup",
                "recordingId": null,
                "forwardTarget": null
              }
            }
          }
        ]
      }
    }
  }
}

Unauthorized

The number was not found

Internal Server Error

Loading...