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

Get an export

GET
/v1/hlr/lookups/exports/{jobId}/{format}

Returns the export's availability and, once ready, a time-limited download link.

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

jobId*string
format*string

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/hlr/lookups/exports/string/json"
{
  "data": {
    "status": "pending",
    "format": "string",
    "downloadUrl": "string",
    "expiresAt": "string"
  }
}
{
  "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-…"
  }
}

Cancel a job POST

Stops a queued or running job. Numbers not yet processed are not charged. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Build an export POST

Starts building a downloadable file of a completed job's results. Repeating this returns the existing build. This operation is safe to repeat: repeating it returns the existing state and performs no further action.