Retrieve a list of fax numbers

Hi! I'm trying to retrieve a list of fax numbers from opentext (fax2mail). I've already loaded up the wsdl for ListRetrieve. Below is a snippet of my source code:

Request header = new Request();

    Request.Authentication auth = new Request.Authentication();
    // Create XDDSAuthType which is the object that holds the user credentials (username, password, alias)
    XDDSAuthType xddsAuth = new XDDSAuthType();
    // create UIDType for username
    UIDType uidType = new UIDType();
    uidType.setValue("<username>");
    xddsAuth.setRequesterID(uidType);
    xddsAuth.setPassword("<password>");
    auth.setXDDSAuth(xddsAuth);
    header.setAuthentication(auth);

    ListRetrieveRequest requestParameter = new ListRetrieveRequest();

    Holder<ListRetrieveResult> responseParameter = new Holder<>();
    Holder<Response> responseHeader = new Holder<>();

    try {
        new ListRetrieveService().getListRetrievePort().listRetrieve(requestParameter, header, responseParameter, responseHeader);  
    } catch(Exception e) {
        System.out.println("listservice exception: " + e.getMessage());
    }

I'm getting an exception here: Client received SOAP Fault from server: Error in parsing Please see the server log to find more detail regarding exact cause of the failure.

The documentation for EasyLink isn't user friendly. I wish there's an overview page where there will be a demonstration on how to call the services. Also a documentation on the ListID does not exist anymore:

_** Identifies the stored list to be retrieved. See ListIdType.**_

When I click on the ListIdType, it takes me to another page explaining you've moved to a new forum. But when I click on the site specified in the here text, it says Permission Problem. I don't have permission to do that.

For the ListRetrieveRequest, I didn't fill up the 3 optional parameters since I just want to try first if I can retrieve the list of fax numbers. Also, I don't know what to put for the ListIdType because the documentation does not exist. Can you guide me on how to make a successful pull of all the fax numbers from my fax2mail list (of fax numbers)?

Best Answers

