Bitcall APIAdd your Key ID and Secret to send test requests.
Submit a lookup
Queues one number or a batch for lookup and returns a job to poll. The job is charged per number as results arrive.
Authorization
KeyId ApiSecret x-key-id<token>
Your API key id.
In: header
x-api-secret<token>
Your API key secret.
In: header
Header Parameters
Idempotency-Key*string
Required. Repeating this operation with the same key and the same request replays the original response for 24 hours; a different request with the same key returns 409 IDEMPOTENCY_CONFLICT.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/hlr/lookups/jobs" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "lookupType": "hlr-batch", "productCode": "hlr:V11", "msisdns": [ "21650000001", "21650000002" ], "name": "Example batch" }'{
"data": {
"jobId": "string",
"status": "queued",
"counts": {
"input": 0,
"processed": 0,
"accepted": 0,
"rejected": 0,
"failed": 0
},
"actions": {
"canCancel": true,
"canExport": true
},
"lookupType": "string",
"category": "string",
"productCode": "string",
"name": "string",
"price": {
"amount": 0,
"currency": "string"
},
"startedAt": "string",
"completedAt": "string",
"createdAt": "string",
"updatedAt": "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": "INSUFFICIENT_BALANCE",
"message": "Your account balance is too low for 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-…"
}
}