Add contacts

API Docs by APIMATIC

Add contacts
#

  • REST
  • Java

Add contacts
#

Add Contacts
#

The Add Contacts API is part of Voiso's Campaigns APIs. Use it to add new contacts/leads to an existing live Dialer campaign. The API endpoint description is here.

Prerequisites
#

  • The Dialer campaign must have the Live campaign setting enabled.
  • The campaign ID, which can be obtained by using List Campaigns API request or from the Outbound > Campaigns page.
  • A source for contacts/leads, such as a CRM or Helpdesk, and a list of one or more contacts to be added to the campaign.
  • A valid phone number for each contact in E.164 format without the preceding '+'. For example: 441234567890.

Making requests
#

The Add contacts API requires the base URL (cluster_id) and the contact center API key.

It uses the following parameters to initiate a call:

The api_key parameter is the contact center API key.

The campaign_id parameter is the ID of the campaign, which can be obtained by using List Campaigns API request or from the Outbound > Campaigns page.

The phoneNumber parameter is the phone number of the contact.

The number must be specified in E.164 format without the preceding '+'. For example: 4407414992548

The optional contactName parameter is the name of the contact associated with the phone number.

The optional contactSource parameter is the source of the contact information, for example "Salesforce", "HubSpot", "Google", "Trade Show", "Direct mail", and so on.

The optional contactURL parameter is the URL of the support CRM to allow screen popping the contact's record. For more information about Voiso support for CRM screen pop, refer to CRM integration overview.

The optional priority parameter is the priority of the contact for calling purposes. Priority ranges from 0 to 1000, where lower values equal higher priority. 0 is the highest calling priority for Dialer.

With these parameters, you can make a cURL POST request:

POST https://cluster1.voiso.com/api/v1/ab7a556b6...bb00cc6c3/campaigns/25735/contacts 

Request body:
{
    "contacts": [
        {
            "phoneNumber": "4407414992548",
            "contactName": "Bill Bringy",
            "contactSource": "CRM",
            "contactURL": "https://myurl.com"
            "priority": "1"
        },
        {
            "phoneNumber": "4407415552548",
            "contactName": "Alicia Gonzales",
            "contactSource": "CRM",
            "contactURL": "https://myurl.com"
            "priority": "2"
        }
    ]
}

Note: you may have multiple contacts parameters.

Troubleshooting
#

The following issues are sometimes encountered:

Invalid Key
#

The Add Contacts API requires the user API key to validate the request. If you see this error, "error": "Invalid Key", check that you are using the correct user API key. For more information about API keys, refer to Authentication.

Campaign not found
#

If you see this error, "error": "Campaign not found", the campaign ID that you specified in the request URL does not exist in your contact center or is not accessible to the user.

To verify the campaign ID, use the List Campaigns API to request it, or from the Outbound > Campaigns page, find the campaign ID in the Campaigns table.

To verify that the user has access to the specified campaign, check the user profile associated with the API request. The Edit all campaigns or Edit own campaigns permissions must be assigned to the user's profile.

Campaign type should be live
#

If you see this error, "error": "Campaign type should be live", the Live campaign option is not enabled for the specified campaign. To set this option, from the Voiso main menu bar, navigate to Outbound > Dialer campaigns and select the campaign. On the Edit campaign page, select Live campaign and save the campaign.

Maximum limit of 1000 contacts for each request
#

If you see this error, "error": "Maximum limit of 1000 contacts for each request", your POST request is attempting to add more than 1000 contacts to the campaign. To add more than 1000 contacts, make multiple requests of up to 1000 contacts each.

Required contact field missing
#

If you see this error, "error": "Required contact field missing - phoneNumber", there is no phone number available for one or more of the contacts you are trying to add to the campaign. Please ensure that you have a phone number for every contact you add to the campaign.