IMessaging.Send()

Description:

The Send method sends an SMS or MMS message.

This method can be called both synchronously and asynchronously.

Syntax:

For synchronous calls:

result = so.IMessaging.Send(criteria);

For asynchronous calls:

result = so.IMessaging.Send(criteria, callback);

Arguments:

  • criteria:

    This is an object that specifies the type and details of the message to send. For more information about the object properties and how to define them, see section Criteria for sending a message.

  • callback:

    The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. Follow the instructions in section Defining the callback handler for an asynchronous method to define the callback method.

    This argument is used only with an asynchronous Send call.

Return value:

If synchronous, the Send method returns an object that contains an error code and an error message.

If asynchronous, the method returns an object that contains a transaction ID for the callback instance, an error code, and an error message (see the following table). When the asynchronous call has completed, callback returns an object that contains an error code and an error message (see Table: Callback return value).

Table: Return value properties for Send

Property

Description

Value

result.ReturnValue

This is a number used as an identification to match transactions started with an asynchronous Send call to one or more calls it generates to callback.

This property is only valid for asynchronous calls.

 

result.ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

result.ErrorMessage

This is a text string that describes the error.

See Messaging Service API error messages.

Remarks:

Apart from status information and transaction IDs for asynchronous calls, the Send method does not return any result information.

Example code:

For the complete source of a sample widget that demonstrates how to use this Service API, see the full example.