Send SMS in C# using the 2.5 API - the request failed with an empty response.

Hi,

I am trying to integrate messaging API as part of us moving from the old system to the new one.Did some research on the forum and adapted the C# code. No matter what I try the application throws an expection at this line:

JS_Result = EM.JobSubmit(JS_Request);

The exception message is: the request failed with an empty response.

Please see below the code I am using, any help would be greatly appreciated!!

Thanks,

Roy

[WebMethod]
        public void SendSMS(string PhoneNumber, string Message, string CustomerReference,string BillingCode, string Challenge)
        {
            string DocDataValue = "CONTENT TYPE EMAIL" + Environment.NewLine + "/SMS " + PhoneNumber + Environment.NewLine + "BC: " + BillingCode + Environment.NewLine + "Cref: " + CustomerReference + Environment.NewLine + "BT " + Environment.NewLine + Message;


            //JobSubmitRequest SMS Options
            // setup EMsgAPI object - EM
            JobSubmitWS.JobSubmitService EM = new JobSubmitWS.JobSubmitService();


            // setup Authentication objects
            JobSubmitWS.RequestAuthentication reqAuth = new JobSubmitWS.RequestAuthentication();
            JobSubmitWS.XDDSAuthType XDDSAuth = new JobSubmitWS.XDDSAuthType();
            JobSubmitWS.UIDType uid = new JobSubmitWS.UIDType();

            // init Authentication objects
            // init Authentication objects
            XDDSAuth.Password = "Password";
            uid.Value = "username";
            XDDSAuth.RequesterID = uid;
            reqAuth.Item = XDDSAuth;

            // Setup MessageObject
            JobSubmitWS.MessageType[] JS_Message = new JobSubmitWS.MessageType[1];
            JS_Message[0] = new JobSubmitWS.MessageType();

            // Setup JobOptions - Voice and CRef
           JobSubmitWS.JobOptionsType JS_JobOptions = new JobSubmitWS.JobOptionsType();
           JobSubmitWS.EncodableStringType JS_CRef = new JobSubmitWS.EncodableStringType();
           JobSubmitWS.SmsOptionsType JS_SMSOptions = new JobSubmitWS.SmsOptionsType();

            // set CREF and Billing Code
           JS_CRef.Value = CustomerReference;
            JS_JobOptions.CustomerReference = JS_CRef;

            // Set SMS Options
            //JS_SMSOptions.ExpirationDaysSpecified = false;

            // Set JobOptions as SMSOptions
            JS_JobOptions.SmsOptions = JS_SMSOptions;

            // Set Message Object
            JS_Message[0].JobOptions = JS_JobOptions;

            // Free Objects
            JS_JobOptions = null;
            JS_SMSOptions = null;
            JS_CRef = null;

            // Setup Documents
           JobSubmitWS.DocumentType[] JS_Documents = new JobSubmitWS.DocumentType[1];
            JS_Documents[0] = new JobSubmitWS.DocumentType();

            // Setup reusable variables for the document
            JobSubmitWS.DocDataType DocData = new JobSubmitWS.DocDataType();
            DocData.format = JobSubmitWS.DocEncodingFormat.text;
            DocData.Value = DocDataValue;

            // Setup Document 1 - Text to be delivered to SMS Device
            JS_Documents[0].Item = DocData;
            JobSubmitWS.EncodableStringType myFileName = new JobSubmitWS.EncodableStringType();
            myFileName.Value = "text.txt";
            JS_Documents[0].Filename = myFileName;
            JS_Documents[0].DocType = "text";
            JS_Documents[0].ItemElementName = JobSubmitWS.ItemChoiceType.DocData;
            JS_Documents[0].@ref = "TextMessage";
            DocData = null;

            // Setup Content
            JobSubmitWS.ContentPartType[] JS_Content = new JobSubmitWS.ContentPartType[1];
            JS_Content[0] = new JobSubmitWS.ContentPartType();

            JS_Content[0].Item = "TextMessage";
            JS_Content[0].Treatment = JobSubmitWS.TreatmentType.body;
            JS_Content[0].TreatmentSpecified = true;

            // Setup Destination
            JobSubmitWS.SmsType[] delivery = new JobSubmitWS.SmsType[1];
            delivery[0] = new JobSubmitWS.SmsType();
            delivery[0].Phone = PhoneNumber;
            delivery[0].@ref = "Phone Number Entered";

            // Setup Report Options
            JobSubmitWS.ReportOptionsType JS_Report = new JobSubmitWS.ReportOptionsType();
            JobSubmitWS.ReportOptionsTypeDeliveryReport DeliveryReport = new JobSubmitWS.ReportOptionsTypeDeliveryReport();
            DeliveryReport.DeliveryReportType = JobSubmitWS.MainReportTypeEnum.none;
            JS_Report.DeliveryReport = DeliveryReport;

            // Setup Request and JobSubmitRequest object
           JobSubmitWS.Request Request = new JobSubmitWS.Request();
         JobSubmitWS.Response Response = new JobSubmitWS.Response();
            JobSubmitWS.JobSubmitRequest JS_Request = new JobSubmitWS.JobSubmitRequest();
           JobSubmitWS.JobSubmitResult JS_Result = new JobSubmitWS.JobSubmitResult();

            // Everything is Setup Prepare to Launch Job


            // Assign Reqeust and Response objects to EM Object
            EM.RequestValue = Request;
            EM.ResponseValue = Response;
            JS_Request.Message = JS_Message;
            JS_Request.DocumentSet = JS_Documents;
            try
            {
                JS_Result = EM.JobSubmit(JS_Request);
            }
            catch (Exception ex)
            {
                System.Console.WriteLine(ex.Message);
                System.Console.Read();
                return;
            }

            if (JS_Result.Status.StatusCode != null)
            {
                string JobNumber;
                JobNumber = JS_Result.MessageResult[0].JobId.XDN + ":" + JS_Result.MessageResult[0].JobId.MRN;
                //txtJobNumber.Text = JobNumber;
            }

            string emfilename = "emresponse.xml";
            string resfilename = "result.xml";
            //string reqfilename = "request.xml";
            try
            {
                //This will output the response, result and request(if uncommented) to XML files in the
                //installed directory. This can be very usefull for debugging or ir help is requested from
                //the EMAPI support team

                    serializeResult(emfilename, EM.ResponseValue);
                    serializeResult(resfilename, JS_Result);
                    //serializeResult(reqfilename, JS_Request);

            }
            catch (System.IO.IOException io_error)
            {
                //MessageBox.Show("Error - " + io_error, "Error", MessageBoxButtons.OK);
            }
        }

        static void serializeResult(String filename, System.Object res)
        {
            System.Xml.Serialization.XmlSerializer x = new System.Xml.Serialization.XmlSerializer(res.GetType());
            System.IO.TextWriter w = new System.IO.StreamWriter(filename);
            x.Serialize(w, res);
            w.Close();
        }

