Make a Call API

The Call API places an outbound call from one of your Kixie agents with a single POST request.

Before You Start

• Your account must be on the Professional billing tier or above.
• Your API key must be activated. It is not active by default. Ask your Account Manager, or contact support via live chat in the dashboard.
• You need your API key and Business ID. See Kixie API Authentication, or find them at Manage > Account Settings > Edit All > Integrations.

Endpoint

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

Set Content-Type: application/json in your headers. The API key goes in the query string and in the request body.

Request Body

{
  "businessid": "<business-id-here>",
  "email": "agent@yourcompany.com",
  "target": "18005551234",
  "displayname": "Direct Dial",
  "eventname": "call",
  "apikey": "<api-key-here>"
}

Fields

• businessid — your Kixie Business ID.
• email — the email address of the Kixie agent the call will come from. This must be an active Kixie user on your account.
• target — the phone number you are calling, digits only, including the country code.
• displayname — the label shown in the dialer when the call is placed, for example "Direct Dial", "PowerList" or "Queue". Use it to tell your integration's calls apart from manual ones. Note the lower-case spelling.
• eventname — always call. Do not change it.
• apikey — your API key, repeated from the query string.

If the Request Does Not Work

Check these in order. Each one is a separate failure and they look similar from the outside:

1. Is the key activated? A valid but inactive key fails. This is the most common cause on a first attempt.
2. Is the account on Professional or above? The API is not available below that tier.
3. Is the email an active Kixie agent? A deactivated user, or an address that is not a Kixie user at all, will not place a call.
4. Is Content-Type set to application/json? A form-encoded body will not parse.
5. Is the field spelling exact? displayname and businessid are all lower case with no separators.
6. Is the target number digits only, with country code? Formatting characters can cause a reject.

If all six are correct and it still fails, contact support@kixie.com with your Business ID, the exact request body with the key removed, and the response you received.

Related

Kixie API Authentication covers the key, the Business ID and the prerequisites. The other endpoints are listed there too.