From CDYNE Wiki
Revision as of 11:11, 10 December 2013 by imported>Bdriggers (→‎JAVA)
Jump to navigation Jump to search

This method returns all messages with a predefined user ReferenceID set in AdvancedSMSSend method.

GetMessageStatusByReferenceID Request

Parameter Name Data Type Sample Input
ReferenceID: Input unique ID that can be set with the AdvancedSMSSend method. String CDYNE Test

HTTP Method

HTTP Method: GET



GetMessageStatusByReferenceID Response

Parameter Name Data Type Sample Output
MessageID: Returns unique Guid ID for every SMS message sent. Guid B01d89fd-5155-5455-5585-e84ab8de8591
Queued: Returns true or false if the SMS message has been queued. Boolean True
ReferenceID: Returns a unique ID that is assigned during request input. (Not a required Input) String CDYNE Test
SMSError: Returns a string indicating if there was an error sending the SMS message.
  • NoError
  • STOPfromPhoneNumber
  • LicenseKeyInvalid
  • PhoneNumberInvalid
  • MessageInvalid
  • ScheduledDateTimeIsNotUTC
  • InvalidAssignedDID
  • NotFound (Occurs for Invalid MessageID)
  • InternalError
  • ContactCdyneAccountSuspended
String NoError
SMSIncomingMessages: Returns an array of type SMSIncomingMessage SMSIncomingMessage[] See Table Below
Sent: Returns true or false if the SMS message has been sent to the carrier. Boolean False
SentDateTime: Returns the UTC Date and Time of when the message was sent. Datetime 0001-01-01T00:00:00

SMSIncomingMessage Parameter Name Data Type Sample Output
FromPhoneNumber: Returns the phone number that sent this incoming message. String 17575449510
IncomingMessageID: Returns a unique Guid ID for this incoming message. Guid 1835fecd-8402-4b02-91a4-5f4f9e036fe6
MatchedMessageID: Returns a unique Guid ID that matches the outgoing MessageID that this message is in response to. Guid B01d89fd-5155-5455-5585-e84ab8de8591
Message: Returns the content of the incoming message. String Ok.
ResponseReceiveDate: Returns the UTC Date and Time of when the message was received. DateTime 0001-01-01T00:00:00
ToPhoneNumber: Returns the destination phone number of this incoming message. String 17577698337

XML Response

The following is an example response Xml body:

    <ReferenceID>String content</ReferenceID>
        <FromPhoneNumber>String content</FromPhoneNumber>
        <Message>String content</Message>
        <ToPhoneNumber>String content</ToPhoneNumber>
        <FromPhoneNumber>String content</FromPhoneNumber>
        <Message>String content</Message>
        <ToPhoneNumber>String content</ToPhoneNumber>

Json Response

The following is an example response Json body:

	"ReferenceID":"String content",
		"FromPhoneNumber":"String content",
		"Message":"String content",
		"ToPhoneNumber":"String content"

GetMessageStatusByReferenceID Code Examples


GetMessageStatusByReferenceID.WSDL.IsmsClient client = new GetMessageStatusByReferenceID.WSDL.IsmsClient("sms2wsHttpBinding"); GetMessageStatusByReferenceID.WSDL.SMSResponse[] resp = client.GetMessageStatusByReferenceID("123456", new Guid("YOUR LICENSE KEY")); foreach (var item in resp) { Console.WriteLine(item.MessageID+" " + item.SentDateTime + " " + item.SMSError); } Console.ReadLine(); Client.Close();


Imports GetMessageStatusByReferenceID.WSDL Module Module1

Sub Main()
Dim client As New GetMessageStatusByReferenceID.WSDL.IsmsClient("sms2wsHttpBinding")
Dim resp As GetMessageStatusByReferenceID.WSDL.SMSResponse() = client.GetMessageStatusByReferenceID("123456", New Guid("YOUR LICENSE KEY"))
For Each item In resp
Console.WriteLine(Convert.ToString(item.MessageID) & " " & Convert.ToString(item.SentDateTime) & " " & Convert.ToString(item.SMSError))
End Sub

End Module



$client = new SoapClient('');

$param = array( 'ReferenceID' => '(your reference ID, set in AdvancedSMSSend)', 'LicenseKey' => '(your license key)' );

$result = $client->GetMessageStatusByReferenceID($param);



PHP with cURL


$url=' ID)&LicenseKey=(License Key)';

$cURL = curl_init();

curl_setopt($cURL,CURLOPT_URL,$url); curl_setopt($cURL,CURLOPT_HTTPGET,true); curl_setopt($cURL, CURLOPT_HTTPHEADER, array('Content-Type: application/json','Accept: application/json'));

$result = curl_exec($cURL);





Dim oXMLHTTP Set oXMLHTTP = CreateObject("Microsoft.XMLHTTP") Set oDoc = CreateObject("MSXML2.DOMDocument") Call oXMLHttp.Open("GET", " LICENSE KEY", False) Call oXMLHttp.setRequestHeader("Content-Type", "text/xml") Call oXMLHttp.send MsgBox oXMLHTTP.responseText


require 'net/http' require 'URI' puts URI.methods url = URI.parse(' LICENSE KEY') res = Net::HTTP.get_response(url) data = res.body puts data gets data


import; import; import; import; import java.util.Properties; import javax.xml.transform.OutputKeys; import javax.xml.transform.Source; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; import; import;

public final class GetMessageStatusByReferenceID{

   public static void main(String[] args) { 	
   URL url = new URL(""
                      + "ReferenceID=12346"
                      + "&LicenseKey=YOUR LICENSE KEY");		
   InputStream in = url.openStream(); 
   StreamSource source = new StreamSource(in); 			
   }catch( e){			
   }catch (MalformedURLException e){		
           private static void printResult(Source source) {        
               try {            
               ByteArrayOutputStream bos = new ByteArrayOutputStream();
               StreamResult sr = new StreamResult(bos);
               Transformer trans = TransformerFactory.newInstance().newTransformer();
               Properties oprops = new Properties();
               oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
               trans.transform(source, sr);            
               System.out.println("**** Response ******"); 
       } catch (Exception e) {