Find more posts tagged with

Comments

skamens

What URL are you using to access the service? I don't see that noted in the code snippet above...

vgssupport

Hi skamens,

Do you mean what web reference I am using? if so, JobSubmitWS is a webreference to http://ws.easylink.com/JobSubmit/2011/01?WSDL

Do I need to set a particular URL in the code? if so, could you please tell me what URL to use and where to set it?

thank you!!

Roy

skamens

The web reference you are using looks fine, but the submission URL in the WSDL is deliberately invalid.

To submit to the test system, you should use https://test2messaging.easylink.com/soap/sync.

thuneke

You are also missing th following:

            JS_Message[0].Reports = JS_Report;
            EM_Content.Part = JS_Content;
            JS_Message[0].Contents = EM_Content;
            JS_Message[0].Destinations = delivery;
Which means you have no Content or Destination. The sample also calls

Set_Server_and_Proxy(EM);
Which sets the URL

EM.Url = GetSystemServer(); //the EasyLink URL to submit to.
and sets the proxy server if needed. It can be found in

CS_HelperFunctions.txt

Tom

vgssupport

Hi Tom,

thanks for your reply. i changed the code as suggested (couldnt find the helper function file, I am new here! but set the url in the code so I am assuming it's the same). Now the application is crashing at the same line as before but the error message is now: "Error in parsing". I am not sure what I am doing wrong! has it got anything to do with the DocDataValue variable or is it something totally different? please see the new code below... Really appreciate your help!!!

[WebMethod]
        public void SendSMS(string PhoneNumber, string Message, string CustomerReference,string BillingCode, string Challenge)
        {
           string DocDataValue = "CONTENT TYPE EMAIL" + Environment.NewLine + "/SMS " + PhoneNumber + Environment.NewLine + "BC: " + BillingCode + Environment.NewLine + "Cref: " + CustomerReference + Environment.NewLine + "BT " + Environment.NewLine + Message;


            //JobSubmitRequest SMS Options
            // setup EMsgAPI object - EM
            JobSubmitWS.JobSubmitService EM = new JobSubmitWS.JobSubmitService();
            EM.Url = "https://test2messaging.easylink.com/soap/sync";

            // setup Authentication objects
            JobSubmitWS.RequestAuthentication reqAuth = new JobSubmitWS.RequestAuthentication();
            JobSubmitWS.XDDSAuthType XDDSAuth = new JobSubmitWS.XDDSAuthType();
            JobSubmitWS.UIDType uid = new JobSubmitWS.UIDType();
            JobSubmitWS.ContentsType EM_Content = new JobSubmitWS.ContentsType();

            // init Authentication objects
            // init Authentication objects
            XDDSAuth.Password = "password";
            uid.Value = "username";
            XDDSAuth.RequesterID = uid;
            reqAuth.Item = XDDSAuth;

            // Setup MessageObject
            JobSubmitWS.MessageType[] JS_Message = new JobSubmitWS.MessageType[1];
            JS_Message[0] = new JobSubmitWS.MessageType();

            // Setup JobOptions - Voice and CRef
           JobSubmitWS.JobOptionsType JS_JobOptions = new JobSubmitWS.JobOptionsType();
           JobSubmitWS.EncodableStringType JS_CRef = new JobSubmitWS.EncodableStringType();
           JobSubmitWS.SmsOptionsType JS_SMSOptions = new JobSubmitWS.SmsOptionsType();

            // set CREF and Billing Code
            JS_CRef.Value = CustomerReference;
            JS_JobOptions.CustomerReference = JS_CRef;

            // Set SMS Options
            //JS_SMSOptions.ExpirationDaysSpecified = false;

            // Set JobOptions as SMSOptions
            JS_JobOptions.SmsOptions = JS_SMSOptions;

            // Set Message Object
            JS_Message[0].JobOptions = JS_JobOptions;

            // Free Objects
            JS_JobOptions = null;
            JS_SMSOptions = null;
            JS_CRef = null;

            // Setup Documents
           JobSubmitWS.DocumentType[] JS_Documents = new JobSubmitWS.DocumentType[1];
            JS_Documents[0] = new JobSubmitWS.DocumentType();

            // Setup reusable variables for the document
            JobSubmitWS.DocDataType DocData = new JobSubmitWS.DocDataType();
            DocData.format = JobSubmitWS.DocEncodingFormat.text;
            DocData.Value = DocDataValue;

            // Setup Document 1 - Text to be delivered to SMS Device
            JS_Documents[0].Item = DocData;
            JobSubmitWS.EncodableStringType myFileName = new JobSubmitWS.EncodableStringType();
            myFileName.Value = "text.txt";
            JS_Documents[0].Filename = myFileName;
            JS_Documents[0].DocType = "text";
            JS_Documents[0].ItemElementName = JobSubmitWS.ItemChoiceType.DocData;
            JS_Documents[0].@ref = "TextMessage";
          // DocData = null;

            // Setup Content
            JobSubmitWS.ContentPartType[] JS_Content = new JobSubmitWS.ContentPartType[1];
            JS_Content[0] = new JobSubmitWS.ContentPartType();
            JS_Content[0].Item = DocData.Value;
            JS_Content[0].Treatment = JobSubmitWS.TreatmentType.body;
            JS_Content[0].TreatmentSpecified = true;

            // Setup Destination
            JobSubmitWS.SmsType[] delivery = new JobSubmitWS.SmsType[1];
            delivery[0] = new JobSubmitWS.SmsType();
            delivery[0].Phone = PhoneNumber;
            delivery[0].@ref = "Phone Number Entered";

            // Setup Report Options
            JobSubmitWS.ReportOptionsType JS_Report = new JobSubmitWS.ReportOptionsType();
            JobSubmitWS.ReportOptionsTypeDeliveryReport DeliveryReport = new JobSubmitWS.ReportOptionsTypeDeliveryReport();
            DeliveryReport.DeliveryReportType = JobSubmitWS.MainReportTypeEnum.none;
            JS_Report.DeliveryReport = DeliveryReport;

            // Setup Request and JobSubmitRequest object
           JobSubmitWS.Request Request = new JobSubmitWS.Request();
         JobSubmitWS.Response Response = new JobSubmitWS.Response();
            JobSubmitWS.JobSubmitRequest JS_Request = new JobSubmitWS.JobSubmitRequest();
           JobSubmitWS.JobSubmitResult JS_Result = new JobSubmitWS.JobSubmitResult();

           JS_Message[0].Reports = JS_Report;
           EM_Content.Part = JS_Content;
           JS_Message[0].Contents = EM_Content;
           JS_Message[0].Destinations = delivery;
            // Everything is Setup Prepare to Launch Job



            // Assign Reqeust and Response objects to EM Object
            EM.RequestValue = Request;
            EM.ResponseValue = Response;
            JS_Request.Message = JS_Message;
           JS_Request.DocumentSet = JS_Documents;

            try
            {
                JS_Result = EM.JobSubmit(JS_Request);
            }
            catch (Exception ex)
            {
                System.Console.WriteLine(ex.Message);
                System.Console.Read();
                return;
            }

            if (JS_Result.Status.StatusCode != null)
            {
                string JobNumber;
                JobNumber = JS_Result.MessageResult[0].JobId.XDN + ":" + JS_Result.MessageResult[0].JobId.MRN;
                //txtJobNumber.Text = JobNumber;
            }

            string emfilename = "emresponse.xml";
            string resfilename = "result.xml";
            //string reqfilename = "request.xml";
            try
            {
                //This will output the response, result and request(if uncommented) to XML files in the
                //installed directory. This can be very usefull for debugging or ir help is requested from
                //the EMAPI support team

                    serializeResult(emfilename, EM.ResponseValue);
                    serializeResult(resfilename, JS_Result);
                    //serializeResult(reqfilename, JS_Request);

            }
            catch (System.IO.IOException io_error)
            {
                //MessageBox.Show("Error - " + io_error, "Error", MessageBoxButtons.OK);
            }
        }

        static void serializeResult(String filename, System.Object res)
        {
            System.Xml.Serialization.XmlSerializer x = new System.Xml.Serialization.XmlSerializer(res.GetType());
            System.IO.TextWriter w = new System.IO.StreamWriter(filename);
            x.Serialize(w, res);
            w.Close();
        }

thuneke

The error can be misleading. Move your changes above // Setup Request and JobSubmitRequest object. I would try setting just a simple string in docdatvalue such as "This is a test". Keep it simple until you have it working, then save and build from there. The URL for the SMS sample is

https://apiforums.easylink.com/content/c-sample-jobsubmit-sms-options-single-recipient

The one for the helper file is

https://apiforums.easylink.com/content/c-sample-helper-functions

Tom

vgssupport

Thanks again for your help Tom, we're making progress!

Now the job is submitting to the
test2messaging.easylink.com/soap/sync url however the application is
crashing after the submit function returns. the error message is "User
authentication not accepted" which I suppose means that the account
details are not valid on the test server. I have 2 questions:

1- what is the live url to post to?

2- How can we get a test account on the test url?

Thanks,

Roy

skamens

Good news.

The production URL for submission (using the 2.5 namespaces) is https://advancemessaging.easylink.com/soap/sync.

If you need test system credentials, your account team/sales engineer can arrange to get those set up for you.

thuneke

The fact that you got that error means the XML you are submitting is good. Almost there!

Tom

vgssupport

Hey guys,

thanks a lot for your help, sms are sending properly! just a quick question though: when I receive a text from the system on my mobile, it says it's from "xip" any idea how to customise this?

Cheers,

Roy

skamens

Glad to hear it's working!

Can you provide a job ID so we can investigate the way your message behaved?

vgssupport

Hi skamens,

Yes it is great to see it working! a couple of tweaks and we're there...

Were you afer the job number on the report? if so it is 24906612.

looking forward to your reply!

Thanks,

Roy