Punch API - Setting up Caller ID on USTelePunch

If you are using a Hosted Voice Clock service directly setup through US Telepunch (not through SwipeClock) this article will explain how to setup Caller ID service. Users of SwipeClock's Hosted Voice Clock service that want to setup Caller ID can see Hosted VoiceClock for instructions on setting up caller ID to appear on the time card.

The PunchAPI is what USTelePunch uses for their service requires steps to enable exporting Caller ID usually to a job code clock prompt on the employee time card.

To do so you will need to have either the x, y or z job code prompt(s) available and configured to pull this information in. "Numeric" or "Web only" prompts will NOT work. 

As we can pull in either the IN or OUT or both IN and OUT Caller ID information you can set up multiple prompts to pull this information in separately. For example the IN could go to the X prompt and the OUT to the Y prompt.

Setting up the clock prompt would be as follows. Using the x prompt as our example:
  1. You can find the Clock Prompts sections:
    1. Under TimeWorks Plus go to Settings Menu > Processing Rules select the "ClockPrompts" rule. You may have to do a search for this if it is not currently active and showing in your list.
    2. Under TimeWorks go to Accountant Menu > Clock Prompts.
  2. Next select the "Add Prompt" button.
  3. In the "Prompt Assignment" as stated you will be picking one of the job prompts this works against (x, y or z). In our example we are selecting the x job code prompt.
  4. Under "Data Collection Mode" we will want to set it to "Show online, but do not collect anything". We do this so the employee is not prompted for this information at the clock as the caller ID will be pulled in directly through the API.
  5. For the "Name of field" you will want to put in the corresponding letter of your clock prompt in upper case or in our example "X" (no quotes). If you were using another of the 3 available like "y" or "z" you would enter in their matching letter in capital letters ("y" would have "Y" and "z" we would enter in "Z").
  6. In the "How field name is displayed in column headers" name the column heading to what you want. An example of this would be "Caller ID" or "Caller ID IN".
  7. The "Question to be displayed on clocks" field can either be left blank or you can just duplicate the entry you put in in step 6.
  8. "Color restriction" should be set to the default "No restriction".
  9. "Visible/Editable" should be set to "Visible, Not Editable" as we want to see the phone number but not allow this number to be manually edited.
  10. "WebClock 2.0 Display Behavior" should be also set to the default of "Avoid showing prompt on Web Clock".
  11. "What should happen if the employee doesn't enter anything for the clock prompt?" should be set to "Allow it".
  12. "Length of Entry" can be left as is with the minimum set to "0" and max set to "12".
  13. Please ensure the "Prompt List" is blank.
  14. "Type of Entry" is suggested that you switch it "Alphanumeric" but can be left as "Numeric Only" and it should still work.
  15. Save your prompt.

After this you will then need to coordinate what information (the caller ID of the IN punch or the caller ID of the OUT punch) you want pulled into the prompt(s) directly with USTelePunch and they will set this up on their end to push this information to the appropriate prompt(s).

Did you find this article helpful?