Public API Changes

Updated /SmsSend Documentation on the NewIO Page

Overview: API Maintenance

We have updated the documentation of /SmsSend on the NewIO page to better represent the actual maximum character account that is allowed when considering the footer count.

• Documentation of the content field in /SmsSend should be revised to state:

  • The content of the SMS. Please note that accounts using the consent footer will actually be limited to a maximum of 597 characters as each message will include the following footer (which equates to 73 characters): "To stop receiving these messages, reply STOP. Msg&Data rates may apply.”

  • Maximum character length is 670.  This is required.

Support Additional FaxOemSend Validation Failures

Overview: API Maintenance

As a public api vendor calling the FaxOemSend api, I need a way to get back information related to validation failures instead of receiving the system error code (5000) which is what we return when we had an unexpected failure on our end.

• Sending to a country code that isn’t 1 is not allowed:

  • Only applies to 11 digit numbers

  • Should return 4060 

  • Error message in the response and doesn’t require modification

    • Example: Faxing to or from number "35555555555" is not currently allowed; only numbers with a country code of "1"  are supported at this time

• Sending to all 0’s to number

  • known invalid number

  • would return 4060 

  • Error message would need to be added: Invalid fax number 

  • Currently allowed but fails after the fact when we try to send:

    • We make multiple attempts to deliver this plus we convert and store the document. Silly.

    • if this is too much of a behavior change, we can pull to its own ticket but would prefer we include it

• Sending > 11 digits:

  • Should return 4060

  • Error message in the response and doesn’t require modification

    • Example: Number "000000000000" must be 10 or 11 digits in length

Create Active Account List CSV Export from Partner Portal

Overview: API Maintenance

We have created a way to export an active account list as a CSV file for Partner Portal users.

• Created a new menu option called “Reports”

• Created a process to generate a CSV file with the following fields:

  • name

  • emr_account_id (spell out column name as ‘Account ID’ in CSV output)

  • phone number

  • fax number

  • address1

  • address2

  • city

  • state / province 

  • postal

  • country

• This will only include active accounts

• Export will be initiated from a button the Reports section of Partner Portal

  • Top of the page will say “Reports” 

  • Button will be named “Export Active Account List”

• Export can only be run by Partner Portal users with an Admin or Super Admin role. 

• Export needs to be logged in the (existing) Audit Log

Partner Portal

Create Active Account List CSV Export from Partner Portal

Overview: New Report

A CSV export of active accounts can be initiated initiated from a button the Reports section of Partner Portal by an Admin.