Register your own number
Trillet OEM API: Registers a number you or your customer already own, over a SIP trunk or a Twilio account.
Registers a number you or your customer already own, over a SIP trunk or a Twilio account.
Trillet does not bill these numbers. 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. A number can be registered only once across Trillet.
^\+[1-9]\d{6,14}$provider"sip" | "twilio"required"sip" | "twilio"credentialsobjectrequiredFor sip: sipUri (where Trillet sends outbound calls), optional username and
password, and optional ipAddresses your carrier sends calls from. Each entry in
ipAddresses is an object: id (required, any string you choose, unique in the list),
ip, and subnetMask (the prefix length as a string, for example "32"). A plain list
of IP strings is refused with 400 number_registration_failed.
For twilio: accountSid and authToken.
Response
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