Retire a number
curl --request POST \
--url https://sandbox.voice.miraiminds.co/v2/phone-numbers/{phone_number_id}/retire \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.voice.miraiminds.co/v2/phone-numbers/{phone_number_id}/retire"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const url = 'https://sandbox.voice.miraiminds.co/v2/phone-numbers/{phone_number_id}/retire';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": "phn_01K9Q3A7C2E4G6J8M0P2R4T6V8",
"connection_id": "tcn_01K9Q2W5D8F3H6J9KMNPQRSTVW",
"provider": "plivo",
"ownership": "customer",
"number": "+918048123456",
"agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
"state": "ready",
"connection_state": "verified",
"version": 4,
"webhook_url": "",
"created_at": "2026-10-09T07:02:11.903215Z",
"health": {
"state": "retired",
"resting_until": null,
"cooling_until": null,
"retired_at": "2026-10-15T10:30:00Z",
"warming": null,
"attempts_this_hour": 12,
"attempts_today": 24,
"answers_today": 17,
"answer_rate_7d": 0.6955,
"series_7d": [
{
"day": "2026-10-09",
"attempts": 52,
"answers": 31
},
{
"day": "2026-10-10",
"attempts": 60,
"answers": 39
},
{
"day": "2026-10-11",
"attempts": 0,
"answers": 0
},
{
"day": "2026-10-12",
"attempts": 58,
"answers": 41
},
{
"day": "2026-10-13",
"attempts": 61,
"answers": 40
},
{
"day": "2026-10-14",
"attempts": 59,
"answers": 43
},
{
"day": "2026-10-15",
"attempts": 24,
"answers": 17
}
],
"rests_today": 0
},
"pools": [
{
"id": "ppl_01K9V2C4E6G8J0M2P4R6T8W0Y2",
"name": "Outreach"
}
]
}Phone numbers
Retire a number
Stops the number calling out until you resume it, and takes it out of every pool’s dialling. It keeps answering calls to it, so its agent is still reachable.
POST
/
v2
/
phone-numbers
/
{phone_number_id}
/
retire
Retire a number
curl --request POST \
--url https://sandbox.voice.miraiminds.co/v2/phone-numbers/{phone_number_id}/retire \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.voice.miraiminds.co/v2/phone-numbers/{phone_number_id}/retire"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const url = 'https://sandbox.voice.miraiminds.co/v2/phone-numbers/{phone_number_id}/retire';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": "phn_01K9Q3A7C2E4G6J8M0P2R4T6V8",
"connection_id": "tcn_01K9Q2W5D8F3H6J9KMNPQRSTVW",
"provider": "plivo",
"ownership": "customer",
"number": "+918048123456",
"agent_id": "agt_01K2M4P7QRSTVWXYZ0A1B2C3",
"state": "ready",
"connection_state": "verified",
"version": 4,
"webhook_url": "",
"created_at": "2026-10-09T07:02:11.903215Z",
"health": {
"state": "retired",
"resting_until": null,
"cooling_until": null,
"retired_at": "2026-10-15T10:30:00Z",
"warming": null,
"attempts_this_hour": 12,
"attempts_today": 24,
"answers_today": 17,
"answer_rate_7d": 0.6955,
"series_7d": [
{
"day": "2026-10-09",
"attempts": 52,
"answers": 31
},
{
"day": "2026-10-10",
"attempts": 60,
"answers": 39
},
{
"day": "2026-10-11",
"attempts": 0,
"answers": 0
},
{
"day": "2026-10-12",
"attempts": 58,
"answers": 41
},
{
"day": "2026-10-13",
"attempts": 61,
"answers": 40
},
{
"day": "2026-10-14",
"attempts": 59,
"answers": 43
},
{
"day": "2026-10-15",
"attempts": 24,
"answers": 17
}
],
"rests_today": 0
},
"pools": [
{
"id": "ppl_01K9V2C4E6G8J0M2P4R6T8W0Y2",
"name": "Outreach"
}
]
}⌘I