REST ClientVerified Callers

list

View as MarkdownOpen in Claude

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

datalist of objectsOptional
List of verified caller IDs.

Response Example

Response
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "number": "+15551234567",
12      "verified": false,
13      "type": "verified_caller_id",
14      "name": "C-3P0",
15      "extension": "1234",
16      "verified_at": "2024-01-15T09:30:00Z",
17      "status": "Awaiting Verification"
18    }
19  ]
20}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const result = await client.verifiedCallers.list();
10for (const caller of result.data ?? []) {
11    console.log(caller.phoneNumber, caller.verificationState);
12}