{"_id":"558dbba37afc102f008ed896","parentDoc":null,"project":"558d9c32beb7c719007f6319","user":"558d70614cd25f0d00b7eba4","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5908d1f64f544425002b6aae","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T18:37:42.174Z","from_sync":false,"order":9,"slug":"legacy-documentation","title":"Legacy Documentation"},"githubsync":"","__v":172,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-26T20:52:51.324Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use the Post-Call Action webhook to enable real-time, data collection capabilities for phone calls.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/lVMBAowiQGKJrHtjq6AI_1436842098_Phone.png\",\n        \"1436842098_Phone.png\",\n        \"128\",\n        \"128\",\n        \"#e65e60\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe Post-Call Action webhook allows users to enable real-time, data collection abilities for phone calls, upon call completion. As a result, the user has access to all manner of call-detail information they may find useful.\n\nThe Post-Call Action interface functions to assist the user in generating a fully-qualified web URL. This URL is then filled in with the appropriate, dynamic information that corresponds to the phone call that the user has selected. After which, a \"REST\" API call is launched to the specified web server. This action delivers the desired data in near real-time, as each call completes. The data reported by a Post-Call Action may be simple or complicated. This webhook is a powerful capability that leverages the same, everyday technology used to surf the Internet (e.g. HTTP).\n\nPhone calls may have multiple post-call actions. This adds additional informational capabilities for the webhook that may be useful for the user.\n\nThe Post-Call Action webhook allows users the ability to specify the dynamic parameters in the URL. These parameters act as placeholders for call-specific data. The dynamic parameters are assigned in the Post-Call Action configuration interface from a list that is generated from the **Post-Call Action Option** drop-down menu and based on its values. When a Post-Call Action is executed and before said process is completed, the dynamic parameter values are substituted to include the corresponding pieces of call-specific information. Any number of placeholders may be used and in the desired order.\n\n## Post-Call Action Setup\n\nTo setup the Post-Call Action webhook, follow the instructions below:\n\n1. Click the **Developer Tools** option.\n\n2. Click the **Post Call Actions** option. \n\n3. To create a new Post-Call Action, click the \"Create a new Post-Call Action\" link that can be found towards the bottom left of the screen.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Helpful, Webhook Information\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2nd1CTmIQha0W2IEbnpg_1438822802_Hungup.png\",\n        \"1438822802_Hungup.png\",\n        \"24\",\n        \"24\",\n        \"#fc8464\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Post-Call Actions\",\n  \"sidebar\": true,\n  \"body\": \"A user can have multiple Post-Call Actions. A new Post-Call Action is created by clicking the **Create a New Post-Call Action** option. \"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/IiPqVXGZTcHquPCMnSPg_Screen%20Shot%202015-08-05%20at%2011.22.07%20AM.png\",\n        \"Screen Shot 2015-08-05 at 11.22.07 AM.png\",\n        \"663\",\n        \"365\",\n        \"#977863\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Post-Call Action Configuration\n\nTo configure the Post-Call Action webhook, follow the instructions below:\n\n1. Name the Post-Call Action.\n\n2. Check the **Active** box; it may be disabled, at anytime, by un-checking the checked box.\n\n3. Set the **Submit Type** to GET or POST, as appropriate.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Please Note\",\n  \"body\": \"The **Post-Call Action Option** should be selected for the \\\"Call-Detail Information\\\" option. The **Google Analytics®** option is used to send call information to a users Google Analytics account and is configured separately within the SourceTrak Application.\"\n}\n[/block]\nThe following is an example of the domain portion of the user's server URL: \n\n*http://* or *https://*; *http://www.example.com*\n\nThe **Page** field is the name of the file on the user's server that will be used to process the information submitted via the Post-Call Action. This field may contain sub-folders, if the user's file does not exist at the root level of their web server. For example, if the user's page resides at *http://www.example.com/files/ibp/post_call.php*, the user must enter */files/ibp/post_call.php* in the **Page** field.\n\nStatic parameters are useful to send data or a tokens. For instance, if phone calls in a user account are for a specific client, then the user may include a static parameter, such as *client_id=1234*. This static parameter will be sent along with other, user-requested data. To send more than one static parameter, use \"&\" between each pair: *name1=value1&name2=value2&name3=value3*\n\n## Dynamic Parameters\n\nDynamic parameters store phone-call data that is sent to the user's server. The user has the ability to specify the information desired and label it, according to preference.\n\nTo add a dynamic parameter to a Post-Call Action webhook, follow the instructions below:\n\n1. Click the green button with the plus symbol on the top portion of the **Dynamic Parameters **screen. \n\n2. Select the desired parameter from the drop-down menu.\n\n3. Enter a name for the selected parameter. This name will serve as the parameter key that may be used to access the parameter, when data is transmitted to the user's web server.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/CauYOH8TTESUyj7YJfmb_Screen%20Shot%202015-08-05%20at%2011.24.12%20AM.png\",\n        \"Screen Shot 2015-08-05 at 11.24.12 AM.png\",\n        \"606\",\n        \"91\",\n        \"#a68168\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n4. There is an example URL below the parameters that shows how the URL that gets submitted to the web server will look like. Click the link to test the Post-Call Action.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Dynamic Parameters\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Example URL:** \\n\\nThe example shown below, using the Date/Time and Caller ID parameters, illustrates what the corresponding URL for those parameters looks like. \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3duIvv1UQzmlDaIGxAOn_Screen%20Shot%202015-08-05%20at%2011.26.51%20AM.png\",\n        \"Screen Shot 2015-08-05 at 11.26.51 AM.png\",\n        \"453\",\n        \"127\",\n        \"#242e63\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n5. When the phone call completes, the data for the selected parameters for that call will be sent automatically to the user-specified URL.\n\nThe dynamic parameters are described in the table below.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"DYNAMIC PARAMETER\",\n    \"h-1\": \"DESCRIPTION\",\n    \"23-0\": \"SID\",\n    \"23-1\": \"Session ID (SID) refers to the unique, session ID for a phone call.\",\n    \"24-1\": \"The total minutes used during the duration of a phone call.\",\n    \"24-0\": \"Talk Minutes\",\n    \"0-0\": \"All Actions\",\n    \"0-1\": \"The list of all actions taken by a caller or call recipient.\",\n    \"9-0\": \"First Action\",\n    \"9-1\": \"The first action type to handle the call, such as a Virtual Receptionist.\",\n    \"3-0\": \"Call Type\",\n    \"3-1\": \"The type description of phone call, such as inbound, outbound, click-to, etcetera.\",\n    \"7-0\": \"Date/Time\",\n    \"7-1\": \"The date and time information for the start of a phone call.\",\n    \"6-0\": \"Click ID\",\n    \"6-1\": \"The ID of the Click-to-Call that initiated the call.\",\n    \"4-0\": \"Called Number\",\n    \"4-1\": \"The local or toll-free phone dialed to initiate the call.\",\n    \"5-0\": \"Caller ID\",\n    \"5-1\": \"The phone number of the person who called.\",\n    \"11-0\": \"Last Action\",\n    \"11-1\": \"The last action taken on a phone call.\",\n    \"10-1\": \"The time spent with the Find Me or Virtual Receptionist features, while waiting for the call to connect.\",\n    \"10-0\": \"Intelligent Minutes\",\n    \"8-0\": \"Enhanced Minutes\",\n    \"8-1\": \"The talk minutes for a recorded phone call.\",\n    \"2-1\": \"The length of the call in minutes.\",\n    \"2-0\": \"Call Duration\",\n    \"12-0\": \"*Lookup - City\",\n    \"12-1\": \"The city information captured by the Reverse-Lookup service.\",\n    \"13-1\": \"The first name information captured by the Reverse-Lookup service for the caller.\",\n    \"13-0\": \"*Lookup - First Name\",\n    \"14-1\": \"The last name information captured by Reverse-Lookup service for the caller.\",\n    \"14-0\": \"*Lookup - Last Name\",\n    \"15-1\": \"The state information captured by Reverse-Lookup service.\",\n    \"15-0\": \"*Lookup - State\",\n    \"16-1\": \"The street address information captured by Reverse-Lookup service.\",\n    \"16-0\": \"*Lookup - Street Address\",\n    \"17-0\": \"*Lookup - ZIP Code\",\n    \"17-1\": \"The zip code information captured by Reverse-Lookup service.\",\n    \"18-1\": \"The text-string label configured for a phone number within the Phone Routing option.\",\n    \"18-0\": \"Phone Label\",\n    \"19-1\": \"The duration of a call recording.\",\n    \"19-0\": \"Recording Duration (seconds)\",\n    \"20-1\": \"Enhanced minutes that are rounded up to the nearest, whole minute.\",\n    \"20-0\": \"Rounded Enhanced Minutes\",\n    \"21-1\": \"Intelligent minutes that are rounded up to the nearest, whole minute.\",\n    \"21-0\": \"Rounded Intelligent Minutes\",\n    \"22-0\": \"Rounded Talk Minutes\",\n    \"22-1\": \"Talk minutes that are rounded up to the nearest, whole minute.\",\n    \"25-1\": \"The transfer type for a phone call. For example, if the call is transferred using Virtual Receptionist, Click-to-XYZ, etcetera.\",\n    \"25-0\": \"Transfer Type\",\n    \"26-0\": \"Transferred to Number\",\n    \"26-1\": \"The phone number to which a call is transferred.\",\n    \"1-0\": \"Click Description\",\n    \"1-1\": \"The description of the Click-to-Call that initiated the call if applicable.\"\n  },\n  \"cols\": 2,\n  \"rows\": 27\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Please Note\",\n  \"body\": \"The **Value** option is only available when the Reverse-Lookup Service feature is enabled.\"\n}\n[/block]\n## Include SourceTrak Information\n\nIf the **Include SourceTrak Information** option is enabled using SEO or PPC pools, additional parameters become available to the user in the Post-Call Action (Does not apply to one-to-one calls). Also, all available SourceTrak parameters become included in the Post-Call Action request.\n\nThe SourceTrak parameters are described in the table below.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"SOURCETRACK PARAMETER\",\n    \"h-1\": \"DESCRIPTION\",\n    \"17-1\": \"A general confidence indicator (on the scale of 1-5) of how a phone call is matched to a source; a lower rank indicates a higher confidence.\",\n    \"17-0\": \"st_rank\",\n    \"19-1\": \"The literal search string or keywords that result in the display of a phone number on a user's website.\",\n    \"19-0\": \"st_search_term\",\n    \"18-1\": \"The referring domain, which results in the display of a phone number on a user's website.\",\n    \"18-0\": \"st_referrer\",\n    \"0-1\": \"The SourceTrak pool activity that triggered the number display on the website.\",\n    \"0-0\": \"st_activity_keyword\",\n    \"1-1\": \"The landing page of a user's website, where the SourceTrak phone number is initially displayed.\",\n    \"1-0\": \"st_baseuri\",\n    \"4-0\": \"st_displayed_timestamp\",\n    \"4-1\": \"The date and time (EST) that the SourceTrak phone number is first displayed on the user's website.\",\n    \"5-1\": \"The title of the initial page view, during a SourceTrak session.\",\n    \"5-0\": \"st_document_title\",\n    \"11-1\": \"The IP address of the visitor during a SourceTrak session.\",\n    \"11-0\": \"st_ip_address\",\n    \"2-1\": \"The web browser used during a SourceTrak session.\",\n    \"2-0\": \"st_browser\",\n    \"3-1\": \"The ad campaign captured by a SourceTrak session or a default value set in the SourceTrak configuration.\",\n    \"3-0\": \"st_campaign\",\n    \"6-1\": \"The ID of the SourceTrak Domain Set for the phone number called.\",\n    \"6-0\": \"st_domain_set_id\",\n    \"21-1\": \"The PPC ad or URL parameter that triggered to the phone call.\",\n    \"21-0\": \"st_url_tag\",\n    \"20-0\": \"st_sourceguard\",\n    \"20-1\": \"An indicator that determines if a phone call was made to a SourceGuard number.\",\n    \"9-1\": \"The optional, custom value passed into SourceTrak.\",\n    \"10-1\": \"The optional, unique ID value passed into SourceTrak.\",\n    \"10-0\": \"st_ibp_unique_id\",\n    \"9-0\": \"st_ibp_custom\",\n    \"15-1\": \"The Ad Platform captured by a SourceTrak session or a default value set in the SourceTrak configuration.\",\n    \"15-0\": \"st_platform\",\n    \"16-1\": \"The SourceTrak pool name for the phone number called.\",\n    \"16-0\": \"st_pool_name\",\n    \"13-1\": \"The operating system used during a SourceTrak session.\",\n    \"13-0\": \"st_os\",\n    \"14-1\": \"The unique identifier for a SourceTrak session.\",\n    \"14-0\": \"st_pid\",\n    \"7-1\": \"The Google Click ID (Gclid) captured from a Google Adwords visit.\",\n    \"7-0\": \"st_gclid\",\n    \"8-1\": \"The Google Universal Analytics Client ID captured during a SourceTrak session.\",\n    \"8-0\": \"st_google_ua_client_id\",\n    \"12-1\": \"The name of the location that received the call when multiple numbers are displayed on a page via SourceTrak.\",\n    \"12-0\": \"st_location_name\"\n  },\n  \"cols\": 2,\n  \"rows\": 22\n}\n[/block]","excerpt":"","slug":"post-call-action","type":"basic","title":"POST-CALL ACTION"}

