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

List number pools

GET
/v1/otp/pools

Returns the number pools available to you, by their public codes. A pool is a grouping of numbers, not something you can rent directly: use its code to filter GET /v1/otp/services, and rent with the serviceId from a catalog offer — whose first segment is this same code.

Authorization

KeyId ApiSecret
x-key-id<token>

Your API key id.

In: header

x-api-secret<token>

Your API key secret.

In: header

Query Parameters

q?string
page?integer
Default1
Range1 <= value <= 10000
pageSize?integer
Default50
Range1 <= value <= 200

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/pools?page=1&pageSize=50" \  -H "x-key-id: YOUR_KEY_ID" \  -H "x-api-secret: YOUR_API_SECRET"
{
  "data": [
    {
      "pool": "BRAVO",
      "serviceCount": 172
    },
    {
      "pool": "CHARLIE",
      "serviceCount": 1312
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 2,
    "total": 11,
    "totalPages": 6,
    "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": "CONFLICT",
    "message": "The resource is not in a state that allows this operation.",
    "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-…"
  }
}

Reactivate an activation POST

Reopens an expired or cancelled activation on the same number so it can receive a further code. Chargeable. Only available for a short window after the activation ends, on supported number pools — the `canReactivate` flag on an activation is a best-effort hint from its state, so reactivation can still be refused (409 REACTIVATION_UNAVAILABLE) when the provider window has closed; start a new activation in that case.

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.