callrail submit ticket

Can be either. A limited number of attributes are available in the query string because of the legacy version of our API. The lead status that will activate the integration trigger. Whether or not the notifications will be sent via email. Date interpretation according to the table below will be done according to the specified or default time zone. See an additional list of Time Zones in the Getting Started section. See, Whether or not the company has CallScore enabled. This endpoint returns a single user object in the target account. You can use the API to create form submissions for a given company. The name of the Custom Form responsible for the form capture, where applicable. "config": { The date and time the user was created in UTC (ISO 8601 format). A value of "direct" indicates that this tracking number will be served to web You can use the Updating a Tag endpoint to disable the tag from being applied to new interactions without removing it from any interactions it was previously applied to. google_paid. Indicates whether or not this tracker can support text messages. To remove a user from one or more companies, only include company IDs the user should be able to access. Unique identifier for a specific form submission. "email": "gene@example.com", Within CallRail, accounts are the top level object. Because the pre-call webhook executes before the call is connected, it contains less information than the post-call webhook. An advanced call flow may have multiple steps This object has keys for at least one of. This endpoint returns a paginated array of all the integration triggers and their associated integrations. To change the scope or user, delete the record and create a new one. After a successful request to this endpoint, the specified phone number will ring and prompt for a code to be entered in order to verify the phone number. CallRail does not resend webhooks, so missing calls might be your first indication of a problem. When updating a form submission, the following fields may be included in the request body. when retrieving Trackers with Advanced Call Flows the format described below will Indicates the traffic source assigned for this tracking number. "bing": ["paid", "organic"], At this time, only touch tone responses via the callers phone keypad are able to interact with a Call Flow. The name of the company the source belongs to. }. * This method may be required if your site is a single-page application Whether or not the account is a HIPAA account. The users. An ID indicating which company the message belongs to. The app will attempt to parse out any phone numbers in the form data, and use that phone number to create or find a customer to associate with the form submission. If the whisper message contains. Note that only Administrator users can manage summary emails for other users. * an expected display format for your locale. Retrieve aggregate call data for an account or company, grouped by date. A value of "landing_params" indicates that online visitors who first land on a page with This endpoint returns a single account object scoped to the provided API key. Note that this can also be used as a catch-all setting. The customers name, as reported by Caller ID. If a DOM node is provided as the parameter, the scope will be limited to that node and As such, the call_type field will be set to "outbound". This endpoint disables an Integration object in the target company. Not Found The server did not find the target resource or endpoint. API requests to manage other users passwords will result in an error. Total number of calls that were from first time callers in summary date range. If provided, only return calls to this specific tracking number. The link returned does not expire in 24 hours but this does not guarantee the link will be good forever. This field does not assign the notification to the agent. "swap_targets": ["7705551234", "7705554567"], When creating or updating an integration via the API, you should provide the appropriate configuration format for that integration type. An array of types of Yahoo Search to be handled by this tracker. See. }', '{ ex. These users cannot create or modify tracking numbers or other settings. See the Terminology section for more info about source trackers. Must be a valid 10 digit US or Canadian number. The call routing complete webhook executes the moment an inbound phone call has been routed to its destination. Specify results that match a specific Lead Status. This endpoint updates a tag object in the target account. }, Instead, you should make a request to this endpoint whenever you need to obtain current location of this MP3. For notification records configured for calls, the alerts can be further filtered by type of call. When enabled, alert_type becomes required. When successful, the HTTP response code will indicate 201 CREATED. Tags can also be applied in the following ways: See our Call Flow feature and Tag Step for more information. The string id of the company the call belongs to. Each notification record is set for a specific user, and is limited to either a specific tracker, all trackers in a company, or all trackers in the target account. If you disable a company all the tracking phone numbers will be disabled and the swap.js script will be deactivated. If provided, the time of the call that was originally scored as a good lead. Code can be found here. The response is a JSON structured object containing message details, and may include the two most recent messages for an existing conversation. "lead_status": "good_lead", Administrators may access records for all users on the account, but other user types may only access their own records. This Summary Data response field is available by default. An object containing specific information about the configuration for the integration. The above command creates a single outbound text message that can be part of an existing conversation or the start of a new conversation. If provided, only the caller IDs to belonging to this company will be returned. *recent is the default view in the CallRail UI, and is the API default when no other date range parameters are specified. This URL redirects to the actual audio file of the recording in MP3 format. Specifies whether or not to record the call being created. The users permission within this CallRail account. Array of tag names to associate with this call. The Tag Color object represents the color and background color of the tag to be created. 123456789. it may be necessary to manually trigger form submissions. It is intended for developers and customers looking to integrate custom software directly with CallRail. }', '{ "destination_number": "+15553104554", Unique identifier for the company associated with the tag. If it is included Grapher is intended for anyone who wants to see an example of how to consume CallRails API. The date and time the text was created in UTC, in ISO 8601 format. "name": "My Website Tracker", "call_flow": { The CallRail REST API provides a method to programmatically access and modify the data within your CallRail account. Request any phone number in the 303 area code. An array of types of Bing Search to be handled by this tracker. If your computed signature matches the header that CallRail sends, the request is valid! Similarly, anyone who has your API key can use that key to access or modify any data you have control over. Also note that if no suitable replacements are found, some values from the queried number list may "lead_status": null, No formatting is required, as the script will search for all possible formats. Grouping by company is only available when using the account-level endpoint. See. It can be configured for either a specific company (when company_id is present), or for all companies to which the user has access (account_id is used when company_id is absent). The Updating a Call endpoint has been enhanced to allow for edits to Customer Name, and setting Spam status to true to mark a call as spam. The contents of the form submission, broken down by form field. gclid and fbclid fields will return the most value associated with the call, even if the first touch milestone is a source other than Google Ads or Facebook Ads. Request a toll free number in the 888 area code. The CallRail API returns standard HTTP success or error status codes. "lead_status": "Not a Lead" This endpoint returns a paginated array of tags within the target account. "form_data": { Server time when the form was submitted. The full name of the user formatted for display. If provided, only return calls that have had the given tag applied. There are four types of webhooks for calls: Additionally, there are webhooks for Text Messages and Form Submissions. This webhook sends the call object in the POST body, formatted as JSON as specified in the call endpoint. "content": "These are not the droids you are looking for. We also provide an option to show non-CallRail tracking numbers for caller ID. If youre an administrator for your CallRail account, you can create a set of tags that apply to every single company in your account. "role": "reporting", created_at: NOTE this field will be deprecated as a sortable field in the future. Session Trackers can also be used to only track visitors from specific search before arriving via search engine, and their browsing history on your site. The user ID of the agent to be assigned to the call. If. An array that can include any value of daily, weekly, or monthly. Text message webhooks send after a text message is received by one of your tracking numbers. These are most useful when you wish to be notified automatically when something happens, rather than having to poll the API. An outbound call modified webhook is sent when an outbound call has changed after it has ended. (daily, weekly, or monthly). "recording_enabled": false, *Note that this returned list is a formatting example only; it is not a full representation of the returned results for a full 24 hour data set. This endpoint creates a single Outbound Caller ID object within the target company. The domain that referred the caller to your website, available for calls placed to Website (Session) trackers. Source Type - The online or offline source the tracking number(s) is configured to track. "note": "Call customer back tomorrow", The name or the customer, formatted for display. "filters": { One of all, first_call, missed_and_vm, vm_only. If provided, only return summary email records configured for the specified email-only user. The url of the referring source or website the caller was previously viewing. associated with this tracker. "recording_enabled": true, The name of the tracking number within CallRail. Code needed to verify ownership of the phone number to be used with the Outbound Caller ID feature. Request a toll free number in any area code. Call modified webhooks are sent when a call has changed after its ended. This endpoint disables an Tracker object in the target company. engines, or based on other attributes from the referring URL or landing page. Lead status can be one of Lead, 'Not a Lead, 'Not Scored, or 'All. Passwords can only be managed for the user associated with the API Key used in the request. For more information, please refer to our support documentation. The current lead status for the form submission. updating a Source Tracker or Session Tracker. This endpoint supports Pagination and Filtering. They can make notes on calls, listen to recorded calls, and tag and score calls. /v3/a/{account_id}/form_submissions/ignored_fields.json, List of integer company ids to configure the ignored fields for. Unique alphanumeric identifier for the text message. Note: The customers phone number this message will be delivered to. The token is used with the request payload to generate a hash signature that is passed as a request header in the webhook request. * the modified element, but if the parameter is omitted the entire To request access, please Submit a Ticket. Because the underlying file may move in the future, the permanent reference to this recording is this API endpoint itself. "destination_number": "+14044554321", Youve made your first request against the CallRail API. "name": "Website Call Tracker", arrived on the page from a given search engine and search type. If no 888 numbers The tracking phone Type of tracker to create. This notification is limited to this specific tracker. If a CSS selector is provided as the parameter, any matching nodes and their children will be These tags can only be created and edited by administrators since these tag settings apply to all companies. ", "Take these two over to the garage, will you? "external_form_capture": true multiple visitors simultaneously, and as such cannot be used to capture This endpoint creates a source tracker in the target company. Indicates whether the company is currently active or disabled. Email address for the user who answered the call, when applicable. CallRails Form Tracking product will automatically exclude sensitive information, and we dont capture or store The name or phone number of the customer as reported by Caller ID, formatted for display. Whether or not notifications will be sent via mobile push notification. Indicates whether the form has a monetary value associated with it. "pre_call_webhook": ["http://example.com/webhook.php"] Total number of paginated messages returned in each page. is available in 404, the Tracker will not be created and an error will be returned. Accepts a Company ID. A company in CallRail is a separate entity within your account. This Call Summary data can be limited to a specific date range, can be filtered based on a variety of criteria, and can be grouped by source, keywords, campaign, referrer, landing_page, or company. If no inventory { error: 'You must have at least one active company.' Example: [https://example.com/pre-call.php, http://zapier.com/zaps/123]. If no "yahoo": ["paid", "organic"] For larger time spans (for example: longer than 3 months), it is recommended to specify a larger interval such as week, month, or year. The name of the customer, formatted for display. Must be between 4 and 50. An integer representing seconds should be passed. A list of telephone numbers configured to dynamically replace with a tracking number. but is null or a blank string, the field will be cleared. Timestamp of when the form was submitted. "type": "basic", All attributes are available in the JSON POST body, which is the recommended format for any new development. }', '{ All requests to all API endpoints require an API key to be provided. }. If not specified, this notification is not limited by tracker. Select data from the previous 7 days, not including the current date, Select data from the previous 30 days, not including the current date, Select data from the current month, including the current date, Select data from the this year up to and including the current date, Select all data, including the current date. The name of the tag formatted for display. The URL the caller first landed on, available for calls placed to Website (Session) trackers. The callback function is supplied with one parameter, which is an object with keys representing Total number of calls that were answered in summary date range. This is typically your primary business phone number. Below are the events that are currently available to trigger a webhook. These values are used for simple string matching and are most commonly used as a list of domain names to match. "area_code": "555", Behavior may also vary across browsers. Unique identifier for the tracking number used most recently in the conversation. Conversations are ordered by their most recent message and the newest conversations are returned first. This webhook sends information gathered from the form submission, including all recognized form fields. See. Contains the URLs of two images representing the volume of the call over time. This can be overridden for specified API requests by including a time_zone parameter. For marketing attribution data like Source, Medium, Campaign, Referrer, and Landing Page data, this will represent the leads first touch milestone. If the parameter is omitted, processing starts at document.body. Numbers provided as a parameter are appended to The tracking number will The URL that referred the caller to your website, available for calls placed to Website (Session) trackers. Only records that the authenticated user has access to will be returned. * We can invoke CallTrk.swap() manually to attempt a swap. "form_submission": { "call_log": true The phone number should be local to another phone number (for example, your main business number). The 2-character abbreviation for the customers state, based on the original assigned location of their phone number. If provided, only include summary data for calls under the specified duration. The number of records being returned per page. A value of "search" indicates that this number should be served to visitors who An object that indicates which sections are included in this summary email. A simple way to learn the CallRail API is to make an API request with Postman, a powerful HTTP client to help easily test web services. supported by jQuery selectors. This parameter can be provided as one or more comma-separated values. The fields listed below will be included in the paginated JSON response for endpoints that return a collection of objects. The phone number belonging to the business that is initially connected to the call before dialing the customer. This endpoint supports Pagination, Sorting, Filtering, Field Selection, and Searching. The count of phone numbers to allocate to this pool. The name of the call source formatted for display. This endpoint lists all summary emails visible to this user. If your application exceeds the rate limit, all endpoints will return the HTTP 429 response code. We wont return the page views that occurred after the call took place. To assign a color to a Tag, youll select one of the color names from the table below to set as the value of the color object. "color": "gray1" "bing": ["paid", "local"] "min_duration": 10 Provide data before provided date and time. }', "Thank you for your support call. Sorting is always either alphabetical, or reverse chronological (newest first). Note that swap.js does not depend on jQuery, and therefore the selector is used via number will not be served to any web traffic. They can add companies, users, and tracking numbers. Possible values are paid and organic. } Average duration of all calls in summary criteria range, formatted. Selects the type of call that triggers this notification. "pool_numbers": { Timestamp of when the text was sent with Time Zone offset. An optional default integration trigger can be defined for a company. Filtering is available for the following categories: company_id: any valid company id for which you have access, person_lead: set this to true to return only form submissions that have a lead associated with them. For example, you can create a call tag named Sales Call to be applied when a caller presses option 1 to speak to Sales. The date and time the call was created in the current timezone (ISO 8601 format) with an offset. "external_form_capture": true Unique identifier for the person associated with the form submission. Limit response to users belonging to a single company. Call modified webhooks send the call object in the POST body, formatted as JSON as specified in the call endpoint. This field accepts an array of cookie names. Ensures results contain integrations belonging to a single company. If provided, only return summary email records configured for the specified frequency. This field is returned for compatibility purposes but has no effect. Your server will receive the call information before the call is connected, allowing you to develop real-time systems for your representatives, such as screen-pops or CRM database lookups. The CallRail API adheres to REST architectural principles. Company integration data collected for a given call, available for calls placed to Website (Session) trackers. While most users will not need to do anything beyond installing swap.js on their website, CallRails Dynamic Number Insertion script provides a set of options and methods which might be useful to those with advanced use cases. The above command does not return any response data. Once an account has been created, companies can then be created within a given account and relevant actions like creating tracking numbers and adding users can then be accomplished. A descriptive name for the Outbound Caller ID being created. To retrieve this information, you should have Form Tracking active. ex. The total number of objects that fit your query parameters. This endpoint supports Pagination, Filtering, Searching and Field Selection. The email address associated with this user. The type of integration represented by the object. */, /* At this point, the element is in the DOM and on the page, but the Finally, each record indicates one or more notification channels: email, push notifications to mobile devices, or browser-based desktop notifications. "whisper_message": "Call from My Billboard" Because the call routing complete webhook executes before the call is completed, it contains less information than the post-call webhook. v3/a/{account_id}/text-messages/{conversation_id}.json. The business tracking phone number for this call (in E.164 format). Our company-specific dynamic number insertion script displays tracking numbers based on the source type of the tracker in question. Date interpretation will be done according to the specified or default time zone. The date and time the text was received or sent in UTC, in ISO 8601 format. Can be one of daily, weekly, or monthly. Each endpoint will describe the possible fields for selection. A value of "offline" means that this Source Tracker is associated with an Boolean denoting whether or not this is the first form submitted by this visitor. "field_names": ["field_1", "field_2"] A JSON object containing total counts of requested time series data. Source Tracker - Source trackers associate a single tracking number to a certain set of your customers based on how they found the number. visitors who visit the page directly, without being referred from another site. tags: This parameter can be provided as tags=A for a single tag, or tags[]=A&tags[]=B to return calls tagged with either tag A or tag B. Searching is available for the following fields: This endpoint returns a single call object associated with the target account. Call Flows allow for custom prompts and dynamic call routing to take place on a per call basis. "whisper_message": "Call from [source]", The integration trigger is associated with the integration with this unique id. are available, the Tracker will not be created and an error will be returned. They can listen to recorded calls if they receive an email about the call. You can also create and configure a webhook through CallRails API. To obtain all calls on a specific date, specify the same date for both start_date and end_date. Service Unavailable The CallRail API is temporarily offline for maintenance, or the server is overloaded. This can happen This endpoint returns a paginated array of all companies associated with the target account. }', "//cdn.callrail.com/companies/279054151/a74c824140d67442debd/12/swap.js", '{ A descriptive name of the Caller ID formatted for display. Advanced Call Flows must be configured only within the CallRail web application. ", JSON array of text messages returned by the query (fields described in table below). This endpoint returns a single company object associated with the target account. If the authorized user tries to unsubscribe from a summary email that they dont have permission to access, the server will return code 403 Forbidden with the following error message: The above command returns a JSON structured object that includes a paginated list of all text message conversations for a given account. "append_tags": true "tags": ["New Client"], its children. Cookie duration length in number of days (30, 60, 90, or 365.) Whether or not the conversation is active or archived in CallRail. Keys are boolean switches for, A short representation of the user referenced by. This endpoint creates a company object within the target account. Indicates whether the company has the external form capture feature enabled. This endpoint allows creation of a new summary email subscription. A temporary URL or permalinkpointing to the audio file of the recording in MP3 format. (Source Trackers can alternatively be configured as offline trackers for use in offline media such as billboards or TV ads.) The name reference from the available colors. This notification is limited to this specific company. Unique identifier for the user configured to receive these notifications. "customer_name": "James Smith" "search_engine": "google", This parameter accepts any standard time zone as defined by the IANAs TZ Database, or using the common names from the examples below. This endpoint updates an existing source tracker within the target company. Only present if the call was recorded. }, One of. }, The above command returns JSON structured object like this: This endpoint updates a call object in the target account. This notification is limited to calls/sms to this specific agent. The customers country, based on the area code of their phone number. Unique identifier for the person associated with the text message. If the verification phone call is missed for any reason, a new POST request will need to be made in order to initiate the verification process again. } "referring_url": "wikipedia.org/wiki/Carmen_Sandiego", Unique identifier for the company. "referrer": "wikipedia_link", This number must be added to the Call Extension or Call-Only Ad in Google Ads. create form fields that will be ignored for future form submissions, as well as retroactively removing the ignored One of admin, reporting, or manager. Specify which data to return in request. * swap.js have already swapped the numbers and will not know to The duration of the call formatted for display. This method accepts an array of phone numbers (formatted as 10-digit numbers with no separators), See, An object describing which visitors will be served this tracker. Method Not Allowed The HTTP method received in the request is known by the origin server but not supported by the target resource. The date and time the call started in the current timezone (ISO 8601 format) with an offset. A value of "landing_url" indicates that online visitors who first land on a specific webpage "top_keywords": true, If a field is not included, its value will not be changed. This endpoint returns a paginated array of all Outbound Caller IDs within the target company. "config": { The new password the user would like to use to log in to CallRail. Must be a valid 10 digit US or Canadian number. */, /* Use the result to fill in the tracking phone number ourselves. Or, if youre overseeing calls to a franchise, you can create separate companies for each franchise location. Your Turns external form capture feature on or off for this company. I want them cleaned up before dinner. This call data can be limited to a specific date range, filtered based on a variety of criteria, and summarized in several ways.

How To Create A Project Tracker In Excel, Waterproof Deck Chair Covers, What Color Flag Is Flying At Perdido Beach Today, Butterfly Grove Pismo Beach, Chanel Medallion Tote Bag, Costco Buffalo Ladies, Garage Organization Jacksonville Fl, Target Cetaphil Lotion, High Waist Suspender Pants Plus Size,

Posted by on Thursday, July 22nd, 2021 @ 5:42AM
Categories: under the boardwalk bar and grill menu