+1-800-948-1198
Cloud Log In Free Trial

Web Interface API

When running a dynamic campaign, you can remotely add CRM records through our web interface API by submitting an HTTP POST or GET to the Voicent Gateway. Once added, they can be interacted with within a dynamic campaign.

If you have a dynamic campaign configured to call "New Leads" then you can actively submit new CRM records with the "New Leads" category to actively be called. Once that record has been called, your call disposition rule may change it to "Answering Machine", "Bad Number", "Busy" , or "Not Interested" which will cause it to not be called again. You can configure other dynamic campaigns to call other categories/dispositions.

Target Voicent Gateway Server: http://localhost:8155/vxcrm.jsp

Replace localhost with the applicable IP address if submitting from another computer other than the server machine directly. Additionally, if you changed the default port from 8155 please change as necessary.

Name & Value pairs:

  • action: Specify an action. Applicable actions are: add, get, delete
  • passwd: Specify the web password. Default is crmweb
  • dcuser: Will always be 0
  • first_name: Specify a first name
  • middle_name: Specify a middle name
  • last_name: Specify a last name
  • email: Specify an email address
  • email2: Specify an email address
  • fax: Specify a fax number
  • home_phone: Specify a phone number
  • work_phone: Specify a phone number
  • work_phone_ext: Specify an extension to the work phone field
  • cell_phone: Specify a phone number
  • other_phone: Specify a phone number
  • business: Specify a business
  • job_title: Specify a job title
  • do_not_call: Specify if this user requested to not be called. Actions are: yes or no
  • do_not_email: Specify if this user requested to not be emailed. Actions are: yes or no
  • merge: Depending on if you want your CRM record merged with existing records that match the phone number. Actions are: yes or no
  • customer_catname: Specify the category of your customer. This field is useful for controlling dynamic campaigns.
  • home_street: Specify a street
  • home_city: Specify a city
  • home_state: Specify a state
  • home_zipcode: Specify a zipcode
  • home_country: Specify a country
  • work_street: Specify a street
  • work_city: Specify a city
  • work_state: Specify a state
  • work_zipcode: Specify a zipcode
  • work_country: Specify a country

Additional Name & Value pairs for custom fields:

  • cf_1: Value for your custom field
  • cf_2: Value for your custom field
  • cf_3: Value for your custom field
  • cf_4: Value for your custom field
  • cf_5: Value for your custom field
  • cf_6: Value for your custom field
  • cf_7: Value for your custom field
  • cf_8: Value for your custom field
  • cf_9: Value for your custom field
  • cf_10: Value for your custom field
  • cf_11: Value for your custom field
  • cf_12: Value for your custom field
  • cf_13: Value for your custom field
  • cf_14: Value for your custom field
  • cf_15: Value for your custom field
  • cf_16: Value for your custom field
  • cf_17: Value for your custom field
  • cf_18: Value for your custom field
  • cf_19: Value for your custom field
  • cf_20: Value for your custom field

Response after submitting

In order to determine if the CRM record was created you will be returned a digit with two square brackets like: [341]. This is the users CRM record ID. If the response does not contain a digit with brackets then Voicent did not find or create a CRM record.