Add a phone number type

AI-generated summary

Genesys Cloud allows you to create Phone Number type variables in a flow to specify phone numbers whose properties can be easily accessed later. In a task sequence, you can add a Phone Number update statement and assign a value like ToPhoneNumber(Call.Ani) to create the variable. This converts a phone number string into a structured object, providing easy access to properties like the E.164 formatted number, dialing code, subscriber number, and more without custom parsing. You can also assign SIP or SIPS URIs to get properties like uri, e164, dialingCode, and scheme. Genesys Cloud further allows setting the value of a Phone Number variable using expressions, either added inline or through the expression editor. Multiple Phone Number variables can be added by clicking next to Update Statements. Overall, the Phone Number variable in Genesys Cloud provides a structured way to work with phone numbers and URIs in a flow.

Create a phone number type variable in an Update Data action sequence when you want to specify a phone number whose properties can be accessed in other flow locations. For more information, see About the phone number data type.

Examples of phone number typesClick to expand

Example

A typical use case for phone number update statement is to create a phone number from Call.Ani. Because Call.Ani is a string, converting it to a phone number and accessing the properties gives flow authors easy access to information about the phone number via properties. This alleviates the need to write your own string parsing code to retrieve the information:

Variable name: Flow.ClientPhoneNumber
Value to assign: ToPhoneNumber(Call.Ani)

Property	Description
Flow.ClientPhoneNumber.uri	Returns the URI for the tel scheme phone number, otherwise a NOT_SET string.
Flow.ClientPhoneNumber.e164	Returns the E.164 formatted string for the tel scheme phone number with a valid E.164 phone number, including dialing code and subscriber number, otherwise a NOT_SET string.
Flow.ClientPhoneNumber.subscriberNumber	Returns the E.164 formatted subscriber number for a tel scheme phone number with a valid E.164 phone number, otherwise a NOT_SET string.
Flow.ClientPhoneNumber.dialingCode	Returns theE.164 formatted dialing code string for a tel: scheme phone number, otherwise a NOT_SET string.
Flow.ClientPhoneNumber.isSip	Returns false.
Flow.ClientPhoneNumber.isTel	Returns true.
Flow.ClientPhoneNumber.isGlobal	Returns true.
Flow.ClientPhoneNumber.scheme	Returns tel.
Flow.ClientPhoneNumber.raw	Returns the Call.Ani.

Example

The following example illustrate the property data you can extract and the ouput returned when you create a phone number type in a task sequence:

Variable name: Flow.ClientPhoneNumber
Value to assign: ToPhoneNumber(+13175550116)

Property	Output
Flow.ClientPhoneNumber.uri	“tel:+13175550116″
Flow.ClientPhoneNumber.e164	“+13175550116″
Flow.ClientPhoneNumber.subscriberNumber	“3175550116″
Flow.ClientPhoneNumber.dialingCode	“1”
Flow.ClientPhoneNumber.isSip	false
Flow.ClientPhoneNumber.isTel	true
Flow.ClientPhoneNumber.isGlobal	true
Flow.ClientPhoneNumber.scheme	tel
Flow.ClientPhoneNumber.raw	“+13175550116″

Add a phone number update statement to a task sequence

In a task sequence, you can add a phone number expression to an Update Data data action. For example,

From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.
On the Update Data design form, in the Name field, add a meaningful name to describe the item.
Click next to U pdate Statements and select Phone Number.
In the Variable Name field, type the label to store the data and identify the variable on tasks.
To assign a telephone number, complete one of the following steps:
1. In the Value To Assign field, leave the default tel: data type unchanged.
2. Click the arrow at the end of the Dialing Code drop-down list and choose the dialing code for the telephone number to ensure the phone number has global dialing information.
3. In the Enter phone number box, add the subscriber number for the phone number.

Note: The subscriber number can also contain an extension. For example, 31755501116;ext=1234. In this case, the full phone number including scheme, dialing code, and subscriber number is tel: +13178723000;ext=1234.