Use the Post-Call Action webhook to enable real-time, data collection capabilities for phone calls.

The Post-Call Action webhook allows users to enable real-time, data collection abilities for phone calls, upon call completion. As a result, the user has access to all manner of call-detail information they may find useful.

The Post-Call Action interface functions to assist the user in generating a fully-qualified web URL. This URL is then filled in with the appropriate, dynamic information that corresponds to the phone call that the user has selected. After which, a "REST" API call is launched to the specified web server. This action delivers the desired data in near real-time, as each call completes. The data reported by a Post-Call Action may be simple or complicated. This webhook is a powerful capability that leverages the same, everyday technology used to surf the Internet (e.g. HTTP).

Phone calls may have multiple post-call actions. This adds additional informational capabilities for the webhook that may be useful for the user.

The Post-Call Action webhook allows users the ability to specify the dynamic parameters in the URL. These parameters act as placeholders for call-specific data. The dynamic parameters are assigned in the Post-Call Action configuration interface from a list that is generated from the Post-Call Action Option drop-down menu and based on its values. When a Post-Call Action is executed and before said process is completed, the dynamic parameter values are substituted to include the corresponding pieces of call-specific information. Any number of placeholders may be used and in the desired order.

Post-Call Action Setup

To setup the Post-Call Action webhook, follow the instructions below:

  1. Click the Developer Tools option.

  2. Click the Post Call Actions option.

  3. To create a new Post-Call Action, click the "Create a new Post-Call Action" link that can be found towards the bottom left of the screen.

