Difference between revisions of "GetMessageStatusByReferenceID"

From CDYNE Wiki
Jump to navigation Jump to search
imported>Nfesette
(Created page with "== DESCRIPTION == The GetMessageStatusByReferenceID method uses the ReferenceID parameter to return the status of a message (sent, queued, or error description). == GetMessageS...")
 
imported>Nfesette
Line 1: Line 1:
== DESCRIPTION ==
+
This method returns all messages with a predefined user ReferenceID set in [[AdvancedSMSSend]] method.
 +
<br><br>
  
The GetMessageStatusByReferenceID method uses the ReferenceID parameter to return the status of a message (sent, queued, or error description).
+
== GetMessageStatusByReferenceID Request ==
  
== GetMessageStatusByReferenceID INPUT ==
+
{| class="wikitable"  
 
 
{| class="wikitable" cellspacing="5"
 
  
 
|-
 
|-
Line 20: Line 19:
 
|}
 
|}
  
== GetMessageStatusByReferenceID OUTPUT ==
+
== GetMessageStatusByReferenceID Response ==
  
 
<br>
 
<br>
  
{| class="wikitable" cellspacing="5"
+
{| class="wikitable"  
  
 
|-
 
|-
Line 78: Line 77:
  
 
|}
 
|}
 +
 +
=== PHP ===
 +
 +
<php>
 +
 +
$client = new SoapClient('http://sms2.cdyne.com/sms.svc?wsdl');
 +
 +
$param = array(
 +
'ReferenceID' => '(your reference ID, set in AdvancedSMSSend)'
 +
,'LicenseKey' => '(your license key)'
 +
);
 +
 +
$result = $client->GetMessageStatusByReferenceID($param);
 +
 +
print_r($result);
 +
 +
</php>

Revision as of 14:42, 24 September 2012

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

GetMessageStatusByReferenceID Response


Parameter Name Data Type Sample Input
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 true or false if replies can be received. Boolean True
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

PHP

<php>

$client = new SoapClient('http://sms2.cdyne.com/sms.svc?wsdl');

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

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

print_r($result);

</php>