Verify a caller ID
POST
/v1/voice/caller-ids/{caller_id}/verify
const callerId = await bird.voice.callerIds.verify("CALLER_ID", { code: "123456" });
console.log(callerId.id, callerId.status);caller_id = client.voice.caller_ids.verify("CALLER_ID", code="123456")
print(caller_id.id, caller_id.status)callerID, err := client.Voice.CallerIDs.Verify(context.Background(), "CALLER_ID", bird.VoiceCallerIDsVerifyParams{
Code: "123456",
})
if err != nil {
log.Fatal(err)
}
fmt.Println(callerID.Id, callerID.Status)$callerId = $bird->voice->callerIds->verify(
'CALLER_ID', (new VoiceCallerIDVerifyRequest())->setCode('123456'),
);
echo $callerId->getId(), ' ', $callerId->getStatus(), "\n";bird voice caller-ids verify <caller-id> --code 123456curl -X POST "https://us1.platform.bird.com/v1/voice/caller-ids/{caller_id}/verify" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"code": "123456"
}'Respuesta200
{
"id": "vci_01krdgeqcxet5s7t44vh8rt9mg",
"workspace_id": "ws_01j8z5k2qvfpx9m3n7r4t6y8bc",
"phone_number": "+14155551234",
"name": "Support line",
"status": "verified",
"verified_at": "2026-09-23T10:15:00Z",
"created_at": "2026-09-23T10:00:00Z",
"updated_at": "2026-09-23T10:15:00Z"
}
Completes a caller-ID verification challenge started in the dashboard. Submit
the code delivered by the verification call. Success marks the caller ID as
verified so you can present it on outbound calls. While verification is
pending, an incorrect code is rejected. Repeating the request for an already
verified caller ID returns it without checking the code again.
If the verification call could not be started previously, this request can
retry it and place another call to the same number. Your organization must
still meet the identity-verification requirements for registering caller IDs;
otherwise the request returns 412. For an expired or exhausted challenge,
use Get a new code under Voice > Numbers in the dashboard to remove
and register the caller ID again. List caller IDs again to obtain the new
registration ID before submitting its code. Caller-ID creation and deletion
are not available through the public API.
Verification attempts to enable the number's country as a Voice destination.
An unavailable country or a failed settings update can leave it disabled
after the number is verified. Check Voice > Destinations before calling;
see the caller ID guide.
Parámetros
caller_id
string
Cuerpo de la solicitud
code
string
obligatorio
The 6-digit verification code read out by the verification call.
Carga de respuesta
id
string
obligatorio
Unique identifier for this caller ID.
workspace_id
string
obligatorio
phone_number
string
obligatorio
The phone number in E.164 format registered as a caller ID.
name
nullable string
obligatorio
Your label for this caller ID, to tell several registered numbers apart. null when the caller ID has no label. It is yours to choose and appears nowhere on a call, so changing it never affects what the person you are calling sees. Set it with the caller ID update operation.
status
string
obligatorio
Verification state of the caller ID.
- pending: the number is registered but ownership has not yet been proven.
- verified: the workspace completed the verification call, so the number can be presented as the outbound caller ID.
- failed: terminal because the verification challenge expired or the attempt limit was exhausted. Use the dashboard to remove and register the caller ID again to retry.
Possible values (may grow over time): pending, verified, failed
verified_at
nullable string
obligatorio
When the caller ID was verified. null when its status is pending or failed.
created_at
string
obligatorio
updated_at
string
obligatorio
Recursos relacionados
Continúa con la documentación, guías y ejemplos sobre este tema. Los recursos están en inglés.
Comprender el conceptoShould I use a Bird SDK or call the API directly?Seguir la ruta de aprendizajeBuild your first integrationGuía de implementaciónSend your first email
Obtener un resumen de implementación