release a number
give the number up. irreversible — confirmNumber must spell the number (bare digits or E.164). a rental that never completed is withdrawn instead and its prepaid rent returned to the wallet.
Authorizations
your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.
Path Parameters
the rented number's id.
Body
the number, typed to confirm — bare digits or E.164.
6 - 20Response
ok.
a number rented through rumik, with its lifecycle.
the rental's id.
funding → kyc_submitted → kyc_accepted → purchasing → awaiting_funds → active; kyc_rejected, past_due, releasing, released, failed.
the wallet's currency (INR).
the rental's progress, step by step: key, label, state (done | active | pending | failed), at, detail.
the raw event log.
what was asked for.
the number owned (bare digits), once purchased.
the same in E.164 — what fromNumber on POST /v1/calls takes.
the monthly rent in the wallet's currency, in nanos (billionths).
one-off setup fee, nanos.
inbound per-minute carrier rate, nanos.
outbound per-minute carrier rate, nanos, billed per outboundUnitSeconds.
the outbound billing pulse (30 s for India).
the first charge collected before the KYC went out.
when the number was purchased.
when the next month's rent is due.
why it was released (user, non_payment, …).
the last carrier or billing error, if any.
the agent connected to the number, or null.
that agent's name.
the KYC application: status, rejectionReason, attempts, history.