Kixie API

https://www.kixie.com/developer
Admin
Kixie API is a communication platform that enables developers to integrate outbound calling, SMS...
Tokens:12,470
Snippets:37
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Contact Lookup API Endpoint Example

Source: https://www.kixie.com/developer/custom-crm-integration

This is an example of the URL structure for your endpoint. Kixie will append the dialed phone number as a query parameter.

```URL
https://someurl.com/api?number=+13102314322
```

--------------------------------

### Dial Attempt Webhook Data Example

Source: https://www.kixie.com/developer/dial-attempt-webhook

This JSON object represents the data structure received by the Dial Attempt Webhook. It contains all relevant information from a dial attempt that did not result in a connected call.

```json
{
  "data": {
    "crmContactId": null,
    "agentEmail": "aldo@kixie.com",
    "hookevent": "powerdialattempt",
    "businessid": 995,
    "powerlistSessionId": "2748633",
    "fromNumber": 14245515737,
    "lastDialOutcome": "Lost Race",
    "powerlistId": "157703",
    "customerNumber": "+17074261105",
    "ownerUserId": null,
    "externalOwnerId": null,
    "powerlistContactStatus": "rescheduling",
    "webhookurl": "https://webhook.site/8daf667d-e19c-4f25-a0d6-b2c03d4729c7",
    "webhookHeaders": null
  }
}
```

--------------------------------

### Disposition Webhook JSON Payload

Source: https://www.kixie.com/developer/webhooks-disposition-webhook

This is an example of the JSON payload received when the Disposition Webhook is triggered. It contains comprehensive data about the call and the associated contact.

