v3 masinis atkūrimas
Šios API funkcijos paskirtis – masiškai atkurti telefono numerius.
POST: https://api.multitel.net/v3/bulk_restore
- Autentifikavimas: HTTP basic su naudotojo API prisijungimo duomenimis.
- Užklausos turinys (application/json):
{
"numbers":
[
"15551230111",
"15551230112",
"15551230113"
],
"webhook_url": "https://client.example.com/restore-hook"
}
- Priimamos tik iš skaitmenų sudarytos eilutės; numbers_text (atskirtas naujomis eilutėmis) taip pat tinka.
- 10 numerių arba mažiau → tvarkoma sinchroniškai; daugiau nei 10 → įtraukiama į eilę ir apdorojama foninio tarnybos proceso.
- Sinchroninis atsakas (galimas tik jei pateikta 10 numerių arba mažiau):
{
"job_uuid": "8f6c1f0e-23d2-4717-8c8e-1a518e5738f0",
"status": "completed",
"total_numbers": 3,
"success_count": 1,
"failure_count": 2,
"webhook_url": "https://client.example.com/restore-hook",
"created_at": "2025-10-28 12:31:45",
"started_at": "2025-10-28 12:31:45",
"completed_at": "2025-10-28 12:31:48",
"results": [
{
"number": "15551230111",
"status": "success",
"message": "Number restored",
"status_code": 200,
"requires_identity_update": 0
},
{
"number": "15551230112",
"status": "failed",
"message": "Error: 'restore failed, please contact support'",
"status_code": 500,
"requires_identity_update": 0
},
{
"number": "15551230113",
"status": "success",
"message": "Number restored",
"status_code": 200,
"requires_identity_update": 1,
"needs_registration": 1
}
]
}
Jei apdorojant siunčiamus duomenis atsiranda klaidų (laiko limito viršijimas, domeno nepavyksta rasti per DNS ir pan.), klaidos bus grąžintos po „results“ masyvo:
"webhook_error":"Could not resolve host: asidhaiufsd0uf.multitel.net"
ARBA, jei buvo pateikta daugiau nei 10 numerių:
- Įtraukta į eilę (202 Accepted):
{
"job_uuid": "c5bc4f3a-7b0a-4d5d-9f7e-d3fd87f41a00",
"status": "pending",
"total_numbers": 25,
"webhook_url": "https://client.example.com/restore-hook",
"message": "Restore job queued. Results will be POSTed to https://client.example.com/restore-hook"
}
- Webhook siunčiamų duomenų struktūra yra identiška galutinei sinchroninei struktūrai (įskaitant kiekvieno numerio būsenos kodus / pranešimus).
Būsenos apklausa
- GET https://api.multitel.net/v3/bulk_restore_status
- Privalomas job_uuid, pasirenkamas numeris (tik skaitmenys).
- Atsakas atspindi užduoties santrauką su dabartine kiekvieno numerio būsena, taip pat bandymais ir laiko žymomis; numerio filtras grąžina tik tą įrašą.
- Pavyzdys: GET …/bulk_restore_status?job_uuid=8f6c1f0e-23d2-4717-8c8e-1a518e5738f0
- Filtruota: GET …/bulk_restore_status?job_uuid=…&number=15551230113
- GET https://api.multitel.net/v3/bulk_restore_status
- Autentifikavimas: toks pats HTTP Basic kaip ir kitiems v3 iškvietimams.
- Užklausos parametrai:
- job_uuid (privalomas) – grąžinamas iš POST atsako.
- number (pasirenkamas) – tik skaitmenys; susiaurina rezultatus iki vieno DID.
- Atsakas atspindi webhook naudingąją apkrovą ir dabar apima requires_identity_update (1/0) bei needs_registration, kai taikoma. Pavyzdys:
{
"job_uuid": "8f6c1f0e-23d2-4717-8c8e-1a518e5738f0",
"status": "processing",
"total_numbers": 25,
"success_count": 10,
"failure_count": 0,
"webhook_url": "https://client.example.com/restore-hook",
"created_at": "2025-10-28 12:31:45",
"started_at": "2025-10-28 12:31:45",
"completed_at": null,
"results": [
{
"number": "15551230111",
"status": "success",
"message": "Number restored",
"status_code": 200,
"attempts": 1,
"started_at": "2025-03-28 12:31:45",
"completed_at": "2025-03-28 12:31:47",
"requires_identity_update": 0
},
{
"number": "15551230112",
"status": "failed",
"message": "Error: 'restore failed, please contact support'",
"status_code": 500,
"attempts": 1,
"started_at": "2025-03-28 12:31:45",
"completed_at": "2025-03-28 12:31:46",
"requires_identity_update": 0
},
{
"number": "15551230113",
"status": "success",
"message": "Number restored",
"status_code": 200,
"attempts": 1,
"started_at": "2025-03-28 12:31:45",
"completed_at": "2025-03-28 12:31:48",
"requires_identity_update": 1,
"needs_registration": 1
}
]
}
- Su number=15551230113 results masyve bus tik tas įrašas ir filtered_number siunčiamuose duomenyse.
Jei norite sukurti savo masinio atkūrimo funkciją, galite naudoti toliau pateiktą vieno numerio API prieigos tašką ir iškviesti jį pakartotinai kiekvienam numeriui, kurį norite atkurti.
curl -u 'USERNAME:PASSWORD' \
-H 'Accept: application/json' \
https://api.multitel.net/v3/restore/447000123456