list | SignalWire

List verified caller IDs in the project.

Query parameters

filter_namestringOptional

String representing the name assigned to the caller ID. Will return all Verified Caller IDs containing this value as a substring.

filter_numberstringOptional

String representing the number assigned to the caller ID. Will return all Verified Caller IDs containing this value as a substring.

Response

linksobjectOptional

Pagination links.

datalist of objectsOptional

List of verified caller IDs.

Response Example

Response

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "number": "+15551234567",
      "verified": false,
      "type": "verified_caller_id",
      "name": "C-3P0",
      "extension": "1234",
      "verified_at": "2024-01-15T09:30:00Z",
      "status": "Awaiting Verification"
    }
  ]
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const result = await client.verifiedCallers.list();
for (const caller of result.data ?? []) {
    console.log(caller.phoneNumber, caller.verificationState);
}