Dialers Logo API v2.0

Introduction

Welcome to the Dialers API documentation.
Here you’ll find everything you need to access the Dialers API.

Obtain your API token in the integrations section of your account. Your Token must be included in an HTTP Authorization Header or your request will be denied. Limit of 5 requests per second.

Example HTTP header:

Key: Authorization

Value: token {API Key}

Caller ID

List all callerid objects

Get /api/callerid/

Get 1 callerid object

Get /api/callerid/{id}/

Create callerid object

Post /api/callerid/create/

Required post data:

  • Cnam

Optional post data:

  • name
  • group_ids : id’s of calleridgroups objects in a list format. ex: [1,2,3]

Curl Example:


curl --user "APITest\API.User" --request GET https://dialers.com/api/callerid/create/

{
    "elements": [
{
    "type": "Contact",
    "id": 1,
},
{
    "type": "Contact",
    "id": 2,
}
],
    "page": 1,
    "pageSize": 2,
    "total": 527
}
                        

Python Example:


import requests

token = ""
url = 'https://dialers.com/api/callerid/create/'
headers = {
    'Authorization': 'JWT {}'.format(token),
    'Accept': 'application/json',
    'Content-Type': 'application/json',
}

payload = {
    'account': '12345678',
    'phone': '2345555555',
    'notes': 'Test caller id'
}

r = requests.post(url, headers=headers, json=payload)

                        

Update callerid object

Post /api/callerid/{id}/update/

Required post data:

  • Cnam

Optional post data:

  • name
  • group_ids : id’s of calleridgroups objects in a list format. ex: [1,2,3]

Delete callerid object

Post /api/callerid/{id}/delete/

OR

Post /api/callerid/delete/?phone_number={phone_number}

Validation Call

Get /api/callerid/{id}/validation-call/

Request Manual Validation

Get /api/callerid/{id}/validation-request/

Caller ID Group

Create calleridgroup

Post /api/calleridgroup/create/

Required post data:

  • Name

Optional post data:

  • callerid_ids : id’s of callerid objects to include in a list format. ex: [1,2,3]

Update calleridgroup

Post /api/calleridgroup/{id}/update/

Optional post data:

  • Name
  • callerid_ids : id’s of callerid objects to include in a list format. ex: [1,2,3]

List all caller id groups

Get /api/calleridgroup/

Get 1 calleridgroup object

Get /api/calleridgroup/{id}/

Do Not Call List

Add to do not call list

Post /api/donotcall/{phone_number}/create/

Check if a number is on the do not call list

Get /api/donotcall/{phone_number}/

Delete from the do not call list

Post /api/donotcall/{phone_number}/delete/

Leads

Add a lead to a file

Post /api/leads/

Required post data:

  • phone_number : 11 digit USA phone number
  • file : the file_id of the file to add this lead to

Optional post data:

  • federal_scrub : 1 to scrub. 0 to not scrub.
  • company_scrub : 1 to scrub. 0 to not scrub.
  • mobile_scrub : 1 to scrub. 0 to not scrub.

Campaigns

Single campaign call

Post /api/campaign/{id}/call/

Required post data:

  • phone_number: 11 digit usa phone number

Get campaign object

Get /api/campaign/{id}/

Get all campaign objects

Get /api/campaign/

Update campaign object

Post /api/campaign/{id}/update/

Optional Post Fields:

  • name : name of the campaign. 1 - 50 characters allowed.
  • dial_rate_type : choices are: max_channels , max_channels_per_agent
  • channels : number of channels to run. Must be a integer
  • external_agents : number of external agents to be factored with in channels when dial_rate_type is max_channels_per_agent
  • callerid_type : choices are: single, group_random, group_localmatch, group_statematch
  • callerid : id of the callerid object to set for this campaign.
  • callerid_group : id of the calleridgroup to set for this campaign
  • call_recording : 0 for off and 1 for on. Enable and disables campaign call recording of transfers
  • live_audio : the audiofile object id that you would like to use for live answer calls
  • vm_audio : the audiofile object id that you would like to use for voice mail calls

Optional Post Fields:

  • name : name of the campaign. 1 - 50 characters allowed.
  • channels : number of channels to run. Must be a integer
  • voice_mail_callerid_type : choices are: single, group_random, group_localmatch, group_statematch
  • voice_mail_callerid : id of the callerid object to set for the voice mail drop leg of this campaign
  • voice_mail_callerid_group : id of the calleridgroup to set for the voice mail drop leg of this campaign
  • missed_callerid_type : choices are: single, group_random, group_localmatch, group_statematch (ringless)
  • missed_callerid : id of the callerid object to use for ringless missed call leg
  • missed_callerid_group : id of the calleridgroup to use for ringless missed call leg
  • vm_audio : the audiofile object id that you would like to use for voice mail calls

Campaign Start

Post /api/campaign/{id}/start

Campaign Stop

Post /api/campaign/{id}/stop

Phone Lists

Get phone list object

Get /api/phonelist/{id}/

Get all phone list objects

Get /api/phonelist/

Audio Files

Get audio file object

Get /api/audiofile/{id}/

Get all audio file objects

Get /api/audiofile/
curl python