```json
{
  "data": {
    "disposition": "Note",
    "purpose": "",
    "dispositionExternalid": "",
    "purposeExternalid": "",
    "subject": "",
    "callType": "outgoing",
    "note": "",
    "businessid": "995",
    "userid": "107742",
    "phone": "+18084899319",
    "contactid": "",
    "dealid": "",
    "externalid": "0c79d4ba-e54f-44d9-bfc6-bc3f4dfd2e66",
    "callid": "368131317",
    "timezone": "America/Chicago",
    "powerlistId": "105192",
    "powerlistContactEmail": "",
    "callDetails": {
      "callid": "0c79d4ba-e54f-44d9-bfc6-bc3f4dfd2e66",
      "businessid": "995",
      "calldate": "2024-07-17 15:09:30",
      "fromnumber": "+15209993116",
      "tonumber": "+18084899319",
      "duration": null,
      "amount": null,
      "externalid": "0c79d4ba-e54f-44d9-bfc6-bc3f4dfd2e66",
      "calltype": "outgoing",
      "callstatus": "answered",
      "recordingurl": "https://calls.kixie.com/0c79d4ba-e54f-44d9-bfc6-bc3f4dfd2e66.mp3",
      "recordingsid": null,
      "tonumber164": "+18084899319",
      "fromnumber164": "+15209993116",
      "disposition": "Note",
      "fname": "Eddy",
      "lname": "Zone-7 (qa1)",
      "calleridName": "Eddy Zone-7",
      "email": "echau+n7@kixie.com",
      "destinationName": "PowerList",
      "cadenceactionprocessid": null,
      "powerlistid": "105192",
      "HScalltype": "outgoing",
      "powerlistsessionid": "1927544",
      "extensionDial": "0",
      "toExt": null,
      "fromExt": null,
      "answerDate": "2024-07-17 15:09:30",
      "callEndDate": null,
      "transcriptionXd": null,
      "transcriptionStatus": null,
      "transcriptionS3Key": null,
      "crmlink": "",
      "contactid": "",
      "dealid": "",
      "webhookurl": "https://webhook.site/dispowebhooktest",
      "outcome": "outgoing"
    },
    "activeCRM": {
      "meta": {
        "success": true
      },
      "result": {
        "crmName": "hubspot",
        "logo": "hubspot.png",
        "userAgent": "Kixie Integration - tech@kixie.com",
        "crmID": "16",
        "userid": "107742",
        "user": "",
        "token": "5571dba6-201b-4abf-acf7-9bbb8997767d",
        "refreshTokenExpiration": "",
        "pass": "",
        "accountid": "46741754",
        "location": "",
        "createdate": "2024-06-27 22:46:56",
        "updatedate": "",
        "errordate": "",
        "isActive": "1",
        "accessToken": "",
        "tokenupdate": "",
        "tokenvaliduntil": "",
        "externalEmail": "echau@kixie.com",
        "externalOwnerid": "67967150",
        "isDeleted": "0",
        "version": "",
        "customName": "",
        "customSearchEndpoint": "",
        "customDispositionEndpoint": "",
        "customActivityEndpoint": "",
        "customContactUpdateEndpoint": "",
        "customHeaders": "",
        "isAdmin": "0",
        "auditRequestId": "",
        "customDomainName": ""
      },
      "call": "call calls.getActiveCRM3(107742, 995);"
    },
    "powerlistContactDetails": {
      "result": {
        "powerlistContactId": "157727945",
        "powerlistId": "105192",
        "powerlistSpreadsheetId": "117646",
        "status": "enqueue",
        "rowNumber": "7",
        "phoneNumber": "18084899319",
        "phoneNumber164": "+18084899319",
        "email": "",
        "firstName": "Oahu",
        "lastName": "Kailua",
        "title": "",
        "companyName": "345 Hahani St, Kailua, HI 96734-2838",
        "externalOwnerId": "",
        "crmContactId": "",
        "targetTimeZone": "UTC-10",
        "attemptCount": "1",
        "lastAttemptDateTime": "2024-07-17 15:09:05",
        "retryAfterDateTime": "2024-07-17 15:12:37",
        "ownerUserId": "",
        "reservedForUserId": "",
        "reservedDate": "",
        "nextCallRefresher": "",
        "refresherCreatedBy": "107742",
        "refesherUpdateDateTime": "2024-07-17 15:09:37",
        "outcome": "",
        "outcomeCreatedBy": "107742",
        "outcomeUpdateDateTime": "2024-07-17 15:09:37",
        "ssData": "{}",
        "createdDate": "2024-07-17 15:07:59",
        "targetTimeZoneDst": "UTC-9",
        "dstStartDate": "2024-01-01 00:00:00",
        "dstEndDate": "2024-12-31 00:00:00",
        "dstNextUpdateTimestamp": "2024-12-31 00:00:00",
        "statAnswered": "0",
        "statConnected": "0",
        "statTalkTimeinSec": "7",
        "lastDialOutcome": "Answered - Note",
        "deferredReason": "Min. Duration Between Calls Applied",
        "machineDetected": "0",
        "machineNotDetected": "0",
        "mdAssisted": "0",
        "groupId": "6914f7a8-f5ae-4f97-876f-81cd751ec634",
        "auditRequestId": "7981"
      }
    },
    "hookevent": "disposition",
    "webhookurl": "https://webhook.site/dispowebhooktest",
    "webhookHeaders": null,
    "number": "+18084899319",
    "customernumber": "+18084899319",
    "businessnumber": "+15209993116"
  }
}
```

--------------------------------

### Example Calls Webhook Data Object

Source: https://www.kixie.com/developer/calling-webhooks

This JSON object represents the data structure sent to your endpoint for call events. It includes details such as call date, ID, duration, type, status, and participant numbers.

```json
{
  "data": {
    "calldate": "2020-03-13 19:21:28",
    "callid": "d66d15aa-655f-11ea-b174-45f320f374c7",
    "duration": "267",
    "amount": "0.0400",
    "calltype": "incoming",
    "callstatus": "answered",
    "tonumber": "+14243131560",
    "fromnumber": "+18666892261",
    "disposition": "not disposed",
    "fname": "Aldo",
    "lname": "Barbagiovanni",
    "email": "aldo@kixie.com",
    "recordingurl": "<http:>",
    "crmlink": "",
    "dealid": "",
    "contactid": ""
  }
}
```

--------------------------------

### SMS Webhook JSON Payload Example

Source: https://www.kixie.com/developer/text-message-webhooks

This JSON payload represents the data structure received when an SMS webhook is triggered. It includes details about the message, sender, recipient, and associated contact information.

