The Send to Queue API gives you access to send a call to a queue from a POST request. This request will ring the agent from the 'email' field provided. Once the agent answers the call, it will initiate an Outbound call to the phone number in the 'target' field.
- You can access your API Key and Business ID in the Kixie Dashboard under Manage > Account Settings > Edit All > Integrations
- You must be on the Professional Billing Tier in order to access the API
- You can reach out to your Account Manager or contact Support via the live chat in order for an agent to enable the API for you.
You can send a POST request to this endpoint here:
https://apig.kixie.com/app/event?apikey=<api-key-here>
*Please make sure that you select JSON as your Content-Type*
You can also set Content-Type: JSON in your Header Values.
Send to Queue
Request Body:
{
"businessid": "<business-id-here>",
"email": "test@kixie.com",
"target": "xxxxxxxxxx",
"displayname": "hello",
"eventname": "queue",
"id": <queue-id>,
"apikey": "<api-key-here>"
}
- 'businessid' (required) - This information will be found in the Dashboard. Instructions found above.
- 'email' (required) - This is the email of the agent that you would like to make the call from.
- 'target' (required) - This is the phone number of the contact that you would like to make the call to.
- 'displayname' - This will be the label that shows underneath the Contact Name in the dialer.
- 'id' (required) - This is the ID associated with the Queue and can be found in the Dashboard. It will be under Manage > Inbound > Queues.
- 'apikey' (required) - This information will be found in the Dashboard. Instructions found above.
0
0
Was this article helpful?
0 out of 0 found this helpful
Articles in this section
- Managing Kixie Event Webhooks via API
- Send to Queue API
- Make a Call API
- Business/Team SMS API
- Kixie Authentication Overview
- Kixie Automations
- Creating an Automation Cadence
- 'Start Call' Webhook Configuration and Data Payload
- 'Voicemail' Webhook Configuration and Data Payload
- 'Disposition' Webhook Configuration and Data Payload