Helpful, Webhook Information

Post-Call Actions

A user can have multiple Post-Call Actions. A new Post-Call Action is created by clicking the Create a New Post-Call Action option.

Post-Call Action Configuration

To configure the Post-Call Action webhook, follow the instructions below:

  1. Name the Post-Call Action.

  2. Check the Active box; it may be disabled, at anytime, by un-checking the checked box.

  3. Set the Submit Type to GET or POST, as appropriate.

Please Note

The Post-Call Action Option should be selected for the "Call-Detail Information" option. The Google Analytics® option is used to send call information to a users Google Analytics account and is configured separately within the SourceTrak Application.

The following is an example of the domain portion of the user's server URL:

http:// or https://; http://www.example.com

The Page field is the name of the file on the user's server that will be used to process the information submitted via the Post-Call Action. This field may contain sub-folders, if the user's file does not exist at the root level of their web server. For example, if the user's page resides at http://www.example.com/files/ibp/post_call.php, the user must enter /files/ibp/post_call.php in the Page field.

Static parameters are useful to send data or a tokens. For instance, if phone calls in a user account are for a specific client, then the user may include a static parameter, such as client_id=1234. This static parameter will be sent along with other, user-requested data. To send more than one static parameter, use "&" between each pair: name1=value1&name2=value2&name3=value3

