S
Samva
S
Samva
DashboardAPISamva DocumentationQuickstart GuideAuthentication

Api referenceSms

Search Available Phone Numbers

GET
/sms/available-numbers

Authorization

apiKey
X-API-Key<token>

API key for authentication

In: header

Query Parameters

country*string

ISO 3166-1 alpha-2 country code

Length2 <= length <= 2
type*unknown

Number type

Value in"local" | "tollfree" | "mobile" | "shortcode"
areaCode?string

Area code filter (US/Canada only)

locality?string

City or locality filter

limit?integer

Maximum number of results

Default20
Range1 <= value <= 50

Response Body

application/json

curl -X GET "https://samva.app/api/v1/sms/available-numbers?country=st&type=local"
[
  {
    "phoneNumber": "string",
    "friendlyName": "string",
    "capabilities": {
      "sms": true,
      "mms": true,
      "voice": true
    },
    "region": "string",
    "locality": "string",
    "monthlyPrice": {
      "amount": 0,
      "currency": "string"
    }
  }
]
curl -X GET "https://samva.app/api/v1/sms/available-numbers?country=st&type=local"