Caller ID Name

Get caller ID name

Changed on

Retrieves the most recent caller ID name request for a phone number in your project, including its current review status. After Request a caller ID name, poll this operation until status is approved, rejected, or failed.

The response's name is the requested name. It can differ from the name call recipients currently see while the request is pending or in_review, or after it is rejected or failed. To retrieve the caller ID name currently applied at the carrier, read cnam on the phone number with Get phone number.

Returns 404 when the phone number is not in your project or has never had a caller ID name requested.

Permissions

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

Learn more about API scopes.

get/api/relay/rest/phone_numbers/{id}/cnam

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/phone_numbers/{id}/cnam
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the phone number.

Response

The request has succeeded.

type'cnam' required

The type of object. Always cnam.

idstring uuid required

Universal Unique Identifier.

phone_number_idstring uuid required

Universal Unique Identifier.

namestring required

The requested caller ID name after normalization. SignalWire removes control characters, trims leading and trailing whitespace, collapses runs of whitespace to single spaces, and converts letters to upper case before storing the value. The stored name is at most 15 characters.

status'pending' | 'approved' | 'in_review' | 'rejected' | 'failed' required

Possible review statuses for a caller ID name request.

reason'offensive_language' | 'impersonation' | 'unverified_brand' | 'implied_trusted_institution' | 'scam_wording' | 'deceptive' | 'unsupported_personal_name' | 'too_generic' | 'invalid_format' | 'unrelated_to_business' | 'needs_documentation' | 'other_compliance_concern' | 'processing_failed' required

Possible reasons a caller ID name request requires review, was rejected, or failed. Each code is explained on the reason field.

required_actionstring nullable required

An action you can take to address the review, such as changing, verifying, or documenting the requested name. null when review produced no specific action.

created_atstring date-time required

The date the request was created.

updated_atstring date-time required

The date the request was last updated.

Example response

{
  "name": "ACME PLUMBING"
}

Changes

Some revisions have not been checked yet.