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"
}'Réponse200
{
"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 it can be presented on outbound calls.
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.
If the challenge expires or attempts are exhausted, open Voice > Numbers in the dashboard, remove the verified-number registration, and use Add number > Verify a number you own to register it again and receive a new code. Caller-ID creation and deletion are not available through the public API.
Verification also attempts to enable the number's country as a Voice destination. This is best effort: success does not guarantee the destination is enabled. Read the Voice destination settings and enable a supported country when needed.
Paramètres
caller_id
string
Corps de la requête
code
string
obligatoire
The 6-digit verification code read out by the verification call.
Contenu de la réponse
id
string
obligatoire
Unique identifier for this caller ID.
workspace_id
string
obligatoire
phone_number
string
obligatoire
The phone number in E.164 format registered as a caller ID.
name
nullable string
obligatoire
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
obligatoire
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
obligatoire
When the caller ID was verified. null when its status is pending or failed.
created_at
string
obligatoire
updated_at
string
obligatoire
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.
Comprendre le conceptShould I use a Bird SDK or call the API directly?Suivre le parcours d'apprentissageBuild your first integrationGuide d'implémentationSend your first email
Obtenir un guide d'implémentation