Ascendis Caller ID API

Ascendis Caller ID can interface with other applications through a push mechanism, where Ascendis Caller ID calls your executable or URL with call information, or by saving call data in a text file that your application can check periodically. These techniques are discussed below.

Ascendis Caller ID Runs Your Executable When a Call is Detected

"Actions" in Ascendis Caller ID can run an executable program when a call is detected. To make Ascendis Caller ID start a program named "ShowArgs.exe" (included with Ascendis Caller ID), create a new action to run it:

1. Open Ascendis Caller ID
2. Click the "Actions" tab in the main window
3. Click "New Action" on the toolbar, or right-click in the list of actions and select "New Action"
4. Change the "Action Name" to something meaningful, like "Test API Exe"
5. Make sure "Action Type" is set to "Easy"
6. Click the "Run Program" tab
7. Place a checkmark in the "Enable" box
8. Click the "..." button next to the "Program" box
9. Navigate to the Ascendis Caller ID Program Files folder. This is normally

             C:\Program Files (x86)\Ascendis Software\Ascendis Caller ID 4
           

10. Select the file named "ShowArgs.exe"
11. Click the "Open" button. This will select the file and close the file selection window.
12. Click the "{}" button next to the "Arguments" box
13. Select "Phone number". "{Number}" should appear in the "Arguments" box
14. Add double quotes around "{Number}" since it may contain spaces
15. Click the "OK" button in the "Edit Action" window
16. Click the "Test Action" button or right-click on the new action in the action list and select "Test Action". ShowArgs should launch and show the path to the program, and the test phone number ("(800) 555-1212").

Ascendis Caller ID Calls Your URL (in a web browser) When a Call is Detected

"Actions" in Ascendis Caller ID can pass call information to your URL when a call is detected. This is actually just a special case of running an executable program, like above. In this example, we use your system's web browser to access and show the page that gets downloaded. This is useful for testing. To do this, create a new action to run it:

1. Open Ascendis Caller ID
2. Click the "Actions" tab in the main window
3. Click "New Action" on the toolbar, or right-click in the list of actions and select "New Action"
4. Change the "Action Name" to something meaningful, like "Test API URL"
5. Make sure "Action Type" is set to "Easy"
6. Click the "Run Program" tab
7. Place a checkmark in the "Enable" box
8. Type your URL in to the "Program" box, including "{Number}" where the phone number argument should go. For example, to look up the phone number using Google, use

             https://www.google.com/search?q=%22{Number}%22
           

9. Click the "OK" button in the "Edit Action" window
10. Click the "Test Action" button or right-click on the new action in the action list and select "Test Action". Your web browser should launch and show the specified web page.

Ascendis Caller ID Calls Your URL (via wget) When a Call is Detected

"Actions" in Ascendis Caller ID can pass call information to your URL when a call is detected. This is actually just a special case of running an executable program, like above. To do this, create a new action to run it:

1. Open Ascendis Caller ID
2. Click the "Actions" tab in the main window
3. Click "New Action" on the toolbar, or right-click in the list of actions and select "New Action"
4. Change the "Action Name" to something meaningful, like "Test API URL"
5. Make sure "Action Type" is set to "Easy"
6. Click the "Run Program" tab
7. Place a checkmark in the "Enable" box
8. Click the "..." button next to the "Program" box
9. Navigate to the Ascendis Caller ID Program Files folder. This is normally

             C:\Program Files (x86)\Ascendis Software\Ascendis Caller ID 4
           

10. Select the file named "wget.exe"
11. Click the "Open" button. This will select the file and close the file selection window.
12. Type your URL in to the "arguments" box, including "{Number}" where the phone number argument should go. Your URL might look like this:

              "https://mydomain.com/call.php?phone={Number}"
            

    You probably need the double quotes around the URL because {Number} may be replaced with a phone number containing spaces.
13. Click the "OK" button in the "Edit Action" window
14. Click the "Test Action" button or right-click on the new action in the action list and select "Test Action". wget.exe should open in a console window, output some text, and then the window will disappear. To retain a copy of the output, add the "-o {filename}" argument. Run

    wget.exe --help

    in a console window for more options.

SDK (Software Development Kit)

We don't offer an SDK for Ascendis Caller ID, since all you need is the normal Ascendis Caller ID program, and perhaps this web page.

 

Send comments or questions about web site to webmaster@ascendis.com

Modified January 13, 2022, 12:59 pm