| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.callhub.io/v1 | link | — | — | — |
Actions (142)
Agent Console P2P · 19
- Create scriptPOST /scripts/
Create a script
documented - Create subscriber question answerPOST /collective_texting/subscribers/{subsId}/questions/{quesId}/answers/
Create an answer for subscriber question
documented - Delete scriptDELETE /scripts/{script_id}/
Delete a script
documented - Get contact taggingsGET /contacts/{id}/taggings/
Get taggings for a contact
documented - Get initial messageGET /collective_texting/campaigns/{campaign_id}/initial_message/
Get initial message for a collective_texting campaign
documented - List collective-texting campaignsGET /collective_texting/campaigns/
List collective_texting campaigns
documented - List collective-texting merge-tagsGET /collective_texting/merge-tags/
List merge-tags for collective_texting
documented - List collective-texting questionsGET /collective_texting/campaigns/{campaign_id}/questions/
List questions for a collective_texting campaign
documented - List collective-texting saved repliesGET /collective_texting/campaigns/{campaign_id}/saved_replies/
List saved replies for a collective_texting campaign
documented - List collective-texting tagsGET /collective_texting/:id/tags/
List tags for a collective_texting campaign
documented - List in-process subscribersGET /collective_texting/campaigns/{campaign_id}/in_process/subscribers/
List in-process subscribers for a collective_texting campaign
documented - List subscriber answersGET /collective_texting/subscribers/{subscriber_id}/answers/
List answers for a subscriber
documented - List subscriber historyGET /collective_texting/subscribers/{subscriber_id}/history/
List history for a subscriber
documented - List subscriber merge-tagsGET /collective_texting/subscribers/{subscriber_id}/merge-tags/
List merge-tags for a subscriber
documented - List subscriber messagesGET /collective_texting/subscribers/{subscriber_id}/messages/
List messages for a subscriber
documented - List unread messagesGET /collective_texting/campaigns/{campaign_id}/unread/
List unread messages for a collective_texting campaign
documented - Patch contact taggingsPATCH /contacts/{id}/taggings/
Patch taggings for a contact
documented - Send subscriber SMSPOST /collective_texting/subscribers/{subscriber_id}/sms/
Send an SMS to a subscriber
documented - Update scriptPATCH /scripts/{script_id}/
Update a script
documented
Agent Console CC · 16
- Check trophy statusGET /is-trophy/
Check if user has a trophy in the CC console
documented - Delete conference agentDELETE /conference/{id}/agent
Delete conference agent
documented - Delete conference subscriberDELETE /conference/{id}/subscriber
Delete conference subscriber
documented - Delete conference supervisorDELETE /conference/{id}/supervisor
Delete conference supervisor
documented - Get campaign infoGET /campaign-info/
Get information for a CC campaign
documented - Get conferenceGET /conference/{id}
Get conference details
documented - Get current subscriberGET /current-subscriber/{id}/
Get current subscriber by ID
documented - Get script sectionsGET /script-sections/{id}/
Get script sections by ID
documented - Get subscriber historyGET /subscriber-history/{id}/
Get subscriber history by ID
documented - List agent campaignsGET /agent-campaigns/
List campaigns for an agent in the CC console
documented - Start conferencePOST /conference
Start a conference
documented - Transfer conference subscriberPUT /conference/{id}/subscriber/transfer
Transfer conference subscriber
documented - Update conference agentPUT /conference/{id}/agent
Update conference agent
documented - Update conference subscriberPUT /conference/{id}/subscriber
Update conference subscriber
documented - Update conference subscriber voicemailPUT /conference/{id}/subscriber/voicemail
Update conference subscriber voicemail
documented - Update conference supervisorPUT /conference/{id}/supervisor
Update conference supervisor
documented
Peer To Peer Texting · 9
- Add NationBuilder event to Snowflake SMS campaignPOST /sms_campaign/snowflake/{id}/nationbuilder_event/add/
Attach NationBuilder event to a Snowflake SMS campaign
documented - Add NationBuilder survey to collective textingPOST /collective_texting/{campaign_id}/nationbuilder_survey/add/
Attach NationBuilder survey to a collective texting campaign
documented - Add agents to collective textingPOST /v2/collective_texting/{campaign_id}/agents/add/
Add agents to a collective_texting campaign
documented - Add supporter section to Snowflake SMS campaignPOST /sms_campaign/snowflake/{id}/supporter-section/add/
Add a supporter section to a Snowflake SMS campaign
documented - Create P2P campaignPOST /v1/p2p_campaigns/
Create a new P2P texting campaign
documented - Create Snowflake sectionPOST /sms_campaign/snowflake/{id}/section_create/
Create a section in a Snowflake SMS campaign
documented - Duplicate P2P campaignPOST /v1/p2p_campaigns/{id}/duplicate/
Duplicate a P2P campaign
documented - Get P2P campaignGET /v1/p2p_campaigns/{id}/
Retrieve a P2P campaign by ID
documented - Update Snowflake SMS campaignPUT /v2/sms_campaign/snowflake/{id}/
Update a Snowflake SMS campaign by ID
documented
Phonebooks · 9
- Add contact to phonebookPOST /phonebooks/{id}/contacts/
Add a contact to a specific phonebook
documented - Create phonebookPOST /phonebooks/
Create a new phonebook
documented - Delete phonebookDELETE /phonebooks/{id}/
Delete a phonebook by ID
documented - List contacts in phonebookGET /phonebooks/{id}/contacts/
List contacts belonging to a specific phonebook
documented - List phonebooksGET /phonebooks/
Retrieve a list of phonebooks
documented - Phonebook numbers countGET /phonebooks/{id}/numbers_count/
Get the count of numbers in a phonebook
documented - Remove contact from phonebookDELETE /phonebooks/{id}/contacts/
Remove a contact from a specific phonebook
documented - Update phonebookPUT /phonebooks/{id}/
Update a phonebook by ID
documented - Upsert contact in phonebookPOST /phonebooks/{id}/upsert_contact/
Upsert (update/insert) a contact in a phonebook
documented
Teams · 9
- Create teamPOST /teams/
Create a new team
documented - Delete teamDELETE /teams/{id}/
Delete a team by ID
documented - Delete team agentsDELETE /teams/{id}/agents/
Remove agents from a team
documented - Get teamGET /teams/{id}/
Retrieve a team by ID
documented - Get team agent detailGET /teams/{id}/agent_detail/
Get detailed info for a team's agent
documented - List team agentsGET /teams/{id}/agents/
List agents in a team
documented - List teamsGET /teams/
List teams
documented - Update teamPUT /teams/{id}/
Update a team by ID
documented - Update team agentsPUT /teams/{id}/agents/
Update agents in a team
documented
Agent Console · 8
- Change passwordPOST /password-change/
Change user password
documented - Create SIP endpointPOST /sip-endpoint/
Create a SIP endpoint
documented - Create agent keyPOST /agent-key/
Create an agent key for console access
documented - Get NationBuilderGET /nation-builder/
Retrieve NationBuilder integration details
documented - Get agent statusGET /agent-status/
Get agent status
documented - Get user detailsGET /user-details/
Retrieve user details
documented - List SIP endpointsGET /sip-endpoint/
List SIP endpoints
documented - Update user detailsPOST /user-details/
Update user details
documented
Call Center Campaigns · 8
- Add agents to power campaignPOST /v2/power_campaign/{id}/agents/add/
Add agents to a power campaign
documented - Create power campaignPOST /v1/power_campaign/create/
Create a new power campaign
documented - Duplicate power campaignPOST /v1/power_campaign/duplicate/
Duplicate an existing power campaign
documented - Export power campaignPOST /v1/power_campaign/{campaign_id}/export/
Export data for a power campaign
documented - List call center campaignsGET /callcenter_campaigns/
List all call center campaigns
documented - List power campaign agentsGET /v2/power_campaign/{id}/agents/
List agents assigned to a power campaign
documented - Power campaign rented numbersGET /v1/power_campaign/rented_numbers/
List rented numbers available for power campaigns
documented - Update call center campaignPUT /callcenter_campaigns/{id}/
Update a call center campaign by ID
documented
Contacts · 8
- Add tag to contactPOST /contacts/{id}/tags/
Attach a tag to a contact
documented - Bulk create contactsPOST /contacts/bulk_create/
Create multiple contacts in bulk
documented - Create contactPOST /contacts/
Create a new contact in CallHub
documented - Delete contactDELETE /contacts/{id}/
Delete a contact by ID
documented - List contact fieldsGET /contacts/fields/
Get a list of all contact fields
documented - List contactsGET /contacts/
Retrieve a list of all contacts
documented - Remove tag from contactDELETE /contacts/{contact_id}/tags/{tag_id}/
Detach a tag from a contact
documented - Update contactPUT /contacts/{id}/
Update an existing contact by ID
documented
Do Not Call · 8
- Create DNC contactPOST /dnc_contacts/
Add a contact to the do-not-call list
documented - Create DNC listPOST /dnc_lists/
Create a DNC list
documented - Delete DNC contactDELETE /dnc_contacts/{id}/
Delete a DNC contact by ID
documented - Delete DNC listDELETE /dnc_lists/{id}/
Delete a DNC list by ID
documented - List DNC contactsGET /dnc_contacts/
List DNC contacts
documented - List DNC listsGET /dnc_lists/
List DNC lists
documented - Update DNC contactPUT /dnc_contacts/{id}/
Update a DNC contact by ID
documented - Update DNC listPUT /dnc_lists/{id}/
Update a DNC list by ID
documented
Relational Organising · 6
- Create relational campaignPUT /email/v_1/relational-campaign/create/
Create a relational campaign (email)
documented - Duplicate relational campaignPOST /email/v_1/relational-campaign/{campaign_id}/duplicate/
Duplicate a relational campaign
documented - Edit relational campaignPUT /email/v_1/relational-campaign/:id/edit/
Edit a relational campaign
documented - Get relational campaignGET /email/v_1/relational-campaign/:id/
Retrieve a relational campaign
documented - Update relational campaign agentPUT /email/v_1/relational-campaign/agents/:id/
Update an agent on a relational campaign
documented - Update relational campaign statusPOST /email/v_1/relational-campaign/:id/update-status/
Update status of a relational campaign
documented
Templates & Related · 6
- Create templatePOST /v1/templates/
Create a new template
documented - List integration fieldsGET /v1/integration_fields/
Get integration fields
documented - List mediaGET /v2/media
Get media assets
documented - List questionsGET /v1/questions/
Get a list of questions
documented - List shortened URLsGET /v2/shortened-urls/
Retrieve shortened URLs
documented - List templatesGET /v1/templates/
Get a list of templates
documented
Voice Broadcasts · 6
- Create VB campaignPOST /v1/vb_campaign
Create a voice broadcast campaign
documented - Create VB templatePOST /v1/vb_template
Create a VB template
documented - Duplicate VB campaignPOST /v1/vb_campaign/duplicate/
Duplicate a VB campaign
documented - Get VB templateGET /v1/vb_template
Retrieve VB templates
documented - List voice broadcastsGET /voice_broadcasts/
Retrieve voice broadcasts
documented - Update voice broadcastPUT /voice_broadcasts/{id}/
Update a voice broadcast by ID
documented
Agents · 4
Custom Fields · 4
- Create custom fieldPOST /custom_fields/
Create a new custom field
documented - Delete custom fieldDELETE /custom_fields/{id}/
Delete a custom field by ID
documented - List custom fieldsGET /custom_fields/
Retrieve all custom fields
documented - Update custom fieldPUT /custom_fields/{id}/
Update a custom field by ID
documented
Numbers · 4
- List rented calling numbersGET /numbers/rented_calling_numbers/
List rented calling numbers
documented - List validated numbersGET /numbers/validated_numbers/
List validated numbers
documented - Rent numberPOST /numbers/rent/
Rent a new number
documented - Show rented numberGET /v2/sms_number/show_rented_number/
Show details for a rented SMS number
documented