Jump to Content

Home API Reference How To

Home API API Reference Changelog

v3.1

Home API Reference How To Create your Account

API Reference

Create your Account

v3.1

All

Pages

Start typing to search…

contacts, phonebook

/contacts/post
/contacts/get
/contacts/:id/put
/contacts/:id/del
/contacts/fields/get
/contacts/bulk_create/post
/phonebooks/post
/phonebooks/get
/phonebooks/:id/put
/phonebooks/:id/del
/phonebooks/:id/contacts/get
/phonebooks/:id/contacts/post
/phonebooks/:id/contacts/del
/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/del
/contacts/:id/tags/post
/contacts/:contact_id/tags/:tag_id/del

Webhooks

/webhooks/post
/webhooks/get
/webhooks/:id/del

Call Center Campaigns

/callcenter_campaigns/get
/callcenter_campaigns/:id/put
/v1/power_campaign/:campaign_id/export/post
/v1/power_campaign/create/post
/v1/power_campaign/rented_numbers/get
/v1/power_campaign/duplicate/post
/v2/power_campaign/:id/agents/add/post
/v2/power_campaign/:id/agents/get

PEER TO PEER TEXTING

/v1/p2p_campaigns/post
/v1/p2p_campaigns/:id/get
/v2/sms_campaign/snowflake/:id/put
/collective_texting/:id/nationbuilder_survey/add/post
/sms_campaign/snowflake/:id/section_create/post
/sms_campaign/snowflake/:id/nationbuilder_event/add/post
/sms_campaign/snowflake/:id/supporter-section/add/post
/v1/p2p_campaigns/:id/duplicate/post
/v2/collective_texting/{campaign_id}/agents/add/post

Templates & Related

/v1/templates/get
/v1/templates/post
/v1/questions/get
/v2/mediaget
/v2/shortened-urls/get
/v1/integration_fields/get

Voice Broadcasts

/voice_broadcasts/get
/voice_broadcasts/:id/put
/v1/vb_campaignpost
/v1/vb_templatepost
/v1/vb_templateget
/v1/vb_campaign/duplicate/post

SMS campaigns

/sms_campaigns/get
/sms_campaigns/:id/put
/v1/sms_campaign/sms_report/export/post

TEXT BROADCAST

/sms_broadcast/post
/v2/sms_broadcast/:id/duplicate/post

EXPORTS

/v1/export_data/export_:id/get

users

/users/get
/v2/credits_usage/post

Do Not Call

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

Agents

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

Teams

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

RELATIONAL ORGANISING

/email/v_1/relational-campaign/create/put
/email/v_1/relational-campaign/:id/edit/put
/email/v_1/relational-campaign/:id/get
/email/v_1/relational-campaign/:id/update-status/post
/email/v_1/relational-campaign/{campaign_id}/duplicate/post
/email/v_1/relational-campaign/agents/:id/put

Numbers

/numbers/rented_calling_numbers/get
/numbers/validated_numbers/get
/numbers/rent/post
/v2/sms_number/show_rented_number/get

API Schema

/v1/templates/api-schema/get
/v1/integration_fields/api-schemaget
/v1/p2p_campaigns/api-schemaget

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/agentdel
/conference/:id/subscriberput
/conference/:id/subscriber/voicemailput
/conference/:id/subscriberdel
/conference/:id/supervisorput
/conference/:id/subscriber/transferput
/conference/:id/supervisordel

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
/scripts/post
/scripts/{script_id}/patch
/scripts/:id/del
/collective_texting/subscribers/:subsId/questions/:quesId/answers/post

Enterprise

/enterprise-account/share-credits/post

suppression list

/suppression-lists/:id/contacts/post

Powered by

/nation-builder/

get

https://api.callhub.io/v2/nation-builder/

Get the Agent's NationBuilder details

Language

Credentials

Header

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