Get the number
GEThttps://api.rinkel.com/v1/numbers/:id
Get the number
Request
Path Parameters
id stringrequired
The ID of the number to retrieve
Responses
- 200
- 401
- 404
- 500
Successfully retrieved the number
- application/json
- Schema
- Example (auto)
Schema
data object
{
"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
},
"exceptions": [
{
"id": "a52f7088-3d94-4c28-be0f-dfb7d4d802cc",
"description": "New years day",
"endDate": "2025-01-01T23:59:59",
"startDate": "2025-01-01T00:00:00",
"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
Authorization: x-rinkel-api-key
name: x-rinkel-api-keytype: apiKeyin: header
- curl
- nodejs
- php
- python
- ruby
- java
- CURL
curl -L 'https://api.rinkel.com/v1/numbers/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <x-rinkel-api-key>'
ResponseClear