RightFax COM API --> Web API conversion setting UniqueId

mcrose
mcrose
in Cloud Fax and Notifications #1

I'm converting a COM API client to WebAPI, and encountering a problem setting UniqueId when sending a fax.

In COMAPI we would create a Fax Object, add attachments and set the fax.UniqueId, add attachments, set phone and send
RFCOMAPILib.Fax fx = faxServer.CreateObject[RFCOMAPILib.CreateObjectType.coFax];fx.UniqueID = mps.Ssendid;
fx.Attachments.Add(tiffName, RFCOMAPILib.BoolType.False);
fx.UniqueID = "ourJobId";
fx.ToFaxNumber = "5551212";
…
fx.Send();

In WebAPI we create a SendJob, set the same parameters except UniqueId which is not a property of SendJob. So after we PUT the SendJob, we retrieve the Documents for the SendJob and PUT the Document back to the WebAPI.

Well, it turns out I can set the the FolderId, but the UniqueId does not get set, and I can't add Tags with the Document PUT either.

Any ideas how to set a value on the outbound fax so when I come back to review the status of the Faxes (Documents) I can get my key "outJobId" back?

Tagged:

Best Answer

  • Prabhakr_2018
    Prabhakr_2018 E Member
    #2 Answer ✓

    This forum is for CLOUD FAX and NOTIFICATIONS.

    However we reached the respective team and below is their reply

    In the SendJob, the Tags dictionary can be used to attach custom tags to a job. Tags are copied to every document created by that job, so you can look for those tags in documents to related them back to the SendJob. 

    Prabhakaran R
    OpenText

Answers

  • Prabhakr_2018
    Prabhakr_2018 E Member
    #3 Answer ✓

    This forum is for CLOUD FAX and NOTIFICATIONS.

    However we reached the respective team and below is their reply

    In the SendJob, the Tags dictionary can be used to attach custom tags to a job. Tags are copied to every document created by that job, so you can look for those tags in documents to related them back to the SendJob. 

    Prabhakaran R
    OpenText

  • mcrose
    mcrose
    #4

    And adding one particular Tag to the the SendJob, UniqueID, propogates to the Documents.UniqueID.

    I haven't looked at the Document.Tags yet, adding the UniqueID Tag to the SendJob
    SendJob.Tags.Add("UniqueID", "myuniqueid");
    before POSTing the SendJob, results in the Document.UniqueID being updated to "myuniqueid".

    Can the respective team let me know if these backdoors are documented anyplace, or do we just have to ask the right people?

  • Prabhakr_2018
    Prabhakr_2018 E Member
    #5

    Below is the reply from the respective team.

    Here's a list of SendJob tags that provide useful functionality:

    FromName

    FromVoiceNumber

    FromFaxNumber

    BillingCode1

    BillingCode2

    Notes

    Comment

    Comments

    CoversheetNotes

    CoversheetComment

    FromPhoneNumber

    CoversheetFineMode

    FineModeBody

    FromCompanyVoiceNumber

    FromCompanyFaxNumber

    UseSmartResume

    CreatePdfImage

    CityState

    RecipientFaxId

    AutomaticallyDelete

    UseCertifiedDelivery

    NotificationAddress

    UseCheapRates

    UniqueId

    I thought these tags were documented in the API swagger docs; if not, they should be added.

    Any more queries Please raise a ticket to Support Team.

    Prabhakaran R
    OpenText

Categories