Dynamic Parameters

Dynamic parameters store phone-call data that is sent to the user's server. The user has the ability to specify the information desired and label it, according to preference.

To add a dynamic parameter to a Post-Call Action webhook, follow the instructions below:

  1. Click the green button with the plus symbol on the top portion of the Dynamic Parameters screen.

  2. Select the desired parameter from the drop-down menu.

  3. Enter a name for the selected parameter. This name will serve as the parameter key that may be used to access the parameter, when data is transmitted to the user's web server.

  1. There is an example URL below the parameters that shows how the URL that gets submitted to the web server will look like. Click the link to test the Post-Call Action.

Dynamic Parameters

Example URL:

The example shown below, using the Date/Time and Caller ID parameters, illustrates what the corresponding URL for those parameters looks like.

  1. When the phone call completes, the data for the selected parameters for that call will be sent automatically to the user-specified URL.

The dynamic parameters are described in the table below.

DYNAMIC PARAMETER
DESCRIPTION

All Actions

The list of all actions taken by a caller or call recipient.

Click Description

The description of the Click-to-Call that initiated the call if applicable.

Call Duration

The length of the call in minutes.

Call Type

The type description of phone call, such as inbound, outbound, click-to, etcetera.

Called Number

The local or toll-free phone dialed to initiate the call.

