PhoneController

Search available phone numbers

Search available numbers for advanced provisioning

post/phone/provisioning/search

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/phone/provisioning/search
  • 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
phoneVariant'LOCAL' | 'MOBILE' | 'TOLL_FREE' nullable
qualityFilter'OTP' | 'NON_VOIP' | 'MOBILE_ONLY' | 'ANY' nullable

Quality filter for advanced phone provisioning search

lineTypestring nullable
carrierNamestring nullable
mobileCountryCodestring nullable
mobileNetworkCodestring nullable
providerLabelsstring[] nullable
limitinteger nullable

Response

OK

Changes

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