Check an order
Returns the current state of an order, including the received code once it arrives. Poll this after requesting a number.
Authorization
KeyId ApiSecret Your API key id.
In: header
Your API key secret.
In: header
Query Parameters
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/status?page=1&pageSize=50"{
"data": [
{
"orderId": "string",
"status": "waiting",
"actions": {
"canResend": true,
"canReactivate": true,
"canRefund": true
},
"serviceId": "string",
"service": "string",
"countryCode": "string",
"phoneNumber": "string",
"price": {
"amount": 0,
"currency": "string"
},
"code": "string",
"expiresAt": "string",
"createdAt": "string",
"updatedAt": "string",
"resend": {
"cooldownSeconds": 0,
"price": {
"amount": 0,
"currency": "string"
}
}
}
],
"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-…"
}
}Request a number POST
Rents a number for a service and country, and starts waiting for its code. The rental is charged on success and the order begins in `waiting`. `serviceId` identifies the offer to rent and comes from the catalog — `pools[].serviceId` on [GET /v1/otp/services/{serviceSlug}/{countryCode}](#operation/getOtpServiceOffer) is the usual source. It is opaque: send it back as published.
List past orders GET
Returns your OTP orders, newest first, optionally filtered by status.