To assign a SIP URI to the phone number, follow these steps:
1. In the Value To Assign field, click the arrow at the end of the tel: drop-down list and select sip:.
2. In the Enter SIP URI box, add the SIP URI phone number string.
To assign a secure SIP URI to the phone number, follow these steps:
1. In the Value To Assign field, click the arrow at the end of the tel: drop-down list and select sips:.
2. In the Enter SIP URI box, add the secure SIPS URI phone number string.

Note: To set the value using an expression, click the expression modes button and perform one of the following steps:

Add the expression inline.
Click to open the large expression editor and build your expression.

(Optional) To add another Phone Number variable, click next to U pdate Statements.

[NEXT] Was this article helpful?

Get user feedback about articles.

Property

Description

Flow.ClientPhoneNumber.uri

Returns the URI for the tel scheme phone number, otherwise a NOT_SET string.

Flow.ClientPhoneNumber.e164

Returns the E.164 formatted string for the tel scheme phone number with a valid E.164 phone number, including dialing code and subscriber number, otherwise a NOT_SET string.

Flow.ClientPhoneNumber.subscriberNumber

Returns the E.164 formatted subscriber number for a tel scheme phone number with a valid E.164 phone number, otherwise a NOT_SET string.

Flow.ClientPhoneNumber.dialingCode

Returns theE.164 formatted dialing code string for a tel: scheme phone number, otherwise a NOT_SET string.

Flow.ClientPhoneNumber.isSip

Returns false.

Flow.ClientPhoneNumber.isTel

Returns true.

Flow.ClientPhoneNumber.isGlobal

Returns true.

Flow.ClientPhoneNumber.scheme

Returns tel.

Flow.ClientPhoneNumber.raw

Returns the Call.Ani.

Property

Output

Flow.ClientPhoneNumber.uri

“tel:+13175550116″

Flow.ClientPhoneNumber.e164

“+13175550116″

Flow.ClientPhoneNumber.subscriberNumber

“3175550116″

Flow.ClientPhoneNumber.dialingCode

“1”

Flow.ClientPhoneNumber.isSip

false

Flow.ClientPhoneNumber.isTel

true

Flow.ClientPhoneNumber.isGlobal

true

Flow.ClientPhoneNumber.scheme

tel

Flow.ClientPhoneNumber.raw

“+13175550116″

Add a phone number update statement to a task sequence

In a task sequence, you can add a phone number expression to an Update Data data action. For example,

From the Toolbox, expand the Data category and drag an Update Data action to the desired location in the task.

On the Update Data design form, in the Name field, add a meaningful name to describe the item.

Click next to U pdate Statements and select Phone Number.

In the Variable Name field, type the label to store the data and identify the variable on tasks.

To assign a telephone number, complete one of the following steps:

In the Value To Assign field, leave the default tel: data type unchanged.
Click the arrow at the end of the Dialing Code drop-down list and choose the dialing code for the telephone number to ensure the phone number has global dialing information.
In the Enter phone number box, add the subscriber number for the phone number.

To assign a SIP URI to the phone number, follow these steps:

In the Value To Assign field, click the arrow at the end of the tel: drop-down list and select sip:.
In the Enter SIP URI box, add the SIP URI phone number string.

To assign a secure SIP URI to the phone number, follow these steps:

In the Value To Assign field, click the arrow at the end of the tel: drop-down list and select sips:.
In the Enter SIP URI box, add the secure SIPS URI phone number string.

Note: To set the value using an expression, click the expression modes button and perform one of the following steps:

Add the expression inline.
Click to open the large expression editor and build your expression.

(Optional) To add another Phone Number variable, click next to U pdate Statements.

Add a phone number type

Add a phone number update statement to a task sequence

[NEXT] Was this article helpful?

Loading...

Add a phone number type

Add a phone number update statement to a task sequence

[NEXT] Was this article helpful?