```json
{
  "data": {
    "messageid": "eecbd3d4-539b-4746-aa03-bc4b74a4bdef",
    "from": "+14246003057",
    "to": "+12223334444",
    "customernumber": "+12223334444",
    "businessnumber": "+14246003057",
    "direction": "outgoing",
    "message": "testing sms webhook",
    "businessid": xxxxx,
    "contact": {
      "deal": {},
      "org": {},
      "contact": {
        "zip": "90401",
        "firstName": "Ryan",
        "lastName": "Frizelle",
        "phone": "(424) 600-3057",
        "city": "Santa Monica",
        "street": "406 Wilshire Blvd",
        "name": "Ryan Frizelle",
        "link": "https://app.hubspot.com/contacts/20564323/contact/12252651/",
        "state": "CA",
        "id": "12252651",
        "email": "test@kixie.com"
      }
    },
    "messageDate": "2024-03-28T17:48:59.000Z",
    "email": "test%40kixie.com",
    "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-bc4b74a4bdef",
    "webhookHeaders": null,
    "hookevent": "sms",
    "number": "+12223334444",
    "crmlink": "https://app.hubspot.com/contacts/20564323/contact/12252651/",
    "contactid": "12252651",
    "dealid": ""
  }
}
```

--------------------------------

### Contact Found Response Structure

Source: https://www.kixie.com/developer/custom-crm-integration

Format your JSON response with these keys when a contact is found. You may omit 'deal' and 'org' if not applicable.

```JSON
{
	"found": true,
	"contact": {
		"first_name": "First",
		"last_name": "Last",
		"url": "someurl that links to contact in crm",
		"contact_id": "the contact id in the crm",
		"email": "email@address.com",
		"phone_number": "a phone number",
		"town": "town",
		"postal": "postal code",
		"state": "state",
		"address": "address"
	},
	"deal": {
		"title": "title of deal",
		"value": "value of deal",
		"status": "status of deal",
		"stage": "stage of deal",
		"deal_id": "id of the deal",
		"url": "some url which links to the deal"
	},
	"org": {
		"name": "name of org"
	}
}
```

--------------------------------

### Schedule Activity JSON Payload

Source: https://www.kixie.com/developer/custom-crm-schedule-activity

This JSON structure represents the data required to schedule a new activity. Ensure all fields, especially date, time, and timezone, are correctly formatted. The `callDetails` field contains nested JSON with specific call-related information.

```json
{
  "data": {
    "subject": "",
    "description": "",
    "type": "Call",
    "typename": "Call",
    "duration": "00:15",
    "date": "13 Mar, 2024",
    "dateformat": "2024-03-13",
    "time": "4:44 pm",
    "timeformat": "16:44",
    "timezone": "America/Los_Angeles",
    "businessid": "40970",
    "userid": "200099",
    "externalid": "a6fc47e8-68f9-4a79-bcc8-0d2d9a4cd17c",
    "callid": "339966612",
    "phone": "+11235551234",
    "email": "",
    "fname": "Name",
    "lname": "Unavailable",
    "contactid": "",
    "dealid": "",
    "apiKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "callDetails": "{\"callid\":339966612,\"businessphoneid\":0,\"businessid\":40970,\"calldate\":\"2024-03-13T23:39:46.000Z\",\"firstsix\":310746,\"fromnumber\":13072892045,\"tonumber\":13107466323,\"duration\":\"\",\"rate\":\"\",\"amount\":\"\",\"externalid\":\"a6fc47e8-68f9-4a79-bcc8-0d2d9a4cd17c\",\"conferenceName\":\"\",\"clientid\":1,\"calltype\":\"outgoing\",\"source\":\"MANUAL-DIAL\",\"createdate\":\"\",\"updatedate\":\"\",\"name\":\"\",\"enddate\":\"\",\"callstatus\":\"answered\",\"externalstatus\":\"\",\"recordingurl\":\"https://calls.kixie.com/a6fc47e8-68f9-4a79-bcc8-0d2d9a4cd17c.mp3\",\"recordingsid\":\"\",\"recordingduration\":0,\"originalCallDate\":\"\",\"ext\":\"\",\"externalparentid\":\"\",\"answeredbynumber\":0,\"callmadeby\":200099,\"webhookupdates\":0,\"webhookupdatesanswered\":0,\"callmadeto\":\"\",\"tonumber164\":\"+13107466323\",\"fromnumber164\":\"+13072892045\",\"callrecordingupdates\":0,\"isc2c\":0,\"disposition\":\"not disposed\",\"isPowerListSession\":0,\"fname\":\"chasen testing payload\",\"lname\":\"\",\"calleridName\":\"chasen testing payload\",\"email\":\"example@kixie.com\",\"initialdefault\":\"\",\"destinationName\":\"\",\"cadenceactionprocessid\":\"\",\"powerlistid\":\"\",\"HScalltype\":\"\",\"powerlistsessionid\":\"\",\"extensionDial\":0,\"toExt\":\"\",\"fromExt\":\"\",\"answerDate\":\"2024-03-13T23:39:49.000Z\",\"callEndDate\":\"\",\"transcriptionXd\":\"\",\"transcriptionStatus\":\"\",\"transcriptionS3Key\":\"\",\"customerNumber\":\"+13107466323\",\"businessNumber\":\"+13072892045\",\"externalcrmid\":\"\"}",
    "crmlink": "",
    "crmContactid": "",
    "hookevent": "customCRMactivity",
    "webhookurl": "https://webhook.site/22e23ab2-e829-4869-85ae-ff186234eef7",
    "webhookHeaders": ""
  }
}
```

