Help and API Documentation | CallHub

Home
API
How To

Create your Account

CallHub Documentation

Welcome to the CallHub documentation. You'll find comprehensive guides and documentation to help you start working with CallHub as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started API

v1.0

v1.0stable
(Production Documentation)

HomeAPIRecipesAPI ReferenceReferenceChangelogCommunityPage Not FoundSearch{{ state.current().meta.title }}API Logs

contacts, phonebook

post
/contacts/
get
/contacts/
put
/contacts/:id/
delete
/contacts/:id/
get
/contacts/fields/
post
/contacts/bulk_create/
post
/phonebooks/
get
/phonebooks/
put
/phonebooks/:id/
delete
/phonebooks/:id/
get
/phonebooks/:id/contacts/
post
/phonebooks/:id/contacts/
delete
/phonebooks/:id/contacts/
post
/phonebooks/:id/create_contact/
post
/tags/
get
/tags/:id/
get
/phonebooks/:id/numbers_count/
get
/custom_fields/
post
/custom_fields/
put
/custom_fields/:id/
delete
/custom_fields/:id/
post
/contacts/:id/tags/
get
/contacts/:contact_id/tags/:tag_id/

Webhooks

post
/webhooks/
get
/webhooks/
delete
/webhooks/:id/

Call Center Campaigns

get
/callcenter_campaigns/
put
/callcenter_campaigns/:id/
delete
/callcenter_campaigns/:id/
post
/v1/power_campaign/:campaign_id/export/

Voice Broadcasts

get
/voice_broadcasts/
put
/voice_broadcasts/:id/
delete
/voice_broadcasts/:id/

SMS campaigns

get
/sms_campaigns/
put
/sms_campaigns/:id/
delete
/sms_campaigns/:id/

users

get
/users/

Do Not Call

post
/dnc_contacts/
get
/dnc_contacts/
put
/dnc_contacts/:id/
delete
/dnc_contacts/:id/
post
/dnc_lists/
get
/dnc_lists/
put
/dnc_lists/:id/
delete
/dnc_lists/:id/

Agents

get
/agents/
get
/agents/:id/
post
/agents/
delete
/agents/:id/
get
/campaign/agent/live/

Teams

get
/teams/
post
/teams/
get
/teams/:id/
put
/teams/:id/
delete
/teams/:id/
put
/teams/:id/agents/
delete
/teams/:id/agents/

Agent Console

post
/agent-key/
get
/agent-status/
get
/user-details/
post
/user-details/
post
/password-change/
get
/sip-endpoint/
post
/sip-endpoint/
get
/nation-builder/

Agent Campaigns

get
/is-trophy/
get
/agent-campaigns/
get
/campaign-info/
get
/script-sections/:id/
post
/script-answers/:id/

Subscriber

get
/current-subscriber/:id/
get
/subscriber-history/:id/

Conference

post
/conference
get
/conference/:id
put
/conference/:id/agent
delete
/conference/:id/agent
put
/conference/:id/subscriber
put
/conference/:id/subscriber/voicemail
delete
/conference/:id/subscriber
put
/conference/:id/supervisor
put
/conference/:id/subscriber/transfer
delete
/conference/:id/supervisor

Preview Dialer

post
/dialer/
get
/dialer/:id/
put
/dialer/:id/agent/
delete
/dialer/:id/agent/
post
/contact-notes/:id/

Collective Texting

get
/collective_texting/campaigns/
get
/collective_texting/campaigns/{campaign_id}/questions/
get
/collective_texting/campaigns/{campaign_id}/saved_replies/
get
/collective_texting/merge-tags/
get
/collective_texting/campaigns/{campaign_id}/subscribers/
get
/collective_texting/campaigns/{campaign_id}/unread/
get
/collective_texting/campaigns/{campaign_id}/initial_message/
get
/collective_texting/subscribers/{subscriber_id}/messages/
get
/collective_texting/subscribers/{subscriber_id}/answers/
get
/collective_texting/subscribers/{subscriber_id}/merge-tags/
get
/collective_texting/subscribers/{subscriber_id}/history/
post
/collective_texting/subscribers/{subscriber_id}/sms/
get
/collective_texting/:id/tags/
patch
/contacts/:id/taggings/
get
/contacts/:id/taggings/
get
/collective_texting/campaigns/{campaign_id}/subscribers/
post
/scripts/
patch
/scripts/{script_id}/
delete
/scripts/:id/
post
/collective_texting/subscribers/:subsId/questions/:quesId/answers/

Analytics

get
/analytics/sms-reach/total/
get
/analytics/call-center-reach/total/
get
/analytics/agent-shift/
get
/analytics/agent-recruitment/success/
get
/analytics/agent-leaderboard/
get
/analytics/team-leaderboard/
get
/analytics/agent-compare/
get
/analytics/agent-recruitment/success/
get
/analytics/agent-recruitment/
get
/analytics/call-center-reach/
get
/analytics/call-center-reach/count/
get
/analytics/vb-reach/total/
get
/analytics/vb-reach/
get
/analytics/vb-reach/count/
get
/analytics/sms-reach/
get
/analytics/sms-reach/count/

Powered by