RELAY RESTVerified Caller ID

Create a new Verified Caller ID

View as Markdown

Creates a new verified caller ID. A verification code will be sent to the phone number.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.
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

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
The unique identifier of the Verified Caller ID on SignalWire.
numberstring
String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format.
verifiedboolean
A boolean representing whether the number has been verified or not.
typestring or null

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

namestring or null
String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.
extensionstring or null
String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.
verified_atdatetime or null
Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null.
statusenum or null
The verification status for the caller ID.
Allowed values:

Errors