--------------------------------

### Contact Not Found Response Structure

Source: https://www.kixie.com/developer/custom-crm-integration

Return this JSON object when no matching contact is found for the provided phone number.

```JSON
{"found":false}
```

--------------------------------

### Contact Lookup Endpoint

Source: https://www.kixie.com/developer/custom-crm-integration

This endpoint is called by Kixie when a user initiates a call to retrieve contact information from your CRM.

```APIDOC
## GET /api

### Description
Accepts a GET request with an E.164 formatted phone number as a query parameter to look up contact information in your CRM.

### Method
GET

### Endpoint
`/api?number=<E.164_formatted_number>`

### Query Parameters
- **number** (string) - Required - The E.164 formatted phone number to look up.

### Response
#### Success Response (Found)
Returns a JSON object with contact details if a match is found.
- **found** (boolean) - true
- **contact** (object) - Details of the found contact.
  - **first_name** (string) - Contact's first name.
  - **last_name** (string) - Contact's last name.
  - **url** (string) - URL linking to the contact in the CRM.
  - **contact_id** (string) - The unique ID of the contact in the CRM.
  - **email** (string) - Contact's email address.
  - **phone_number** (string) - Contact's phone number.
  - **town** (string) - Contact's town.
  - **postal** (string) - Contact's postal code.
  - **state** (string) - Contact's state.
  - **address** (string) - Contact's full address.
- **deal** (object) - Optional. Details of an associated deal.
  - **title** (string) - Deal title.
  - **value** (string) - Deal value.
  - **status** (string) - Deal status.
  - **stage** (string) - Deal stage.
  - **deal_id** (string) - The unique ID of the deal.
  - **url** (string) - URL linking to the deal.
- **org** (object) - Optional. Details of the associated organization.
  - **name** (string) - Organization name.

#### Response Example (Found)
{
  "found": true,
  "contact": {
    "first_name": "First",
    "last_name": "Last",
    "url": "someurl that links to contact in crm",
    "contact_id": "the contact id in the crm",
    "email": "email@address.com",
    "phone_number": "a phone number",
    "town": "town",
    "postal": "postal code",
    "state": "state",
    "address": "address"
  },
  "deal": {
    "title": "title of deal",
    "value": "value of deal",
    "status": "status of deal",
    "stage": "stage of deal",
    "deal_id": "id of the deal",
    "url": "some url which links to the deal"
  },
  "org": {
    "name": "name of org"
  }
}

#### Success Response (Not Found)
Returns a JSON object indicating no contact was found.
- **found** (boolean) - false

#### Response Example (Not Found)
{
  "found": false
}
```

--------------------------------

### Dial Attempt Webhook Data Object

Source: https://www.kixie.com/developer/dial-attempt-webhook

This object contains all relevant information from a dial attempt that did not connect to a live call.

