create | SignalWire

Create a new caller ID entry and initiate verification. SignalWire will place a phone call or send an SMS to verify ownership.

Request

numberstringRequired

String representing the phone number for the caller ID. This must be a valid, routeable phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164) that is able to receive a voice phone call for verification.

namestringOptional<=200 characters

The name portion of the caller ID. If not provided, the default will be the formatted number.

extensionstringOptional

The extension of the phone number for the caller ID. This is only used when placing the verification call.

Response

idstringRequiredformat: "uuid"

The unique identifier of the Verified Caller ID on SignalWire.

numberstringRequired

String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format.

verifiedbooleanRequired

A boolean representing whether the number has been verified or not.

typestringOptional

The type of the returned object, this should be verified_caller_id.

namestringOptional

String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.

extensionstringOptional

String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.

verified_atdatetimeOptional

Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null.

statusenumOptional

The verification status for the caller ID.

Allowed values:

Response Example

Response

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "number": "+15551234567",
4   "verified": false,
5   "type": "verified_caller_id",
6   "name": "C-3P0",
7   "extension": "1234",
8   "verified_at": "2024-01-15T09:30:00Z",
9   "status": "Awaiting Verification"
10 }

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const caller = await client.verifiedCallers.create({ number: "+15551234567" });
10 console.log("Verification state:", caller.verificationState);