Message type settings

AuthenticationCopy Anchor Link

ParametersCopy Anchor Link

No path or query parameters. No request body.

How to use this methodCopy Anchor Link

Check which message types are allowed for your combination of country, service and operator. Send the apikey header; no path or query parameters are needed. The response contains all rules in ascending setting-ID order, without the IDs themselves.

Each non-empty condition must match your combination; an empty string matches any value. A matching rule with more non-empty conditions takes priority. For example, a country-and-service rule overrides a country-only rule, and a matching operator condition makes it more specific still. Use all three flags from the selected rule together: sms, caller and voice use 1 for enabled and 0 for disabled.

If no rule matches, all three types are enabled. An empty data array is a successful response with no configured rules. These permissions do not guarantee available numbers.

The voice query parameter used for prices and number requests has a separate meaning: 0 SMS, 1 caller-ID, 2 voice call. Use the same type when comparing prices and ordering. Check number counts for stock.

Request examplesCopy Anchor Link

Runtime requirements and environment setup. cURL uses a POSIX shell. JavaScript and TypeScript run in Node.js. Java uses the standard HTTP client and prints raw JSON; use your application’s JSON library to inspect the body.

: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
curl --fail-with-body --max-time 30 --request GET \
  --url "https://api.smspva.com/activation/countryservicesettings" \
  --header "apikey: $SMSPVA_API_KEY"

ResponsesCopy Anchor Link

The examples below show the response format. Prices, stock and account values are sample data; use the API response for current values.

{
  "statusCode": 200,
  "data": [
    {
      "country": "",
      "service": "opt20",
      "operator": "",
      "voice": 0,
      "caller": 0,
      "sms": 1
    },
    {
      "country": "FR",
      "service": "opt20",
      "operator": "",
      "voice": 1,
      "caller": 0,
      "sms": 1
    }
  ]
}

{
  "statusCode": 200,
  "data": []
}

{
  "statusCode": 400,
  "error": {
    "type": "APIKEY_NOT_SET",
    "description": "No ApiKey found"
  }
}

{
  "statusCode": 401,
  "error": {
    "type": "USER_NOT_FOUND",
    "description": "Not found"
  }
}

{
  "statusCode": 402,
  "error": {
    "type": "RATELIMIT_EXCEED",
    "description": "Request ratelimit exeeded"
  }
}

{
  "statusCode": 403,
  "error": {
    "type": "USER_BANNED",
    "description": "User banned"
  }
}

{
  "statusCode": 500,
  "error": {
    "type": "SERVER_ERROR",
    "description": "An internal error has occurred while processing your request."
  }
}

Related guidesCopy Anchor Link

• Activation V2
• Reference data
• Activation workflow
• Errors and limits
• Download OpenAPI

If a connection fails during an order-changing request, check the order before trying again.