Interface definition for a client hosted web service to receive notification of account events. Click here for a free trial.

The following operations are supported. For a formal definition, please review the Service Description.

• MessageEvent
  

  Fires when an event occurs in the delivery of an MT (Mobile Terminated or outbound) message

  Parameters
  

  id	ID of the message
  eventtype	The type of event (Delivered)
  occuredat	Date and time the event occurred

  
  

  Returns
  Nothing

• SubscriptionEvent
  

  Fires when a user subscribes or unsubscribes to a premium rate service

  Parameters
  

  mobileNumber	The mobile number of the subscriber
  contactID	The ID of the subscriber contact (if any)
  eventCode	The type of event (Subscribe, Unsubscribe, Resubscribe OR Continue)
  occurredAt	Date and time the event occurred

  
  

  Returns
  Nothing

• MessageError
  

  Fires when an error occurs in delivery of an MT (Mobile Terminated or outbound) message

  Parameters
  

  id	ID of the message
  errortype	The type of error (Failed, UnrecognisedRecipient, ValidityPeriodExpired)
  occurredat	Date and time the error occurred
  detail	A description of the error

  
  

  Returns
  Nothing

• MessageReceived
  

  Fires when an MO (Mobile Originated or inbound) message arrives

  Parameters
  

  id	ID of the message
  originator	The alias the message should appear to come from. Can be another phone number or up to 11 alpha numeric characters
  recipient	The mobile number to send the message to
  body	The content of the message. 160 max characters for Text, 140 octets max for Binary and SmartMessaging, 70 octet pairs for Unicode messages.
  type	The type of message (Text, Binary, SmartMessage or Unicode)
  sentat	Date and time message was sent
  receivedat	Date and time message was received

  
  

  Returns
  Nothing