Telephony and contact center

Check phone numbers, carriers and phone complaints in NICE CXone

Call LookValid from a CXone Studio script with the REST API action, check the caller number early in the flow and branch on the number type.

Why the data matters in NICE CXone

A Studio script routes on what it knows about a contact, and a number in an unexpected format or of an unexpected type sends the contact down the wrong branch before an agent ever sees it. Running the number through a check at the start of the script gives the routing logic a clean international format and a number type to branch on.

What LookValid checks

LookValid checks for NICE CXone
ProductWhat it does hereCredits
Phone Numbering-Plan ValidationFormats the caller number to E.164 and returns the country and plan number type, so a script can branch on mobile versus fixed line. It cannot tell if the number is active.1 credit per valid number
Carrier Lookup (original carrier)For US numbers, returns the originally assigned carrier block with its state and rate center, usable as a regional routing hint. Porting is not reflected.1 credit per lookup (numbers outside the covered numbering plan areas are free)
Phone Spam CheckReturns how many consumer complaints exist for a number in public data, which a script can use to flag a frequent nuisance caller. Complaints are raw consumer reports.1 credit per number with complaints on record

Connect it in four steps

  1. Create a LookValid account and an API key from its dashboard.
  2. Keep the key in a Studio variable or a secure value your administrators control, and place it in the REST API action Headers property as the Authorization bearer value for LOOKVALID_API_KEY, never in a prompt or a skill that callers can reach.
  3. Set the Verb to POST, set the Content-Type header to application/json because the action defaults to form encoding, and send the number in Parameters; on the Success branch continue, and send Error and Failure branches to a default route.
  4. Read lvE164, lvNumberType and lvCountry from the resultSet output into script variables, then branch your routing on lvNumberType.

A REST API action in a CXone Studio script, placed near the start of the flow, before the routing decision. The call is POST https://YOUR_API_HOST/v1/phone and costs 1 credit per valid number.

HTTP request step
POST https://YOUR_API_HOST/v1/phone
Authorization: Bearer {{LOOKVALID_API_KEY}}
Content-Type: application/json
​
{
  "phone": "{{value}}"
}
Where to read each value in the LookValid response
Response fieldGoes into
data.e164lvE164
data.number_typelvNumberType
data.countrylvCountry

The recipe returns nothing when the lookup finds nothing, which costs no credits for this product, and stops with the error code and fix on a failed request.

Without code

The REST API action in Studio is already a generic HTTP request step, so this needs no code beyond the script itself. If you would rather run the check outside CXone, any automation platform generic HTTP request step can post the number to the LookValid endpoint and hand the values back to your system, with no dedicated app involved.

REST and MCPOne shared credit balance

Questions

What does a Studio lookup cost in credits?

Each call spends credits from your LookValid balance at the phone check rate on the pricing page, so check once per contact, not per script pass.

What happens if the response is slow or fails?

The action has a timeout you set and separate result branches for errors, so route those branches to your default queue and let the contact through unchecked.

Where does the key go?

In the Headers property of the REST API action, as a bearer value taken from a protected variable, referenced as LOOKVALID_API_KEY in your own notes.

Sources

LookValid is run by Meralume Labs. It is not connected to, endorsed by or a partner of any company or product named on this page, and every product name belongs to its owner.

LookValid bills every lookup in credits from one shared balance, so the same key works for each check above.

See Phone Numbering-Plan Validation