Jump to Content

Home API Reference How To

Home API API Reference Changelog

Home API Reference How To Create your Account

API Reference

Create your Account

contacts, phonebook

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

Webhooks

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

Call Center Campaigns

/callcenter_campaigns/get
/callcenter_campaigns/:id/put
/callcenter_campaigns/:id/delete
/v1/power_campaign/:campaign_id/export/post
/v1/export_data/export_:id/get
/v1/power_campaign/create/post
/v1/power_campaign/rented_numbers/get

PEER TO PEER TEXTING

/sms_campaign/snowflake/:id/supporter-section/add/post
/sms_campaign/snowflake/:id/section_create/post
/sms_campaign/snowflake/:id/nationbuilder_event/add/post
/collective_texting/:id/nationbuilder_survey/add/post

Voice Broadcasts

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

SMS campaigns

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

users

/users/get
/v2/credits_usage/post

Do Not Call

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

Agents

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

Teams

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

Agent Console

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

AGENT CONSOLE CC

/is-trophy/get
/agent-campaigns/get
/campaign-info/get
/script-sections/:id/get
/subscriber-history/:id/get
/current-subscriber/:id/get
/conferencepost
/conference/:idget
/conference/:id/agentput
/conference/:id/agentdelete
/conference/:id/subscriberput
/conference/:id/subscriber/voicemailput
/conference/:id/subscriberdelete
/conference/:id/supervisorput
/conference/:id/subscriber/transferput
/conference/:id/supervisordelete

AGENT CONSOLE P2P

/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}/in_process/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/get
/collective_texting/subscribers/{subscriber_id}/sms/post
/collective_texting/:id/tags/get
/contacts/:id/taggings/patch
/contacts/:id/taggings/get
/collective_texting/campaigns/{campaign_id}/subscribers/get
/scripts/post
/scripts/{script_id}/patch
/scripts/:id/delete
/collective_texting/subscribers/:subsId/questions/:quesId/answers/post

Enterprise

/enterprise-account/share-credits/post

Analytics

/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/get

suppression list

/suppression-lists/:id/contacts/post

Powered by

contacts, phonebook

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

Webhooks

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

Call Center Campaigns

/callcenter_campaigns/get
/callcenter_campaigns/:id/put
/callcenter_campaigns/:id/delete
/v1/power_campaign/:campaign_id/export/post
/v1/export_data/export_:id/get
/v1/power_campaign/create/post
/v1/power_campaign/rented_numbers/get

PEER TO PEER TEXTING

/sms_campaign/snowflake/:id/supporter-section/add/post
/sms_campaign/snowflake/:id/section_create/post
/sms_campaign/snowflake/:id/nationbuilder_event/add/post
/collective_texting/:id/nationbuilder_survey/add/post

Voice Broadcasts

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

SMS campaigns

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

users

/users/get
/v2/credits_usage/post

Do Not Call

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

Agents

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

Teams

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

Agent Console

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

AGENT CONSOLE CC

/is-trophy/get
/agent-campaigns/get
/campaign-info/get
/script-sections/:id/get
/subscriber-history/:id/get
/current-subscriber/:id/get
/conferencepost
/conference/:idget
/conference/:id/agentput
/conference/:id/agentdelete
/conference/:id/subscriberput
/conference/:id/subscriber/voicemailput
/conference/:id/subscriberdelete
/conference/:id/supervisorput
/conference/:id/subscriber/transferput
/conference/:id/supervisordelete

AGENT CONSOLE P2P

/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}/in_process/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/get
/collective_texting/subscribers/{subscriber_id}/sms/post
/collective_texting/:id/tags/get
/contacts/:id/taggings/patch
/contacts/:id/taggings/get
/collective_texting/campaigns/{campaign_id}/subscribers/get
/scripts/post
/scripts/{script_id}/patch
/scripts/:id/delete
/collective_texting/subscribers/:subsId/questions/:quesId/answers/post

Enterprise

/enterprise-account/share-credits/post

Analytics

/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/get

suppression list

/suppression-lists/:id/contacts/post

Powered by

/analytics/agent-recruitment/success/

get https://api.callhub.io/v1/analytics/agent-recruitment/success/

Language

Credentials

Header

Click Try It! to start a request and see the response here!