v3-joukkopalautus
Tämän API-toiminnon tarkoituksena on palauttaa puhelinnumeroita joukkona. POST: https://api.multitel.net/v3/bulk_restore - Todennus: HTTP basic käyttäjän API-tunnuksilla. - Runko (application/json): {
"numbers":
[
"15551230111",
"15551230112",
"15551230113"
],
"webhook_url": "https://client.example.com/restore-hook"
} - Hyväksyy vain numeromerkkejä sisältäviä merkkijonoja; numbers_text (rivinvaihdolla erotettuna) toimii myös. - Enintään 10 numeroa → käsitellään synkronisesti; yli 10 → jonotetaan ja käsitellään taustatyöntekijän avulla. - Synkroninen vastaus (mahdollinen vain, jos annetaan enintään 10 numeroa): {
"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
}
]
} Jos hyötykuorman käsittelyssä ilmenee virheitä (aikakatkaisut, verkkotunnusta ei voida selvittää DNS:ssä jne.), virheet palautetaan 'results'-taulukon jälkeen: "webhook_error":"Could not resolve host: asidhaiufsd0uf.multitel.net" TAI, jos annettiin yli 10 numeroa: - Jonotettu (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-hyötykuorma on identtinen lopullisen synkronisen rakenteen kanssa (mukaan lukien numerokohtaiset tilakoodit ja viestit). Tilan kysely - GET https://api.multitel.net/v3/bulk_restore_status - Pakollinen job_uuid, valinnainen number (vain numeromerkkejä). - Vastaus vastaa työn yhteenvetoa sisältäen nykyisen numerokohtaisen tilan sekä yritykset ja aikaleimat; numerosuodatin palauttaa vain kyseisen merkinnän. - Esimerkki: GET …/bulk_restore_status?job_uuid=8f6c1f0e-23d2-4717-8c8e-1a518e5738f0 - Suodatettu: GET …/bulk_restore_status?job_uuid=…&number=15551230113 - GET https://api.multitel.net/v3/bulk_restore_status - Todennus: sama HTTP Basic kuin muissa v3-kutsuissa. - Kyselyparametrit: - job_uuid (pakollinen) – palautetaan POST-vastauksesta. - number (valinnainen) – vain numeromerkkejä; rajaa tulokset yhteen DID-numeroon. - Vastaus vastaa webhook-hyötykuormaa ja sisältää nyt requires_identity_update (1/0) sekä needs_registration tarvittaessa. Esimerkki: {
"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
}
]
} - Kun number=15551230113, results-taulukko sisältää vain kyseisen merkinnän sekä filtered_number hyötykuormassa. Jos haluat luoda oman joukkopalautustoiminnon, voit käyttää alla olevaa yksittäisen numeron API-päätepistettä ja kutsua sitä toistuvasti jokaiselle palautettavalle numerolle. curl -u 'USERNAME:PASSWORD' \
-H 'Accept: application/json' \
https://api.multitel.net/v3/restore/447000123456