Buy a number
Trillet OEM API: Buys a number for the tenant, billed to your partner account at the standard Trillet number price.
Buys a number for the tenant, billed to your partner account at $4.99 per month whatever the
country and type, or at the price agreed for your account. The first month is charged when
you buy, then the number renews monthly. If the first month's charge fails after the
carrier purchase, the response is still 201, with billing.status: past_due.
Find numbers first with GET /v1/api/twilio/available-numbers and the tenant ID in
x-workspace-id. Needs numbers:write. Idempotency-Key is required.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The tenant ID.
^[a-fA-F0-9]{24}$Header Parameters
1 to 255 printable ASCII characters, no spaces. A retry with the same key and request
returns the stored response for 24 hours instead of running again. Failed responses are
stored too, except 5xx, 401, 403, 409 and 429: after fixing the cause of a 4xx
such as 402 insufficient_funds, retry with a new key.
>= 1, <= 255Body
phoneNumberstringrequiredE.164 format.
^\+[1-9]\d{6,14}$countrystringrequiredTwo-letter country code.
>= 2, <= 2type"local" | "mobile""local" | "mobile""local"addressSidstringRegulatory address, for countries that need one.
<= 64bundleSidstringRegulatory bundle, for countries that need one.
<= 64Response
The number.
objectstringrequiredidstringrequiredUse it as phoneNumberId when binding the number to an agent.
^[a-fA-F0-9]{24}$tenantIdstringrequired^[a-fA-F0-9]{24}$phoneNumberstringrequiredE.164 format.
providerstring | nulltypestring | nullexternalbooleanrequiredtrue for numbers you registered yourself.
statusstring | nullagentIdstring | nullcallFlowIdstring | nullbillinganyPresent for numbers bought through Trillet OEM, null for your own numbers.
createdAtstring | null<date-time>Last updated on