Skip to main content

Get the number

GET 

https://api.rinkel.com/v1/numbers/:id

Get the number

Request

Path Parameters

    id stringrequired

    The ID of the number to retrieve

Responses

Successfully retrieved the number

Schema
    data object
    idstring

    The ID of the number

    Example: 64b8e900cbe7501ee8467d3e
    labelstringnullable

    The label of the number

    Example: Rinkel
    numberstring

    The phone number in E.164 format

    Example: +31850609000
    localizedNumberstring

    The phone number in localized format

    Example: 085 060 9000
    statusstring

    The status of the number

    Possible values: [ACTIVE, SUSPENDED, CANCELLED, PENDING_CANCEL, PARKED, PENDING_PORTING_IN, PENDING_REGION_VALIDATION, PENDING_ACTIVATION]

    Example: ACTIVE
    activationDatestring<date-time>nullable

    The date and time the number was activated

    Example: 2020-01-01T12:00:00.000Z
    cancelDatestring<date-time>nullable

    The date and time the number was cancelled

    Example: null
    activeUserIdsstring[]

    An array of active user ids included in the forwarding / voice menu features.

    Example: ["66ab605ddac0af208d5f0dab","66ab6061210ac5e3539eec4f","66ab606660166d5dd6779732"]
    insights object
    enabledboolean

    Whether or not insights are enabled for this number

    Default value: false
    Example: false
    dialPlanVersioninteger

    The version of the dial plan

    Example: 1
    dialPlan object
    oneOf
    announcement object
    enabledboolean

    Whether or not the announcement is enabled

    Example: true
    recordingIdstringnullable

    The ID of the recording that is configured as announcement

    Example: 654367fa9ee46392f4b84247
    businessHours object
    enabledboolean

    Whether or not business hours are enabled

    Example: true
    schedule object[]
  • Array [
  • daystring

    The day of the week

    Possible values: [sun, mon, tue, wed, thu, fri, sat]

    Example: mon
    openAllDayboolean

    Whether or not the business is open all day on this day

    Example: false
    closedAllDayboolean

    Whether or not the business is closed all day on this day

    Example: false
    times object[]
  • Array [
  • openstring

    The time the business opens

    Example: 900
    closedstring

    The time the business closes

    Example: 1700
  • ]
  • ]
  • unansweredOptions object
    settingstringrequired

    The unanswered option setting

    Possible values: [hangup, voicemail, forward]

    Example: hangup
    recordingIdstringnullable

    The ID of the recording that is used for the unanswered option, if applicable

    Example: null
    forwardTarget objectnullable
    countryIsoCodestringnullable

    The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable

    Example: NL
    countryCallingCodenumbernullable

    The country calling code of the contact phone number, if applicable

    Example: 31
    numberstringnullable

    The phone number of the contact without country calling code, if applicable

    Example: 612345678
    e164stringnullable

    The phone number of the target in E.164 format, if applicable

    userstringnullable

    The ID of the user that is configured as target, if applicable

    exceptions object[]
  • Array [
  • idstring

    The ID of the business hour exception

    Example: a52f7088-3d94-4c28-be0f-dfb7d4d802cc
    descriptionstring

    Description for the business hour exception

    Example: New years day
    endDatestring<date-time>

    The end date and time of the event in ISO 8601 format (UTC).

    Example: 2025-01-01T23:59:59
    startDatestring<date-time>

    The start date and time of the event in ISO 8601 format (UTC)

    Example: 2025-01-01T00:00:00
    unansweredOptions object
    settingstringrequired

    The unanswered option setting

    Possible values: [hangup, voicemail, forward]

    Example: hangup
    recordingIdstringnullable

    The ID of the recording that is used for the unanswered option, if applicable

    Example: null
    forwardTarget objectnullable
    countryIsoCodestringnullable

    The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable

    Example: NL
    countryCallingCodenumbernullable

    The country calling code of the contact phone number, if applicable

    Example: 31
    numberstringnullable

    The phone number of the contact without country calling code, if applicable

    Example: 612345678
    e164stringnullable

    The phone number of the target in E.164 format, if applicable

    userstringnullable

    The ID of the user that is configured as target, if applicable

  • ]
  • callForwarding object
    enabledboolean

    Whether or not call forwarding is enabled

    Example: true
    ringMethodstring

    The method to use when forwarding calls

    Possible values: [roundRobin, ringAll]

    Example: roundRobin
    queue object
    enabledbooleanrequired

    Whether or not the queue is enabled

    Example: true
    maxTimeintegerrequired

    The maximum time in seconds a call can be in the queue

    Possible values: [60, 120, 180, 240, 300, 600, 900, 1200, 1500, 1800]

    Example: 60
    musicOnHoldIdstringnullable

    The ID of the music on hold to be played, null to disable

    Example: 65438adbfe329346cc4af2f9
    announcementRecordingIdstringnullable

    The ID of the recording that is configured as join announcement, null to disable

    Example: 654367fa9ee46392f4b84247
    targets object[]
  • Array [
  • userstringnullable

    The ID of the user that is configured as target, if applicable

    Example: null
    e164stringnullable

    The phone number of the target in E.164 format

    Example: +31612345678
    enabledboolean

    Whether or not the target is enabled

    Example: true
  • ]
  • unansweredOptions object
    settingstringrequired

    The unanswered option setting

    Possible values: [hangup, voicemail, forward]

    Example: hangup
    recordingIdstringnullable

    The ID of the recording that is used for the unanswered option, if applicable

    Example: null
    forwardTarget objectnullable
    countryIsoCodestringnullable

    The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable

    Example: NL
    countryCallingCodenumbernullable

    The country calling code of the contact phone number, if applicable

    Example: 31
    numberstringnullable

    The phone number of the contact without country calling code, if applicable

    Example: 612345678
    e164stringnullable

    The phone number of the target in E.164 format, if applicable

    userstringnullable

    The ID of the user that is configured as target, if applicable

    callRecording object
    enabledboolean

    Whether or not call recording is enabled

    Example: true
    announcementRecordingIdstringnullable

    The ID of the recording that is configured as announcement

    Example: 654367fa9ee46392f4b84247
    preferences object
    callerIdstring

    The caller ID to use on inbound calls

    Possible values: [caller, callee]

    Example: caller
    callerIdAnnounceboolean

    When callerId is set to caller and this is set to true, an announcement will be played to the callee

    Example: false
    ringTimeinteger

    The time in seconds the forwarded calls will ring

    Example: 20
    voiceMenu object
    enabledboolean

    Whether or not the voice menu is enabled

    Example: true
    announcementRecordingIdstringnullable

    The ID of the announcement recording to play

    Example: 654367fa9ee46392f4b84247
    repeatAnnouncementnumber

    The number of times to repeat the announcement

    Example: 3
    options object[]
  • Array [
  • enabledboolean

    Whether or not the voice menu option is enabled

    Example: true
    defaultboolean

    Whether or not the option is the default

    Example: true
    dtmfstring

    The DTMF digit to press to select this option

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #]

    Example: 1
    setupboolean

    Whether or not to the option is fully setup

    Example: true
    voicemailboolean

    Whether or not to send the call to voicemail

    Example: true
    recordingIdstringnullable

    The ID of the recording to play

    Example: 654367fa9ee46392f4b84247
    callForwarding object
    enabledboolean

    Whether or not call forwarding is enabled

    Example: true
    ringMethodstring

    The method to use when forwarding calls

    Possible values: [roundRobin, ringAll]

    Example: roundRobin
    queue object
    enabledbooleanrequired

    Whether or not the queue is enabled

    Example: true
    maxTimeintegerrequired

    The maximum time in seconds a call can be in the queue

    Possible values: [60, 120, 180, 240, 300, 600, 900, 1200, 1500, 1800]

    Example: 60
    musicOnHoldIdstringnullable

    The ID of the music on hold to be played, null to disable

    Example: 65438adbfe329346cc4af2f9
    announcementRecordingIdstringnullable

    The ID of the recording that is configured as join announcement, null to disable

    Example: 654367fa9ee46392f4b84247
    targets object[]
  • Array [
  • userstringnullable

    The ID of the user that is configured as target, if applicable

    Example: null
    e164stringnullable

    The phone number of the target in E.164 format

    Example: +31612345678
    enabledboolean

    Whether or not the target is enabled

    Example: true
  • ]
  • unansweredOptions object
    settingstringrequired

    The unanswered option setting

    Possible values: [hangup, voicemail, forward]

    Example: hangup
    recordingIdstringnullable

    The ID of the recording that is used for the unanswered option, if applicable

    Example: null
    forwardTarget objectnullable
    countryIsoCodestringnullable

    The country code of the contact phone number in ISO 3166-1 alpha-2 format, if applicable

    Example: NL
    countryCallingCodenumbernullable

    The country calling code of the contact phone number, if applicable

    Example: 31
    numberstringnullable

    The phone number of the contact without country calling code, if applicable

    Example: 612345678
    e164stringnullable

    The phone number of the target in E.164 format, if applicable

    userstringnullable

    The ID of the user that is configured as target, if applicable

  • ]

Authorization: x-rinkel-api-key

name: x-rinkel-api-keytype: apiKeyin: header
curl -L 'https://api.rinkel.com/v1/numbers/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <x-rinkel-api-key>'
Request Collapse all
Base URL
https://api.rinkel.com/v1
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!