Difference between revisions of "API Method FaxBulkSend"

Revision as of 18:03, 30 June 2015

Description

The following describes the processes involved in a new bulk fax.

Prerequisites

1 This API call requires Vendor-level credentials. The credentials should be populated into the applicationId and applicationPassword fields of the auth block:

 {
   ...
   "auth": {
     "applicationId": "vendorId",
     "applicationPassword": "vendorPassword",
     "accountId": "",
     "userId": ""
   }
 }
 
 

2 This API call requires a Practice/Account-level identifier. The identifier should be populated into the accountId field of the auth block:

 {
   ...
   "auth": {
     "applicationId": "vendorId",
     "applicationPassword": "vendorPassword",
     "accountId": "practiceId",
     "userId": ""
   }
 }

Messages

Destination Address

 https://updoxqa.com/io/faxBulkSend

Request JSON

   "recipientFaxNumbers": [
       "123-456-7890",
       "(123) 456-7890"
   ],
   "fromName": "Us",
   "fromFaxNumber": "123-456-7890",
   "faxContent": "OurSpecialFax"

HTTP Response Status

 200 OK

Response JSON

 "successful": true,
 "responseMessage": "OK",
 "responseCode": 2000,
 "bulkSendId": 5,
 "validFaxCount": 1,
 "invalidFaxNumbers": []

Response Codes

2000: OK

4000: Bad Request

4010: Unauthorized (bad applicationId or applicationPassword)

4011: Unauthorized (bad accountId)

4060: Field validation error -- Message varies

4931: BulkFaxId does not exist or is unrelated to current practice