Create Custom VoIP Number
Creates a custom VoIP phone number and, in the same call, optionally configures its inbound (sipConfig) and/or outbound (sipTrunkConfig). When an inbound configuration is provided, the generated SIP domain is returned in sipConfig.domain. A number that already exists as a custom VoIP number of the account is rejected with a 400 that gives its id. If the configuration fails, nothing is created and the call can be retried.
Authorizations
Specify the authorization token.
For more information, check out the Authorization Guide.
Body
Data used to create a custom VoIP phone number. The inbound (sipConfig) and outbound
(sipTrunkConfig) configurations are independent and optional: provide one, the other, both, or none.
Response
The created custom VoIP phone number, including the SIP domain when inbound is configured.
A phone number of the account as exposed by the API. For custom VoIP numbers it also carries the configured inbound and/or outbound SIP setup (passwords are never returned).
Phone number direction (supported call capabilities).
- InboundOutbound: Supports both inbound and outbound calls.
- Inbound: Supports inbound calls only.
- Outbound: Supports outbound calls only.
- NotSet: Direction is not set.
1 - InboundOutbound
2 - Inbound
3 - Outbound
10 - NotSet
Indicates how the phone number is provisioned and connected to NLPearl.
- NLPearlDefault: a shared default number provided by NLPearl.
- NLPearl: a number purchased and managed for you by NLPearl.
- Twilio: a number from your own Twilio account that you connected.
- CustomVoip: a custom VoIP number you connect over SIP.
- Undefined: the type could not be determined.
1 - NLPearlDefault
2 - NLPearl
3 - Twilio
4 - CustomVoip
99 - Undefined

