Bitcall logoBitcall API
OTP
Add your Key ID and Secret to send test requests.

List a country’s services

GET
/v1/otp/countries/{countryCode}/services

Returns the services you can rent a number for in one country, with their prices. Each entry’s pools[] are the individual offers, and each offer carries the serviceId you send to POST /v1/otp/request.

Authorization

KeyId ApiSecret
x-key-id<token>

Your API key id.

In: header

x-api-secret<token>

Your API key secret.

In: header

Path Parameters

countryCode*string

Query Parameters

q?string
page?integer
pageSize?integer

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/otp/countries/string/services?page=1&pageSize=50"
{
  "data": [
    {
      "name": "string",
      "slug": "string",
      "availableCount": 0,
      "price": {
        "min": 0,
        "max": 0,
        "average": 0,
        "currency": "string"
      },
      "pools": [
        {
          "serviceId": "string",
          "price": 0,
          "availableCount": 0,
          "successRate": 0
        }
      ]
    }
  ],
  "meta": {
    "page": -9007199254740991,
    "pageSize": -9007199254740991,
    "total": -9007199254740991,
    "totalPages": -9007199254740991,
    "hasNext": true
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request is not valid. See `fields` for what to correct.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "AUTHENTICATION_REQUIRED",
    "message": "This endpoint requires an API key.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "No such resource.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Retry after the interval in `Retry-After`.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Something went wrong on our side.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_RESPONSE_INVALID",
    "message": "The upstream service returned an unexpected response.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "The service is temporarily unavailable. Try again shortly.",
    "requestId": "9f1c7b2e-…"
  }
}

List countries GET

Returns the countries with numbers available to you. A `null` starter price means the country has no priced services under your profile.

List services GET

Returns the services you can rent numbers for, searchable by name. Each entry’s `pools[]` are the individual offers, and each offer carries the `serviceId` you send to [POST /v1/otp/request](#operation/requestOtpNumber).