Answers

  • Hi

    ListRetrieve will only retrieve the list which is already created by using ListCreateRequest API.This will contain the fax numbers.
    So First you need to call listcreateRequestAPI. then you can retrieve the list using the list retrieve API.

    Sample Request files for ListCreate and ListRetrieve are attached.

    Prabhakaran R
    OpenText

  • Desmond_Sloan
    edited February 27, 2019 #5

    Hi @Prabhakr_2018 I already have a list of fax numbers from the Opentext portal: https://myportal.opentext.com/XddsPortal/#ManageListsPlace.
    I created the list of fax numbers from the manage lists dashboard.

    Shouldn't this already be pulled using the ListRetrieve and ListLists endpoint?

  • Yes they can be pulled using the list retrieve and listlist.I have attached the sample request for list retrieve in the above comments. PFA sample request for listlist

    Prabhakaran R
    OpenText

  • Hi @Prabhakr_2018 thank you for your response. I'm not sure if I'm doing this right so please guide me. Here's what I did. We have an account here in https://myportal.opentext.com/XddsPortal/. On this page: https://myportal.opentext.com/XddsPortal/#ManageListsPlace: I can see the list of fax numbers we created from this page. I was thinking I can use the ListLists API to retrieve the lists of fax numbers from that page. I tried using the listlist sample request you uploaded above but I still can't get the proper response I need (which is the list of fax numbers). For the RequesterID and Password, I placed there the username and password of our myportal.opentext.com account. For the SubmitID, since it's just an optional string, so I just placed a random text: submitID.

    This is an excerpt of the error I received from the ListLists API:



    Container for Errors





    An Error





    non-zero code











    The time the Request was received by the system




    the time the Request was completed processing

    Please help me figure this out. Thanks!

  • Hi

    There is some misunderstanding regarding https://myportal.opentext.com/XddsPortal/#ManageListsPlace
    This will not contain the list of fax numbers. This page will contain recipient lists(file) which might contain faxnumber/email address/phonenumber. This list name can be anything(alphabets or numbers).If the file is saved with filename as fax number then fax number will be shown as output. But this is not the actual recipient list. when we click on particular list link, This will show the exact recipient list where fax can be sent.

    Sample output seen for https://myportal.opentext.com/XddsPortal/#ManageListsPlace for my account is attached.

    If you want to view a particular list for e.g emailportal in my case will give the details for recipient email address. Attached screen shot of the email list output.

    So listlistapi will give the list of files(recipient list) created using list create api.
    Attached sample response for listlistrequest api.


    0
    OK
    2019-03-06T05:19:36.218Z
    2019-03-06T05:19:36.501Z

    listlists 016

    .f2m_recip_list.22000
    2017-03-07T18:52:14.000Z


    emailtest
    2016-08-17T02:28:30.000Z
    </ListInfo

    Here emailtest,.f2m_recip_list.22000 are the filenames of the list that may contain either fax number or phone number or the email id depend upon the type of list(fax list or sms list or email list)

    Please note that you need to submit the request to https://int-messaging.easylink.com/soap/sync url using post man client tool or any soap ui tool

    NOTE: To understand the manage list functionality what it exact does. There will be help page present in the top right corner of https://myportal.opentext.com/XddsPortal/#ManageListsPlace page(usally it will be ? symbol) which have 3 links,i.e user guide, quick reference quide and release note which will have the usage of list.

    Prabhakaran R
    OpenText

  • Desmond_Sloan
    edited March 6, 2019 #9

    Hi @Prabhakr_2018 thank you for clarifying things up. If the ListLists is not the proper API I need to use to get the list of fax numbers created in the ManageListsPlace, then which API should I be calling? We don't need the ListCreate API because we won't create the list on our end, we'll let the users create the list from the ManageList page of myportal.opentext.com. Basically, my goal is to be able to retrieve the list of fax numbers from the ManageListsPlace page and load up those fax number list on our UI.

  • Hi @Prabhakr_2018 thank you for clarifying things up. Okay, if ListLists is not the proper API to call if I want to get the list of fax numbers created from the ManageListsPlace page, then which API should I call? We don't need to call the ListCreate API because we aren't going to create the fax number list from our platform. We'll let the users create the fax number list from the ManageListsPlace. My goal here is to be able to retrieve those list of fax numbers from the ManageListsPlace page.

  • Okay, I get it now. Thanks again. BTW, the response from https://int-messaging.easylink.com/soap/sync says:
    XOA-2909 [User authentication not accepted] : login not permitted: Invalid RequesterID or Password
    I used our account from https://myportal.opentext.com. Why does it say the RequesterID or Password is invalid? Aren't the accounts from myportal.opentext supposed to work with the easylink APIs?

  • Prabhakr_2018
    edited March 6, 2019 #13

    Please see the attached sample on how to pass the requestor id and password

    Prabhakaran R
    OpenText

  • Hi @Prabhakr_2018 . Thanks for your help. I was finally able to pull the fax numbers!

  • Hi

    There is some misunderstanding regarding https://myportal.opentext.com/XddsPortal/#ManageListsPlace https://10-0-0-1.com
    This will not contain the list of fax numbers. This page will contain recipient lists(file) which might contain faxnumber/email address/phonenumber. This list name can be anything(alphabets or numbers).If the file is saved with filename as fax number then fax number will be shown as output. But this is not the actual recipient list. when we click on particular list link, This will show the exact recipient list where fax can be sent.

    Sample output seen for https://myportal.opentext.com/XddsPortal/#ManageListsPlace http://www.192168-1-1.info/ for my account is attached.

    If you want to view a particular list for e.g emailportal in my case will give the details for recipient email address. Attached screen shot of the email list output.

    So listlistapi will give the list of files(recipient list) created using list create api.
    Attached sample response for listlistrequest api.


    0
    OK
    2019-03-06T05:19:36.218Z
    2019-03-06T05:19:36.501Z

    listlists 016

    .f2m_recip_list.22000
    2017-03-07T18:52:14.000Z


    emailtest
    2016-08-17T02:28:30.000Z
    </ListInfo

    Here emailtest,.f2m_recip_list.22000 are the filenames of the list that may contain either fax number or phone number or the email id depend upon the type of list(fax list or sms list or email list)

    Please note that you need to submit the request to https://int-messaging.easylink.com/soap/sync https://www.192168-1-1.info/ url using post man client tool or any soap ui tool

    NOTE: To understand the manage list functionality what it exact does. There will be help page present in the top right corner of https://myportal.opentext.com/XddsPortal/#ManageListsPlace page(usally it will be ? symbol) which have 3 links,i.e user guide, quick reference quide and release note which will have the usage of list.

    You solved my issue, thank you!