# Models

## The CallDataPayload object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Call Data","version":"v14"},"components":{"schemas":{"CallDataPayload":{"type":"object","required":["CampaignId","MediaId","EventDate","ActionTrackerId","CallProvider","CallSessionId","CallerId","CalledPhoneNumber","CallDuration","TalkDuration"],"properties":{"CampaignId":{"type":"integer","description":"A unique identifier for your program (formerly known as campaign)."},"MediaId":{"type":"integer","description":"The ID of the Partner or Media Source in impact.com."},"EventDate":{"type":"string","format":"date-time","description":"The ISO-8601 time when the call event took place."},"ActionTrackerId":{"type":"integer","description":"A unique identifier for the Event Type (Phone_Action_Tracker_ID)."},"CallProvider":{"type":"string","maxLength":64,"description":"The vendor or client sending the call event data."},"CallSessionId":{"type":"string","description":"The unique session ID from the vendor to identify the call."},"CallerId":{"type":"string","maxLength":64,"description":"The phone number of the originating call."},"CalledPhoneNumber":{"type":"string","description":"The destination phone number that received the call."},"CallDuration":{"type":"integer","description":"Total duration (in seconds) of the call."},"TalkDuration":{"type":"integer","description":"Actual talk duration (in seconds) of the call."},"AdId":{"type":"integer","description":"The unique ID of the ad associated with the call."},"CallStatus":{"type":"string","default":"ANSWER","enum":["UNKNOWN_CALLERID","CONGESTION","INCOMPLETE","CANCEL","IVR_DROPOFF","NO_TRANSFER_ATTEMPT","ANSWER","FAILURE"],"description":"This value indicates the final outcome of the call. If the field is not present in the request, the system makes it ANSWER by default."},"CallerPhoneNumberCountry":{"type":"string","maxLength":64,"default":"US","description":"(64 character UTF-8) This is the Country Code derived from the incoming phone call. When NULL, default to US."},"CalledPhoneNumberCountry":{"type":"string","maxLength":64,"default":"US","description":"(64 character UTF-8) This is the Country Code derived from the receiver of the incoming phone call. When NULL, default to US."},"SubId1":{"type":"string","maxLength":64,"description":"(64 character UTF-8) The first value specific and only available to the Partner. This is the placeholder where the Partner can add data points that they want impact.com to report back to them."},"SubId2":{"type":"string","maxLength":64,"description":"(64 character UTF-8) The second value specific and only available to the Partner. This is the placeholder where the Partner can add data points that they want impact.com to report back to them."},"SubId3":{"type":"string","maxLength":64,"description":"(64 character UTF-8) The third value specific and only available to the Partner. This is the placeholder where the Partner can add data points that they want impact.com to report back to them."},"ClickId":{"type":"string","description":"The ClickId from the landing page URL."},"City":{"type":"string","description":"City of the CallerId - As identified by the Call Tracking vendor."},"Region":{"type":"string","description":"Region of the CallerId - As identified by the Call Tracking vendor."},"Zip":{"type":"integer","description":"Zip of the CallerId - As identified by the Call Tracking vendor."},"RepeatCaller":{"type":"string","description":"Repeat vs. New call to indicate whether the caller was recorded as a repeat caller in the Call tracking vendor."},"PhoneType":{"type":"string","enum":["Landline","Mobile",""],"description":"Landline or Mobile or empty string if type is unknown and user_agent."},"CallRecording":{"type":"string","format":"uri","description":"Unique URL of the call recording."},"IvrDuration":{"type":"integer","description":"Duration in seconds that the call spent in the IVR tree."},"Keypresses":{"type":"string","description":"List of unique keynames pressed."},"Key1":{"type":"string","description":"Name of the first key that was pressed."},"Key2":{"type":"string","description":"Name of the second key that was pressed."},"Key3":{"type":"string","description":"Name of the third key that was pressed."},"Key4":{"type":"string","description":"Name of the fourth key that was pressed."},"TrafficSource":{"type":"string","description":"Source of the transaction (referring media source)."},"OptInSms":{"type":"string","description":"Whether the caller opted in to receive an SMS promotion."},"UserAgent":{"type":"string","description":"The user agent of the conversion generator."},"DispositionName":{"type":"string","description":"The Conversion Event Name."},"SaleAmount":{"type":"number","description":"If there was a sale conversion, this will show the Sale Amount."},"ReferenceId":{"type":"number","description":"Customer Disposition Code for reference."},"CustomConversionEvent1Name":{"type":"string","description":"First custom name for reporting on Conversion events."},"CustomConversionEvent2Name":{"type":"string","description":"Second custom name for reporting on Conversion events."},"CustomConversionEvent3Name":{"type":"string","description":"Third custom name for reporting on Conversion events."},"CustomConversionEvent1Value":{"type":"string","description":"First custom value for reporting on Conversion events."},"CustomConversionEvent2Value":{"type":"string","description":"Second custom value for reporting on Conversion events."},"CustomConversionEvent3Value":{"type":"string","description":"Third custom value for reporting on Conversion events."},"VendorEventId":{"type":"string","description":"A unique Id sent from the vendor for the Call and Conversion Event."},"PromoNumberDescription":{"type":"string","description":"Describes the Called Phone Number."},"CustomCallEvent1Name":{"type":"string","description":"First custom name for reporting on Call events."},"CustomCallEvent2Name":{"type":"string","description":"Second custom name for reporting on Call events."},"CustomCallEvent3Name":{"type":"string","description":"Third custom name for reporting on Call events."},"CustomCallEvent1Value":{"type":"string","description":"First custom value for reporting on Call events."},"CustomCallEvent2Value":{"type":"string","description":"Second custom value for reporting on Call events."},"CustomCallEvent3Value":{"type":"string","description":"Third custom value for reporting on Call events."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/reference/call-data/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.