GetMessageStatusByReferenceID

From CDYNE Wiki
Revision as of 15:32, 22 December 2011 by 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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

DESCRIPTION

The GetMessageStatusByReferenceID method uses the ReferenceID parameter to return the status of a message (sent, queued, or error description).

GetMessageStatusByReferenceID INPUT

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

GetMessageStatusByReferenceID OUTPUT


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