PhoneController

Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.

Create new phone number

post/phone

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/phone
  • Auth: API key in header x-api-key

Request body

phoneCountry'US' | 'GB' | 'AU' | 'CA' | 'EE' | 'HK' | 'PL' | 'CH' | 'PT' | 'NL' | 'IL' | 'FI' | 'SE' required
namestring nullable
descriptionstring nullable
tagsstring[] nullable
schedule'MONTHLY' | 'YEARLY' nullable
phoneNumberEndpointOverridestring nullable
phoneNumberVariant'LOCAL' | 'MOBILE' | 'TOLL_FREE' nullable
phoneProvider'T1' | 'T2' nullable
phoneLineFilter'ANY' | 'OTP_FRIENDLY' | 'NON_VOIP' nullable

Line-quality preference for simple phone number provisioning

environmentAccountIdstring uuid nullable

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.