Create a new Verified Caller ID

POST 
/verified_caller_ids

To send a verification call to a number, you send a POST request to the Verified Caller ID resource.

Permissions

The API token must include the following scopes: Voice.

Request

application/json

Body

required

name string
String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.
Example: C-3P0
extension string
String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.
Example: 1234
number stringrequired
String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format that is able to receive a voice phone call for verification.
Example: +15551234567

Responses

201

CREATED

application/json

Schema

Schema

type string
The type of the returned object, this should be verified_caller_id.
Example: verified_caller_id
id uuid

The unique identifier of the Verified Caller ID on SignalWire.

name string
String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.
Example: C-3P0
extension string
String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.
Example: 1234
number stringrequired
String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format that is able to receive a voice phone call for verification.
Example: +15551234567
verified boolean
A boolean representing whether the number has been verified or not.
Example: false
verified_at string
Nullable DateTime fields representing the date and time that the number was verified. If the number has not been verified, it will be null.
Example: null
status string
String representing the verification status for the caller ID. Current values are "Verified" and "Awaiting Verification"
Example: Awaiting Verification

Example (from schema)

{
  "type": "verified_caller_id",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "C-3P0",
  "extension": "1234",
  "number": "+15551234567",
  "verified": false,
  "verified_at": null,
  "status": "Awaiting Verification"
}