### 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 ``` -------------------------------- ### Start Call Webhook Payload Example Source: https://www.kixie.com/developer/webhooks-start-call-webhook This JSON payload represents the data received when a call starts. It contains detailed information about the call, including caller and receiver numbers, duration, call type, status, and links to recordings and CRM entries. ```json { "data": { "callDetails": { "callid": "02d885e1-565d-4f89-81ce-c0egj332c580", "businessid": xxxxx, "calldate": "2024-03-28T20:39:23.000Z", "fromnumber": "+14244553933", "tonumber": "+12223334444", "duration": 20, "amount": 0.0018, "externalid": "02d885e1-565d-4f89-81ce-c0egj332c580", "calltype": "outgoing", "callstatus": "answered", "recordingurl": "https://calls.kixie.com/02d885e1-565d-4f89-81ce-c0egj332c580.mp3", "recordingsid": "", "tonumber164": "+12223334444", "fromnumber164": "+14244553933", "disposition": "not disposed", "fname": "Test", "lname": "Duffy", "calleridName": "Test Duffy", "email": "test@kixie.com", "destinationName": "", "cadenceactionprocessid": "", "powerlistid": "", "HScalltype": "", "powerlistsessionid": "", "extensionDial": 0, "toExt": "", "fromExt": "", "answerDate": "2024-03-28T20:39:38.000Z", "callEndDate": "2024-03-28T20:39:43.000Z", "transcriptionXd": "", "transcriptionStatus": "", "transcriptionS3Key": "", "externalcrmid": "", "crmlink": "https://app.hubspot.com/contacts/20564323/contact/29602451/", "contactid": "29602451", "dealid": "13912529816", "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-7dfcbfaaf8aa", "outcome": "" }, "crm": "", "hookevent": "endcall", "businessid": "xxxxx", "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-7dfcbfaaf8aa", "webhookHeaders": "", "number": "+12223334444", "customernumber": "+12223334444", "businessnumber": "+14244553933" } } ``` -------------------------------- ### Start Call Webhook Payload Source: https://www.kixie.com/developer/webhooks-start-call-webhook This is the JSON payload structure received when the Start Call Webhook is triggered. It contains detailed information about the phone call. ```APIDOC ## Start Call Webhook ### Description The Start Call Webhook is triggered every time a call starts. 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": "integer", "amount": "number", "externalid": "string", "calltype": "string", "callstatus": "string", "recordingurl": "string (URL)", "recordingsid": "string", "tonumber164": "string", "fromnumber164": "string", "disposition": "string", "fname": "string", "lname": "string", "calleridName": "string", "email": "string", "destinationName": "string", "cadenceactionprocessid": "string", "powerlistid": "string", "HScalltype": "string", "powerlistsessionid": "string", "extensionDial": "integer", "toExt": "string", "fromExt": "string", "answerDate": "string (ISO 8601)", "callEndDate": "string (ISO 8601)", "transcriptionXd": "string", "transcriptionStatus": "string", "transcriptionS3Key": "string", "externalcrmid": "string", "crmlink": "string (URL)", "contactid": "string", "dealid": "string", "webhookurl": "string (URL)", "outcome": "string" }, "crm": "string", "hookevent": "string", "businessid": "string", "webhookurl": "string (URL)", "webhookHeaders": "string", "number": "string", "customernumber": "string", "businessnumber": "string" } } ``` ``` -------------------------------- ### 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": "", "crmlink": "", "dealid": "", "contactid": "" } } ``` -------------------------------- ### End Call Webhook Payload Example Source: https://www.kixie.com/developer/webhooks-end-call-webhook This JSON payload represents the data received when a call ends. It includes details about the call itself, associated CRM information, and power list contact specifics. ```json { "data": { "callDetails": { "callid": "f3341ff4-aace-40e1-8a9d-a1d00db32438", "businessid": xxxxx, "calldate": "2024-07-17T18:22:46.000Z", "fromnumber": "+14244553933", "tonumber": "+12223334444", "duration": 40, "amount": 0.0156, "externalid": "f3341ff4-aace-40e1-8a9d-a1d00db32438", "calltype": "outgoing", "callstatus": "answered", "recordingurl": "https://calls.kixie.com/f3341ff4-aace-40e1-8a9d-a1d00db32438.mp3", "recordingsid": "", "tonumber164": "+12223334444", "fromnumber164": "+14244553933", "disposition": "not disposed", "fname": "Stan", "lname": "Test", "calleridName": "Test SM", "email": "test@kixie.com", "destinationName": "PowerList", "cadenceactionprocessid": "", "powerlistid": 118020, "HScalltype": "", "powerlistsessionid": 2117601, "extensionDial": 0, "toExt": "", "fromExt": "", "answerDate": "2024-07-17T18:22:46.000Z", "callEndDate": "2024-07-17T18:23:26.000Z", "transcriptionXd": "", "transcriptionStatus": "", "transcriptionS3Key": "", "externalcrmid": "", "crmlink": "https://crm.zoho.com/crm/EntityInfo.do?module=Contacts&id=0000002000032311016", "contactid": "1484182000032311016", "dealid": "", "webhookurl": "https://webhook.site/e33a1330-6e94-4d02-8f41-e8b8636bb268", "outcome": "" }, "crm": "", "powerlistContactDetails": { "result": { "powerlistContactId": "177116309", "powerlistId": "118020", "powerlistSpreadsheetId": "132137", "status": "answeredWaitingForOutcome", "rowNumber": "3", "phoneNumber": "2223334444", "phoneNumber164": "+12223334444", "email": "test@kixie.com", "firstName": "Customer", "lastName": "Test", "title": "Tester", "companyName": "Kixie", "externalOwnerId": "", "crmContactId": null, "targetTimeZone": "UTC-8", "attemptCount": "1", "lastAttemptDateTime": "2024-07-17 18:22:44", "retryAfterDateTime": null, "ownerUserId": null, "reservedForUserId": "197095", "reservedDate": null, "nextCallRefresher": null, "refresherCreatedBy": null, "refesherUpdateDateTime": null, "outcome": null, "outcomeCreatedBy": null, "outcomeUpdateDateTime": null, "ssData": "{}", "createdDate": "2024-07-17 18:21:56", "targetTimeZoneDst": "UTC-7", "dstStartDate": "2024-03-10 00:00:00", "dstEndDate": "2024-11-03 00:00:00", "dstNextUpdateTimestamp": "2024-11-03 00:00:00", "statAnswered": "1", "statConnected": "0", "statTalkTimeinSec": "0", "lastDialOutcome": "Answered", "deferredReason": null, "machineDetected": "0", "machineNotDetected": "0", "mdAssisted": "0", "groupId": "6e57332b-af00-458c-ac35-47c4b7876bc9" } }, "hookevent": "endcall", "businessid": "xxxxx", "webhookurl": "https://webhook.site/e33a1330-6e94-4d02-8f41-e8b8636bb268", "number": "+18183503571", "customernumber": "+12223334444", "businessnumber": "+14244553933" } } ``` -------------------------------- ### 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": "" } } ``` -------------------------------- ### Make an Outbound Call using cURL Source: https://www.kixie.com/developer/make-a-call Use this cURL command to make an outbound call. Ensure you replace placeholder values for 'apikey' and 'businessid' with your actual credentials. ```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", "email": "cmarshall@kixie.com", "target": "18506798788", "displayname": "test 1234", "eventname": "call", "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }' ``` -------------------------------- ### Flush User Queue using cURL Source: https://www.kixie.com/developer/automation-flush-queue Use this cURL command to send a POST request to the Flush Queue API. Ensure you replace 'xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' with your actual API key. The request body includes parameters to identify the queue to be flushed. ```bash curl --location --request POST 'https://apig.kixie.com/app/legacy/flushUserQueue?apikey=xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \ --header 'Content-Type: application/json' \ --data-raw ' { "call": "flushUserQueue", "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "id": 68700, "userid": 89571, "businessid": 10377 }' ``` -------------------------------- ### Make Outbound Call Source: https://www.kixie.com/developer/make-a-call This endpoint initiates an outbound call. The call will first connect to a Kixie agent, and upon pickup, it will dial the target number. ```APIDOC ## POST /app/event ### Description Initiates an outbound call through the Kixie platform. The call flow involves connecting to a Kixie agent first, then dialing the specified target number. ### Method POST ### Endpoint https://apig.kixie.com/app/event ### Parameters #### Query Parameters - **apikey** (string) - Required - Your Kixie API key. #### Request Body - **businessid** (string) - Required - The ID of the business. - **email** (string) - Required - The email address associated with the call. - **target** (string) - Required - The phone number to call. - **displayname** (string) - Optional - The display name for the call. - **eventname** (string) - Required - Must be set to "call". - **apikey** (string) - Required - Your Kixie API key (can also be passed in the query string). ### Request Example ```json { "businessid": "xxxxx", "email": "cmarshall@kixie.com", "target": "18506798788", "displayname": "test 1234", "eventname": "call", "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 Call to Kixie Queue Source: https://www.kixie.com/developer/automation-send-to-queue Use this cURL command to send a call to a Kixie Queue. Ensure you replace placeholder values with your actual API key, business ID, and target phone number. ```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", "email": "cmarshall@kixie.com", "target": "13104474156", "displayname": "hello", "eventname": "queue", "id":576, "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }' ``` -------------------------------- ### Send Call to Queue Source: https://www.kixie.com/developer/automation-send-to-queue This endpoint allows you to send a call to a Kixie Queue. It requires authentication via an API key and specifies the recipient and queue details. ```APIDOC ## POST /app/event ### Description Sends a call to a Kixie Queue with specified details. ### Method POST ### Endpoint https://apig.kixie.com/app/event?apikey=xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ### Parameters #### Query Parameters - **apikey** (string) - Required - Your Kixie API key for authentication. #### Request Body - **businessid** (string) - Required - The ID of the business. - **email** (string) - Required - The email address associated with the call. - **target** (string) - Required - The phone number to target. - **displayname** (string) - Required - The display name for the call. - **eventname** (string) - Required - The name of the event, should be 'queue'. - **id** (integer) - Required - A unique identifier for the event. - **apikey** (string) - Required - The API key, also included in the request body. ### Request Example { "businessid": "xxxxx", "email": "cmarshall@kixie.com", "target": "13104474156", "displayname": "hello", "eventname": "queue", "id":576, "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ### Response #### Success Response (200) (Response structure not explicitly defined in source, but typically indicates success) #### Response Example (No example provided in source) ``` -------------------------------- ### 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" } } ``` -------------------------------- ### Send SMS Source: https://www.kixie.com/developer/automation-send-sms Initiate SMS communications with customers directly from your business's designated phone numbers. ```APIDOC ## POST /app/event ### Description Sends an SMS message to a specified target phone number. ### Method POST ### Endpoint https://apig.kixie.com/app/event ### Parameters #### Query Parameters - **apikey** (string) - Required - Your Kixie API key. #### Request Body - **businessid** (string) - Required - The ID of the business account. - **email** (string) - Required - The email associated with the request. - **target** (string) - Required - The phone number to send the SMS to. - **eventname** (string) - Required - Must be set to "sms". - **message** (string) - Required - The content of the SMS message. - **apikey** (string) - Required - Your Kixie API key (also passed in query parameters). ### Request Example ```json { "businessid": "12345", "email": "example@kixie.com", "target": "13101234567", "eventname": "sms", "message": "Hello!", "apikey": "fdsfsf-df40-11e4-9ccc-42342" } ``` ### Response #### Success Response (200) (No specific success response details provided in the source.) #### Response Example (No specific response example provided in the source.) ``` -------------------------------- ### Add Contact to Cadence Source: https://www.kixie.com/developer/automation-send-to-cadence Use this endpoint to add a contact to a specific Kixie Cadence. Requires an API key and contact details. ```APIDOC ## POST /app/event ### Description Adds a contact to a Kixie Cadence. ### Method POST ### Endpoint https://apig.kixie.com/app/event ### Parameters #### Query Parameters - **apikey** (string) - Required - Your Kixie API key. #### Request Body - **businessid** (string) - Required - The ID of the business. - **target** (string) - Required - The phone number of the contact. - **displayname** (string) - Required - The display name of the contact. - **eventname** (string) - Required - Must be 'cadence'. - **action** (string) - Required - Must be 'add'. - **cadenceid** (integer) - Required - The ID of the cadence to add the contact to. - **apikey** (string) - Required - Your Kixie API key. ### Request Example ```json { "businessid": "xxxxx", "target": "+18055583059", "displayname": "test 1234", "eventname": "cadence", "action": "add", "cadenceid": 443, "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` ### Response #### Success Response (200) (No specific success response fields are documented in the source.) #### Response Example (No specific success response example is provided in the source.) ``` -------------------------------- ### Flush User Queue Source: https://www.kixie.com/developer/automation-flush-queue This endpoint flushes all current numbers in a specific user queue. It requires an API key and user/business identifiers. ```APIDOC ## POST /app/legacy/flushUserQueue ### Description Flushes all current numbers in a specific user queue. ### Method POST ### Endpoint https://apig.kixie.com/app/legacy/flushUserQueue ### Parameters #### Query Parameters - **apikey** (string) - Required - Your Kixie API key. #### Request Body - **call** (string) - Required - Must be 'flushUserQueue'. - **apikey** (string) - Required - Your Kixie API key. - **id** (integer) - Required - Identifier for the flush operation. - **userid** (integer) - Required - The ID of the user whose queue is to be flushed. - **businessid** (integer) - Required - The ID of the business associated with the user. ### Request Example ```json { "call": "flushUserQueue", "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "id": 68700, "userid": 89571, "businessid": 10377 } ``` ### Response #### Success Response (200) (Response structure not explicitly defined in source, but typically indicates success or failure) #### Response Example (Response example not provided in source) ``` -------------------------------- ### Add Contact to Cadence using cURL Source: https://www.kixie.com/developer/automation-send-to-cadence Use this cURL command to send a POST request to the Kixie API to add a contact to a specified cadence. Ensure you replace placeholder values with your actual API key, business ID, and target phone number. ```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": "+18055583059", "displayname": "test 1234", "eventname": "cadence", "action": "add", "cadenceid": 443, "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }' ``` -------------------------------- ### 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} ``` -------------------------------- ### Send SMS using cURL Source: https://www.kixie.com/developer/automation-send-sms Use this cURL command to send an SMS message. Ensure you replace placeholder values with your actual API key, business ID, email, and target phone number. ```curl curl --location --request POST 'https://apig.kixie.com/app/event?apikey=fdsfsf-df40-11e4-9ccc-42342' \ --header 'Content-Type: application/json' \ --data-raw '{ "businessid": "12345", "email": "example@kixie.com", "target": "13101234567", "eventname": "sms", "message": "Hello!", "apikey": "fdsfsf-df40-11e4-9ccc-42342" }' ``` -------------------------------- ### 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=` ### 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 } ``` -------------------------------- ### CI Summary Webhook Payload Source: https://www.kixie.com/developer/webhooks-ci-summary-webhook This is the JSON payload structure for the CI Summary Webhook. It contains comprehensive details about the phone call and its analysis. ```APIDOC ## CI Summary Webhook Payload ### Description This is the JSON payload structure for the CI Summary Webhook. It contains comprehensive details about the phone call and its analysis. ### Data Fields - **businessid** (integer) - The unique identifier for the business. - **calldate** (string) - The date and time the call occurred in ISO 8601 format. - **externalid** (string) - A unique identifier for the external call. - **sentimentRank** (string) - The overall sentiment of the call (e.g., "positive", "negative", "neutral"). - **conversationStrength** (integer) - A numerical score representing the strength of the conversation. - **summary** (string) - A textual summary of the call content. - **agentMonologue** (string) - The duration of the agent's monologue during the call (formatted as MM:SS). - **customerStory** (string) - The duration of the customer's speaking time during the call (formatted as MM:SS). - **patience** (string) - A metric related to call patience (formatted as MM:SS). - **crmlink** (string) - A URL linking to the call record in the CRM. - **keywords** (object) - An object containing boolean flags for detected keywords. - **beach** (boolean) - Indicates if the keyword "beach" was detected. - **Kixie** (boolean) - Indicates if the keyword "Kixie" was detected. - **PowerDialer** (boolean) - Indicates if the keyword "PowerDialer" was detected. - **phrases** (object) - An object containing boolean flags for detected phrases. - **How are you?** (boolean) - Indicates if the phrase "How are you?" was detected. - **business impact** (boolean) - Indicates if the phrase "business impact" was detected. - **favorite flavor of LaCroix** (boolean) - Indicates if the phrase "favorite flavor of LaCroix" was detected. - **hookevent** (string) - The type of webhook event, which is "cisummary" for this webhook. - **webhookurl** (string) - The URL where the webhook data will be sent. - **webhookHeaders** (null) - Placeholder for potential webhook headers (currently null). ### Response Example ```json { "data": { "businessid": 123456, "calldate": "2024-03-28T20:12:47.000Z", "externalid": "e6c73d7f-7584-4ffc-a0e3-ann9bd59f162", "sentimentRank": "positive", "conversationStrength": 44, "summary": "Company example is headquartered in Los Angeles, CA. We love using Kixie as a dialer. All of our internal communication is chatting through teams. We're looking to move forward with creating new automations.", "agentMonologue": "00:37", "customerStory": "00:31", "patience": "00:00", "crmlink": "https://app.hubspot.com/contacts/20564323/contact/6770610597/", "keywords": { "beach": false, "Kixie": true, "PowerDialer": false }, "phrases": { "How are you?": false, "business impact": false, "favorite flavor of LaCroix": false }, "hookevent": "cisummary", "webhookurl": "https://webhook.site/53cd3d47-fa87-4698-bbe2-7dfcbfaaf8aa", "webhookHeaders": null } } ``` ```