Telnyx Phone Lookup
This flow step uses the Telnyx Number Lookup API to capture the details behind a phone number. You can use it to make each call more productive, reduce undelivered messages, and protect from spam and fraud.
1 -
Validate phone with Telynx
Add Choice
Flow Step Fields
These fields are set for each individual instance of the Validate phone with Telynx flow step and are sent per-lead when it is called.
| Name | API Name | Type | Description |
|---|---|---|---|
| Phone number | phone | string | Phone number |
| Lookup Type | lookup_type | string | Lookup Type |
Installing a custom flow step requires Admin permissions in Marketo. Apart from the Installation URL, all other aspects of a serviced may be edited after completing initial onboarding by drilling down into the service detail screen from the Service Providers grid.
In Marketo navigate to Admin → Service Providers and click Add New Service
From here, follow the bellow steps to install and configure the flow step.
Flow Step Service
Confirm installation
To begin installation, you’ll need to first enter the install URL of the Validate phone with Telynx flow step shown above. This URL gives Marketo the basic information it needs to connect to and configure the flow step.
Flow Step Service
Enter Credentials
Please provide an API Key. Valid API credentials from Flowsteps.io are required to complete installation.
After you enter the installation URL you will be asked to enter your API Key. When you save your credentials, Marketo will attempt to verify that it is valid. If the credentials provided are invalid, you’ll see an error indicating this.
Flow Step Service
Map Incoming Fields
Configuration Options
Approve Contexts & Finish
Flowsteps.io has provided a list of response mappings to map to Marketo Lead fields. Fields which are mapped and active may be written to by Flowsteps.io, when processing of Validate phone with Telynx is complete. Response Mappings are not required to complete service installation, but the service may not function as expected if mappings are not provided.
| Active | External Field | Type | Description | Marketo Field |
|---|---|---|---|---|
|
|
country_code | string | Region code that matches the specific country calling code |
country_code
|
|
|
national_format | string | Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found |
national_format
|
|
|
phone_number | string | E164-formatted phone number |
phone_number
|
|
|
valid_number | boolean | Is the number valid? |
valid_number
|
|
|
caller_name | string | Caller name if retrieved |
caller_name
|
|
|
carrier_name | string | Carrier name if retrieved |
carrier_name
|
The Validate phone with Telynx flow step uses set inbound fields. Below are the fields that are returned from the flow step and can be written to the person based on the mapping you set.
Flow Step Service
Map Incoming Fields
Configuration Options
Approve Contexts & Finish
Flowsteps.io has provided a list of required and optional configuration settings. These settings will be used globally by Validate phone with Telynx.
Global user inputs that are passed along with every call to the Validate phone with Telynx flow step service. Global attributes can be set during installation or updated from the Service Provider admin menu.
Flow Step Service
Map Incoming Fields
Configuration Options
Approve Contexts & Finish
Flowsteps.io is requesting access to the following data contexts. When Validate phone with Telynx is invoked from a Smart Campaign, the data from these objects will be sent as contextual information to Flowsteps.io, such that processing may be completed.
Subscription
Program
Program Member
Smart Campaign
Trigger
My Tokens
Finally review the context data that will be sent to the to Validate phone with Telynx flow step, and approve.
Outbound Fields
The Validate phone with Telynx flow step does not use outbound fields.
Inbound Fields
The Validate phone with Telynx flow step uses set inbound fields. Below are the fields that are returned from the flow step and can be written to the person based on the mapping you set.
| Name | Suggested Marketo Field | Description |
|---|---|---|
| country_code | country_code | Region code that matches the specific country calling code |
| national_format | national_format | Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found |
| phone_number | phone_number | E164-formatted phone number |
| valid_number | valid_number | Is the number valid? |
| caller_name | caller_name | Caller name if retrieved |
| carrier_name | carrier_name | Carrier name if retrieved |
Global Configuration Fields
Global user inputs that are passed along with every call to the Validate phone with Telynx flow step service. Global attributes can be set during installation or updated from the Service Provider admin menu.
| Name | API Name | Type | Description |
|---|---|---|---|
| Telynx API Key | api_key | string | Your Telynx API Key |
Flow Step Fields
These fields are set for each individual instance of the Validate phone with Telynx flow step and are sent per-lead when it is called.
| Name | API Name | Type | Description |
|---|---|---|---|
| Phone number | phone | string | Phone number |
| Lookup Type | lookup_type | string | Lookup Type |
Context Data
| Name | Description |
|---|---|
| Program Context | Data about the program where the flow step was triggered including name, id, type, workspace etc. |
| Campaign Context | Data about the campaign where the flow step was triggered, including name, id, type, status, etc. |
| Trigger Context | Context around the trigger that initiated the smart campaign where the flow step was called. No data is sent if the flow step was called in a batch campaign. |
| Subscription Context | General data about the subscription including munchkinId and name |
Flow Step
Once the Telnyx Phone Lookup flow step is installed it becomes available in smart campaigns. In the phone number field enter the number you want to lookup. Here you can use Marketo tokens like {{lead.Phone Number}} or {{lead.Mobile Phone Number}}.
In the Lookup Type field you can select Caller,Carrier,Both or None to choose what level of data will be returned. You can find more information on the Telnyx Number Lookup reference page
1 -
Validate phone with Telynx
Add Choice
Flow Step Fields
These fields are set for each individual instance of the Validate phone with Telynx flow step and are sent per-lead when it is called.
| Name | API Name | Type | Description |
|---|---|---|---|
| Phone number | phone | string | Phone number |
| Lookup Type | lookup_type | string | Lookup Type |
Trigger & Filter
Once the Telnyx Phone Lookup flow step is in use the activity can be used as a trigger or a filter inside smart lists and smart campaigns.
Phone is validated with Telynx
1 - Phone was validated with Telynx