```APIDOC
## Dial Attempt Webhook

### Description
This webhook is triggered every time a phone number is dialed but not connected to a live call during a Kixie PowerList session. It returns all relevant information from the dial attempt.

### Request Body Example
```json
{
  "data": {
    "crmContactId": null,
    "agentEmail": "aldo@kixie.com",
    "hookevent": "powerdialattempt",
    "businessid": 995,
    "powerlistSessionId": "2748633",
    "fromNumber": 14245515737,
    "lastDialOutcome": "Lost Race",
    "powerlistId": "157703",
    "customerNumber": "+17074261105",
    "ownerUserId": null,
    "externalOwnerId": null,
    "powerlistContactStatus": "rescheduling",
    "webhookurl": "https://webhook.site/8daf667d-e19c-4f25-a0d6-b2c03d4729c7",
    "webhookHeaders": null
  }
}
```

### Response
This webhook does not have a defined success or error response structure as it is an incoming webhook. The success of the webhook delivery is typically indicated by the receiving server's HTTP status code (e.g., 200 OK).
```

--------------------------------

### Disposition Webhook Payload

Source: https://www.kixie.com/developer/webhooks-disposition-webhook

The Disposition Webhook is triggered every time an agent leaves a disposition. This JSON object represents the payload received by the webhook.

```APIDOC
## Disposition Webhook

### Description
The Disposition Webhook is triggered every time an agent leaves a disposition. It provides detailed information about the call and the disposition left by the agent.

### Event
`disposition`

### Payload Structure
```json
{
  "data": {
    "disposition": "string",
    "purpose": "string",
    "dispositionExternalid": "string",
    "purposeExternalid": "string",
    "subject": "string",
    "callType": "string",
    "note": "string",
    "businessid": "string",
    "userid": "string",
    "phone": "string",
    "contactid": "string",
    "dealid": "string",
    "externalid": "string",
    "callid": "string",
    "timezone": "string",
    "powerlistId": "string",
    "powerlistContactEmail": "string",
    "callDetails": {
      "callid": "string",
      "businessid": "string",
      "calldate": "string",
      "fromnumber": "string",
      "tonumber": "string",
      "duration": "number | null",
      "amount": "number | null",
      "externalid": "string",
      "calltype": "string",
      "callstatus": "string",
      "recordingurl": "string",
      "recordingsid": "string | null",
      "tonumber164": "string",
      "fromnumber164": "string",
      "disposition": "string",
      "fname": "string",
      "lname": "string",
      "calleridName": "string",
      "email": "string",
      "destinationName": "string",
      "cadenceactionprocessid": "string | null",
      "powerlistid": "string",
      "HScalltype": "string",
      "powerlistsessionid": "string",
      "extensionDial": "string",
      "toExt": "string | null",
      "fromExt": "string | null",
      "answerDate": "string",
      "callEndDate": "string | null",
      "transcriptionXd": "string | null",
      "transcriptionStatus": "string | null",
      "transcriptionS3Key": "string | null",
      "crmlink": "string",
      "contactid": "string",
      "dealid": "string",
      "webhookurl": "string",
      "outcome": "string"
    },
    "activeCRM": {
      "meta": {
        "success": "boolean"
      },
      "result": {
        "crmName": "string",
        "logo": "string",
        "userAgent": "string",
        "crmID": "string",
        "userid": "string",
        "user": "string",
        "token": "string",
        "refreshTokenExpiration": "string",
        "pass": "string",
        "accountid": "string",
        "location": "string",
        "createdate": "string",
        "updatedate": "string",
        "errordate": "string",
        "isActive": "string",
        "accessToken": "string",
        "tokenupdate": "string",
        "tokenvaliduntil": "string",
        "externalEmail": "string",
        "externalOwnerid": "string",
        "isDeleted": "string",
        "version": "string",
        "customName": "string",
        "customSearchEndpoint": "string",
        "customDispositionEndpoint": "string",
        "customActivityEndpoint": "string",
        "customContactUpdateEndpoint": "string",
        "customHeaders": "string",
        "isAdmin": "string",
        "auditRequestId": "string",
        "customDomainName": "string"
      },
      "call": "string"
    },
    "powerlistContactDetails": {
      "result": {
        "powerlistContactId": "string",
        "powerlistId": "string",
        "powerlistSpreadsheetId": "string",
        "status": "string",
        "rowNumber": "string",
        "phoneNumber": "string",
        "phoneNumber164": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "title": "string",
        "companyName": "string",
        "externalOwnerId": "string",
        "crmContactId": "string",
        "targetTimeZone": "string",
        "attemptCount": "string",
        "lastAttemptDateTime": "string",
        "retryAfterDateTime": "string",
        "ownerUserId": "string",
        "reservedForUserId": "string",
        "reservedDate": "string",
        "nextCallRefresher": "string",
        "refresherCreatedBy": "string",
        "refesherUpdateDateTime": "string",
        "outcome": "string",
        "outcomeCreatedBy": "string",
        "outcomeUpdateDateTime": "string",
        "ssData": "string",
        "createdDate": "string",
        "targetTimeZoneDst": "string",
        "dstStartDate": "string",
        "dstEndDate": "string",
        "dstNextUpdateTimestamp": "string",
        "statAnswered": "string",
        "statConnected": "string",
        "statTalkTimeinSec": "string",
        "lastDialOutcome": "string",
        "deferredReason": "string",
        "machineDetected": "string",
        "machineNotDetected": "string",
        "mdAssisted": "string",
        "groupId": "string",
        "auditRequestId": "string"
      }
    },
    "hookevent": "string",
    "webhookurl": "string",
    "webhookHeaders": "object | null",
    "number": "string",
    "customernumber": "string",
    "businessnumber": "string"
  }
}
```
```

