telmetricsV3

Telmetrics V3 API Developer Documentation

Welcome to the Telmetrics V3 developer hub. You'll find comprehensive guides and documentation to help you start working with our API as quickly as possible.

Get Started    

Call Webhooks

Introduction

Telmetrics WebHook allows you to register endpoints to receive HTTP requests with Call Data. You can create new WebHooks by configuring them within the Telmetrics portal. Note that this requires Administrator access.

Types of Webhooks

Call Preprocessed (Post-Call Webhook) - The Call Preprocessed webhook executes immediately after the phone call has completed. It contains the partial data about the call, as described below.

Call Processed (Call Modified Webhook) - The Call Processed webhook is sent when a call has been updated after it has ended. For example, adding caller information, scoring the call or when the call recording has come available.

Configuration

You can also configure webhooks within the client account under the “Settings” -> “Webhooks” menu. You can configure a callback URL that we will send an HTTP POST request to after each call is completed. Additionally, any time a call object is modified within the call log, we will send an HTTP POST request to the given URL as well. This allows you to avoid polling our API endpoints for updates to inbound calls.

Sample Response

{
    "HttpMethod": "POST",
    "URL": "http://win5ui1:80/receive",
    "Headers": {
      "Connection": "Keep-Alive",
      "Content-Length": "1352",
      "Content-Type": "application/json; charset=utf-8",
      "Expect": "100-continue",
      "Host": "win5ui1",
      "ms-signature": "sha256=CA57B33AB4CF09E32DB0480DC3C084E6EFC767F44E8060C90CEE62DCB445BA13",
      "x-PublicKey": "4662F088F821DF150AD475B678CB723E",
      "x-Source-system": "Telmetrics Inc."
    },
    "RequestBody": {
      "Id": "20e9e290a1da40aa99c9286cff786aa6",
      "Attempt": 1,
      "Properties": {
        "CollectionType": "CallDetails",
        "UTC": "2016-05-04T17:21:31"
      },
      "Notifications": [
        {
          "Action": "CallDetails.CallPreprocessed",
          "Incomplete": false,
          "TelmetricsId": 1793078638,
          "TelmetricsStudyID": 7232746,
          "CalledNumber": "6123159846",
          "TerminationNumber": "9052198287",
          "RegisteredDNC": false,
          "StartTime": "2016-05-04T13:17:24",
          "AnswerTime": "2016-05-04T13:17:32",
          "EndTime": "2016-05-04T13:17:42",
          "AnswerStatus": "Answered",
          "RingCount": 2,
          "CallSeconds": 10,
          "CallerNumber": "4167370693",
          "CallerType": "Cell",
          "TimeZone": "Eastern",
          "VoiceRecordID": "70837c3b-5fd4-4fee-acf0-314281d21fab",
          "Latitude": null,
          "Longitude": null,
          "VoiceRecordingUrl": "https://win5CalltelligenceAPI.telmetrics.com/filedownload.ashx/58836a43-69a8-463d-85cf-f16275468e9d/1793078638.mp3",
          "VoiceMailDetected": false,
          "VoiceTrends": {
            "Lead": null,
            "VoiceMail": null
          },
          "OrganizationID": 4703,
          "OrgGroupId":1234,
          "StudyDetails":{
            "StudyID":1234,
            "CustomID": 1234,
            "CustomText": "1234",
            "CustomText2": "1234",
            "CustomText3": "1234",
          },
          "AdDetails":{
            "AdDefinitionId":1234,
            "CustomID": 1234,
            "CustomText": "1234",
            "CustomText2": "1234",
            "CustomText3": "1234",
            "CustomText4": "1234"
          },
          "AdvertiserDetails":{
             "AdvertiserId":1234,
             "ClientCode": 1234,
             "CustomText": "1234",
             "CustomText2": "1234"
          }        
        }
      ]
    }
  }
{
    "HttpMethod": "POST",
    "URL": "http://win5ui1:80/receive",
    "Headers": {
        "Connection": "Keep-Alive",
        "Content-Length": "709",
        "Content-Type": "application/json; charset=utf-8",
        "Expect": "100-continue",
        "Host": "win5ui1",
        "ms-signature": "sha256=E82C1574D449EEAC07E6532F29A14370EB03FB7589B7DD8F4FA53189BCD9F2EB",
        "x-PublicKey": "4662F088F821DF150AD475B678CB723E",
        "x-Source-system": "Telmetrics Inc."
    },
    "RequestBody": {
        "Id": "647e8029bf9e432582bd746e9f8ee6d9",
        "Attempt": 1,
        "Properties": {
            "CollectionType": "CallDetails",
            "UTC": "2016-05-04T17:17:41"
        },
        "Notifications": [
            {
                "Action": "CallDetails.CallProcessed",
                "TelmetricsId": 1793078638,
                "TelmetricsStudyID": 7232746,
                "CalledNumber": "6123159846",
                "TerminationNumber": "9052198287",
                "StartTime": "2016-05-04T13:17:24",
                "AnswerTime": "2016-05-04T13:17:32",
                "EndTime": "2016-05-04T13:17:42",
                "AnswerStatus": "Answered",
                "RingCount": 2,
                "CallSeconds": 10,
                "CallerNumber": "4167370693",
                "CallerName": "",
                "CallerStreet": "",
                "CallerCity": "TORONTO",
                "CallerState": "ON",
                "CallerZip": "",
                "CallerAddress": "TORONTO ON",
                "TimeZone": "Eastern",
                "Incomplete": true,
                "OrgGroupId": 1234,
                "StudyDetails": {
                    "StudyID": 1234,
                    "CustomID": 1234,
                    "CustomText": "1234",
                    "CustomText2": "1234",
                    "CustomText3": "1234",
                },
                "AdDetails": {
                    "AdDefinitionId": 1234,
                    "CustomID": 1234,
                    "CustomText": "1234",
                    "CustomText2": "1234",
                    "CustomText3": "1234",
                    "CustomText4": "1234"
                },
                "AdvertiserDetails": {
                    "AdvertiserId": 1234,
                    "ClientCode": 1234,
                    "CustomText": "1234",
                    "CustomText2": "1234"
                },
                "AttributionDetails": {
                  "SessionId":999,
                  "RuleDescription":"abc - google.com",
                  "LandingPagURL:":"http://test.com?utm=...",
                  "ReferrerURL":"google.com",
                  "MultisessionFlag":true,
                  "utm_campaign":"testcampaign",
                  "utm_term":"testing",
                  "utm_source":"google",
                  "utm_medium":"search",
                  "utm_content":"banner1",
                  "ip_address":"192.168.0.1",
                  "user_agent":"mozilla 11.4",
                  "session_tag": {
                          "tag_id": 1293291,
                          "tag_data": "sample tag data",
                          "tag_time": "2016-05-04T13:17:24"
                   }
                }
            }
        ]
    }
}

Call Webhooks


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.