Caller ID

The phone number of the person who called.

Click ID

The ID of the Click-to-Call that initiated the call.

Date/Time

The date and time information for the start of a phone call.

Enhanced Minutes

The talk minutes for a recorded phone call.

First Action

The first action type to handle the call, such as a Virtual Receptionist.

Intelligent Minutes

The time spent with the Find Me or Virtual Receptionist features, while waiting for the call to connect.

Last Action

The last action taken on a phone call.

*Lookup - City

The city information captured by the Reverse-Lookup service.

*Lookup - First Name

The first name information captured by the Reverse-Lookup service for the caller.

*Lookup - Last Name

The last name information captured by Reverse-Lookup service for the caller.

*Lookup - State

The state information captured by Reverse-Lookup service.

*Lookup - Street Address

The street address information captured by Reverse-Lookup service.

*Lookup - ZIP Code

The zip code information captured by Reverse-Lookup service.

Phone Label

The text-string label configured for a phone number within the Phone Routing option.

Recording Duration (seconds)

The duration of a call recording.

Rounded Enhanced Minutes

Enhanced minutes that are rounded up to the nearest, whole minute.

Rounded Intelligent Minutes

Intelligent minutes that are rounded up to the nearest, whole minute.

Rounded Talk Minutes

Talk minutes that are rounded up to the nearest, whole minute.

SID

Session ID (SID) refers to the unique, session ID for a phone call.

Talk Minutes

The total minutes used during the duration of a phone call.

Transfer Type

The transfer type for a phone call. For example, if the call is transferred using Virtual Receptionist, Click-to-XYZ, etcetera.

Transferred to Number

The phone number to which a call is transferred.

Please Note

The Value option is only available when the Reverse-Lookup Service feature is enabled.

Include SourceTrak Information

If the Include SourceTrak Information option is enabled using SEO or PPC pools, additional parameters become available to the user in the Post-Call Action (Does not apply to one-to-one calls). Also, all available SourceTrak parameters become included in the Post-Call Action request.

The SourceTrak parameters are described in the table below.

SOURCETRACK PARAMETER
DESCRIPTION

st_activity_keyword

The SourceTrak pool activity that triggered the number display on the website.

st_baseuri

The landing page of a user's website, where the SourceTrak phone number is initially displayed.

st_browser

The web browser used during a SourceTrak session.

st_campaign

The ad campaign captured by a SourceTrak session or a default value set in the SourceTrak configuration.

st_displayed_timestamp

The date and time (EST) that the SourceTrak phone number is first displayed on the user's website.

st_document_title

The title of the initial page view, during a SourceTrak session.

st_domain_set_id

The ID of the SourceTrak Domain Set for the phone number called.

st_gclid

The Google Click ID (Gclid) captured from a Google Adwords visit.

st_google_ua_client_id

The Google Universal Analytics Client ID captured during a SourceTrak session.

st_ibp_custom

The optional, custom value passed into SourceTrak.

st_ibp_unique_id

The optional, unique ID value passed into SourceTrak.

st_ip_address

The IP address of the visitor during a SourceTrak session.

st_location_name

The name of the location that received the call when multiple numbers are displayed on a page via SourceTrak.

st_os

The operating system used during a SourceTrak session.

st_pid

The unique identifier for a SourceTrak session.

st_platform

The Ad Platform captured by a SourceTrak session or a default value set in the SourceTrak configuration.

st_pool_name

The SourceTrak pool name for the phone number called.

st_rank

A general confidence indicator (on the scale of 1-5) of how a phone call is matched to a source; a lower rank indicates a higher confidence.

st_referrer

The referring domain, which results in the display of a phone number on a user's website.

st_search_term

The literal search string or keywords that result in the display of a phone number on a user's website.

st_sourceguard

An indicator that determines if a phone call was made to a SourceGuard number.

st_url_tag

The PPC ad or URL parameter that triggered to the phone call.