--------------------------------

### Send Team SMS

Source: https://www.kixie.com/developer/team-sms-api

Send a Team SMS message to a target phone number. This endpoint requires authentication and specific event details.

```APIDOC
## POST /app/event?apikey=<api-key-here>

### Description
Send a Team SMS message to a target phone number. This endpoint requires authentication and specific event details.

### Method
POST

### Endpoint
https://apig.kixie.com/app/event?apikey=<api-key-here>

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your Kixie API key.

#### Request Body
- **businessid** (string) - Required - Your Kixie Business ID, found in Account Settings.
- **target** (string) - Required - The phone number you want to send the Team SMS message to.
- **eventname** (string) - Required - Must be set to "bizsms" for Team SMS.
- **id** (integer) - Required - The Team SMS ID found in the Kixie Dashboard under Manage > Numbers > Team SMS.
- **fromNumber** (string) - Optional - If multiple phone numbers are associated with the Team SMS ID, specify which one to send from. If omitted, Kixie uses the first number attached to the Team SMS ID.
- **message** (string) - Required - The content of the Team SMS message you want to send.

### Request Example
```json
{
  "businessid": "xxxxx",
  "target": "xxxxxxxxxx",
  "eventname": "bizsms",
  "id": 12345,
  "fromNumber": "14242299682",
  "message": "Hello world",
  "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```

--------------------------------

### Send Team SMS Message

Source: https://www.kixie.com/developer/team-sms-api

Use this cURL command to send a Team SMS message. Ensure Content-Type is set to application/json. Replace placeholders with your actual API key, Business ID, target number, and message.

```curl
curl --location --request POST 'https://apig.kixie.com/app/event?apikey=xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
  "businessid": "xxxxx",
  "target": "xxxxxxxxxx",
  "eventname": "bizsms",
  "id": 12345,
  "fromNumber": "14242299682",
  "message": "Hello world",
  "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}'
```

--------------------------------

### Voicemail Webhook Payload Structure

Source: https://www.kixie.com/developer/webhooks-voicemail-webhook

This JSON object represents the data structure received when a voicemail webhook is triggered. It contains detailed information about the call and the voicemail itself.

```json
{
  "data": {
    "callDetails": {
      "callid": "79e86bb6-9103-4fee-b30a-fb702bj39c62",
      "businessid": xxxxxx,
      "calldate": "2024-03-28T20:27:49.000Z",
      "fromnumber": " 12223334444",
      "tonumber": " 14246003057",
      "duration": 28,
      "amount": 0.0039,
      "externalid": "79e86bb6-9103-4fee-b30a-fb702bj39c62",
      "calltype": "incoming",
      "callstatus": "missed",
      "recordingurl": "https://calls.kixie.com/79e86bb6-9103-4fee-b30a-fb702bj39c62.mp3",
      "recordingsid": "",
      "tonumber164": " 14246003057",
      "fromnumber164": " 12223334444",
      "disposition": "inbound VM-msg left",
      "fname": "test",
      "lname": "Frizelle",
      "calleridName": "test Frizelle",
      "email": "test@kixie.com",
      "destinationName": "Direct Dial",
      "cadenceactionprocessid": "",
      "powerlistid": "",
      "HScalltype": "",
      "powerlistsessionid": "",
      "extensionDial": 0,
      "toExt": "",
      "fromExt": "",
      "answerDate": "",
      "callEndDate": "2024-03-28T20:28:17.000Z",
      "transcriptionXd": "",
      "transcriptionStatus": "",
      "transcriptionS3Key": "",
      "lastcallname": "Direct Dial",
      "crmlink": "",
      "contactid": "",
      "dealid": "",
      "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-7dfcbfaaf8aa",
      "outcome": ""
    },
    "voicemail": {
      "from": "12223334444",
      "to": "14246003057",
      "duration": 10,
      "VMRoute": "Direct",
      "url": "https://calls.kixie.com/79e86bb6-9103-4fee-b30a-fb702bj39c62.mp3",
      "LastCallType": "user"
    },
    "crm": "",
    "hookevent": "voicemail",
    "businessid": "xxxxxx",
    "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-7dfcbfaaf8aa",
    "webhookHeaders": "",
    "number": " 12223334444",
    "customernumber": " 12223334444",
    "businessnumber": " 14246003057"
  }
}
```

--------------------------------

### SMS Webhook Payload

Source: https://www.kixie.com/developer/text-message-webhooks

This is the structure of the JSON payload received when the SMS Webhook is triggered. It contains detailed information about the SMS message, including sender, recipient, message content, and associated contact details.

```APIDOC
## SMS Webhook Payload

### Description
This is the structure of the JSON payload received when the SMS Webhook is triggered. It contains detailed information about the SMS message, including sender, recipient, message content, and associated contact details.

### Request Body
- **data** (object) - Required - Contains all the details of the SMS event.
  - **messageid** (string) - Required - Unique identifier for the message.
  - **from** (string) - Required - The phone number the SMS was sent from.
  - **to** (string) - Required - The phone number the SMS was sent to.
  - **customernumber** (string) - Required - The customer's phone number.
  - **businessnumber** (string) - Required - The business's phone number.
  - **direction** (string) - Required - Indicates if the SMS was 'incoming' or 'outgoing'.
  - **message** (string) - Required - The content of the SMS message.
  - **businessid** (string) - Required - The ID of the business.
  - **contact** (object) - Optional - Information about the associated contact.
    - **deal** (object) - Optional - Deal information.
    - **org** (object) - Optional - Organization information.
    - **contact** (object) - Optional - Detailed contact information.
      - **zip** (string) - Optional - Contact's zip code.
      - **firstName** (string) - Optional - Contact's first name.
      - **lastName** (string) - Optional - Contact's last name.
      - **phone** (string) - Optional - Contact's phone number.
      - **city** (string) - Optional - Contact's city.
      - **street** (string) - Optional - Contact's street address.
      - **name** (string) - Optional - Contact's full name.
      - **link** (string) - Optional - Link to the contact in the CRM.
      - **state** (string) - Optional - Contact's state.
      - **id** (string) - Optional - Contact's ID.
      - **email** (string) - Optional - Contact's email address.
  - **messageDate** (string) - Required - The date and time the message was sent or received.
  - **email** (string) - Optional - The email associated with the contact.
  - **webhookurl** (string) - Required - The URL where the webhook data is sent.
  - **webhookHeaders** (null) - Optional - Headers for the webhook.
  - **hookevent** (string) - Required - The type of event, 'sms' in this case.
  - **number** (string) - Required - The phone number associated with the event.
  - **crmlink** (string) - Optional - Link to the CRM record.
  - **contactid** (string) - Optional - The ID of the contact.
  - **dealid** (string) - Optional - The ID of the deal.

### Response Example
```json
{
  "data": {
    "messageid": "eecbd3d4-539b-4746-aa03-bc4b74a4bdef",
    "from": "+14246003057",
    "to": "+12223334444",
    "customernumber": "+12223334444",
    "businessnumber": "+14246003057",
    "direction": "outgoing",
    "message": "testing sms webhook",
    "businessid": "xxxxx",
    "contact": {
      "deal": {},
      "org": {},
      "contact": {
        "zip": "90401",
        "firstName": "Ryan",
        "lastName": "Frizelle",
        "phone": "(424) 600-3057",
        "city": "Santa Monica",
        "street": "406 Wilshire Blvd",
        "name": "Ryan Frizelle",
        "link": "https://app.hubspot.com/contacts/20564323/contact/12252651/",
        "state": "CA",
        "id": "12252651",
        "email": "test@kixie.com"
      }
    },
    "messageDate": "2024-03-28T17:48:59.000Z",
    "email": "test%40kixie.com",
    "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-bc4b74a4bdef",
    "webhookHeaders": null,
    "hookevent": "sms",
    "number": "+12223334444",
    "crmlink": "https://app.hubspot.com/contacts/20564323/contact/12252651/",
    "contactid": "12252651",
    "dealid": ""
  }
}
```
```

--------------------------------

### Answered Call Webhook Payload

Source: https://www.kixie.com/developer/webhooks-answered-call-webhook

This is the JSON payload structure received when a call is answered. It contains detailed information about the call, the participants, and any associated CRM or power list data.

```APIDOC
## Answered Call Webhook

### Description
The Answered Call Webhook is triggered every time a call is answered. This will return all of the information from the phone call.

### Payload Structure
```json
{
  "data": {
    "callDetails": {
      "callid": "string",
      "businessid": "string",
      "calldate": "string (ISO 8601)",
      "fromnumber": "string",
      "tonumber": "string",
      "duration": "string",
      "amount": "string",
      "externalid": "string",
      "calltype": "string",
      "callstatus": "string",
      "recordingurl": "string",
      "recordingsid": "string",
      "tonumber164": "string",
      "fromnumber164": "string",
      "disposition": "string",
      "fname": "string",
      "lname": "string",
      "calleridName": "string",
      "email": "string",
      "destinationName": "string",
      "cadenceactionprocessid": "string",
      "powerlistid": "integer",
      "HScalltype": "string",
      "powerlistsessionid": "integer",
      "extensionDial": "integer",
      "toExt": "string",
      "fromExt": "string",
      "answerDate": "string (ISO 8601)",
      "callEndDate": "string",
      "transcriptionXd": "string",
      "transcriptionStatus": "string",
      "transcriptionS3Key": "string",
      "customerNumber": "string",
      "businessNumber": "string",
      "crmlink": "string",
      "contactid": "string",
      "dealid": "string",
      "webhookurl": "string",
      "outcome": "string"
    },
    "secondaryAction": "string",
    "calledfrom": "string",
    "callAction": "string",
    "callroute": {
      "name": "string"
    },
    "crm": "string",
    "powerlistContactDetails": {
      "result": {
        "powerlistContactId": "string",
        "powerlistId": "string",
        "powerlistSpreadsheetId": "string",
        "status": "string",
        "rowNumber": "string",
        "phoneNumber": "string",
        "phoneNumber164": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "title": "string",
        "companyName": "string",
        "externalOwnerId": "string",
        "crmContactId": "string or null",
        "targetTimeZone": "string",
        "attemptCount": "string",
        "lastAttemptDateTime": "string",
        "retryAfterDateTime": "string or null",
        "ownerUserId": "string or null",
        "reservedForUserId": "string",
        "reservedDate": "string or null",
        "nextCallRefresher": "string",
        "refresherCreatedBy": "string",
        "refesherUpdateDateTime": "string",
        "outcome": "string or null",
        "outcomeCreatedBy": "string",
        "outcomeUpdateDateTime": "string",
        "ssData": "string",
        "createdDate": "string",
        "targetTimeZoneDst": "string",
        "dstStartDate": "string",
        "dstEndDate": "string",
        "dstNextUpdateTimestamp": "string",
        "statAnswered": "string",
        "statConnected": "string",
        "statTalkTimeinSec": "string",
        "lastDialOutcome": "string",
        "deferredReason": "string",
        "machineDetected": "string",
        "machineNotDetected": "string",
        "mdAssisted": "string",
        "groupId": "string"
      }
    },
    "hookevent": "string",
    "businessid": "string",
    "webhookurl": "string",
    "number": "string",
    "customernumber": "string",
    "businessnumber": "string"
  }
}
```
```
Tokens:
Raw