Net_SMPP
[ class tree: Net_SMPP ] [ index: Net_SMPP ] [ all elements ]

Class: Net_SMPP_Command_Deliver_Sm

Source Location: /Net_SMPP-0.4.5/Net/SMPP/Command/deliver_sm.php

Class Overview

Net_SMPP_PDU
   |
   --Net_SMPP_Command
      |
      --Net_SMPP_Command_Deliver_Sm

deliver_sm class


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • Portions of the documentation (c) Copyright 1999 SMPP Developers Forum.

Variables


Inherited Variables

Inherited Methods

Class: Net_SMPP_Command

Net_SMPP_Command::Net_SMPP_Command()
4.x constructor
Net_SMPP_Command::__construct()
5.x/main constructor
Net_SMPP_Command::commandCode()
Get the ID of a command from it's name
Net_SMPP_Command::commandName()
Get the name of a command from it's ID
Net_SMPP_Command::fieldExists()
Does this field exist?
Net_SMPP_Command::fieldIsOptional()
Is this field optional?
Net_SMPP_Command::generateParams()
Generate the binary data from the object
Net_SMPP_Command::isFixed()
Is this a fixed-length field?
Net_SMPP_Command::parseOptionalParams()
Parse optional paramaters
Net_SMPP_Command::parseParams()
Parse data into the object structure
Net_SMPP_Command::set()
Set values in this object
Net_SMPP_Command::_commandList()
Get the list of SMPP v3.4 commands
Net_SMPP_Command::_optionalParams()
Get list of optional paramaters

Class: Net_SMPP_PDU

Net_SMPP_PDU::extractCommand()
Extract the command from a PDU
Net_SMPP_PDU::factory()
Get an instance of a specific command class
Net_SMPP_PDU::generate()
Generate the raw PDU to send to the remote system
Net_SMPP_PDU::isError()
Is this an error response?
Net_SMPP_PDU::isRequest()
Is this a request PDU?
Net_SMPP_PDU::isResponse()
Is this a response PDU?
Net_SMPP_PDU::isVendor()
Is this a vendor PDU?
Net_SMPP_PDU::parse()
Parse a raw PDU and populate this instance with it's data
Net_SMPP_PDU::statusDesc()
Get status description

Class Details

[line 56]
deliver_sm class

The deliver_sm is issued by the SMSC to send a message to an ESME. Using this command, the SMSC may route a short message to the ESME for delivery. In addition the SMSC uses the deliver_sm operation to transfer the following types of short messages to the ESME:-

  • SMSC Delivery Receipt. A delivery receipt relating to a a message which had been previously submitted with the submit_sm operation and the ESME had requested a delivery receipt via the registered_delivery parameter. The delivery receipt data relating to the original short message will be included in the short_message field of the deliver_sm. (Reference Appendix B for an example Delivery Receipt format.)
  • SME Delivery Acknowledgement. The user data of the SME delivery acknowledgement is included in the short_message field of the deliver_sm
  • SME Manual/User Acknowledgement. The user data of the SME delivery acknowledgement is included in the short_message field of the deliver_sm
  • Intermediate Notification.



[ Top ]


Class Variables

$alert_on_msg_delivery =

[line 288]


Type:   mixed


[ Top ]

$callback_num =

[line 277]


Type:   mixed


[ Top ]

$callback_num_atag =

[line 279]


Type:   mixed


[ Top ]

$callback_num_pres_ind =

[line 278]


Type:   mixed


[ Top ]

$data_coding =  NET_SMPP_ENCODING_DEFAULT

[line 227]

Defines the encoding scheme of the short message user data.

Type:   int


[ Top ]

$destination_addr =

[line 156]

Destination address of this short message.

For mobile terminated messages, this is the directory number of the recipient MS.


Type:   string


[ Top ]

$destination_port =

[line 268]


Type:   mixed


[ Top ]

$dest_addr_npi =  NET_SMPP_NPI_UNK

[line 146]

Numbering Plan Indicator for destination.

Type:   int


[ Top ]

$dest_addr_subunit =

[line 269]


Type:   mixed


[ Top ]

$dest_addr_ton =  NET_SMPP_TON_UNK

[line 139]

Type of Number for destination.

Type:   int


[ Top ]

$dest_subaddress =

[line 281]


Type:   mixed


[ Top ]

$display_time =

[line 283]


Type:   mixed


[ Top ]

$esm_class =  NET_SMPP_MSGMODE_DEFAULT

[line 170]

Indicates Message Mode & Message Type.

This is a bitwise field to specify the message mode, type, and GSM features. See the NET_SMPP_MSGMODE_*, NET_SMPP_MSGTYPE_*, and NET_SMPP_GSMFEAT_* constants for possible values.

You will need to set this if your message has a User Data Header (UDH), for example if you are sending WAP Push messages via SMPP.


Type:   int


[ Top ]

$its_reply_type =

[line 290]


Type:   mixed


[ Top ]

$its_session_info =

[line 291]


Type:   mixed


[ Top ]

$language_indicator =

[line 289]


Type:   mixed


[ Top ]

$message_payload =

[line 275]


Type:   mixed


[ Top ]

$more_messages_to_send =

[line 273]


Type:   mixed


[ Top ]

$ms_msg_wait_facilities =

[line 286]


Type:   mixed


[ Top ]

$ms_validity =

[line 285]


Type:   mixed


[ Top ]

$number_of_messages =

[line 287]


Type:   mixed


[ Top ]

$payload_type =

[line 274]


Type:   mixed


[ Top ]

$priority_flag =

[line 186]

Designates the priority level of the message.

Type:   int


[ Top ]

$privacy_indicator =

[line 276]


Type:   mixed


[ Top ]

$protocol_id =

[line 179]

Protocol Identifier.

Network specific field.


Type:   int


[ Top ]

$registered_delivery =

[line 212]

Indicator to signify if an SMSC delivery receipt or an SME acknowledgement is required.

Type:   int


[ Top ]

$replace_if_present_flag =  0

[line 220]

Flag indicating if submitted message should replace an existing message.

Type:   int


[ Top ]

$sar_msg_ref_num =

[line 270]


Type:   mixed


[ Top ]

$sar_segment_seqnum =

[line 272]


Type:   mixed


[ Top ]

$sar_total_segments =

[line 271]


Type:   mixed


[ Top ]

$schedule_delivery_time =  null

[line 195]

The short message is to be scheduled by the SMSC for delivery.

Set to NULL for immediate delivery


Type:   string


[ Top ]

$service_type =  null

[line 80]

SMS application associated with this message

Specifying the service_type allows the ESME to

  • avail of enhanced messaging services such as “replace by service” type
  • to control the teleservice used on the air interface.
The following generic service_types are defined:

““ (NULL) Default “CMT” Cellular Messaging “CPT” Cellular Paging “VMN” Voice Mail Notification “VMA” Voice Mail Alerting “WAP” Wireless Application Protocol “USSD” Unstructured Supplementary Services Data

Set to NULL for default SMSC settings.


Type:   string


[ Top ]

$short_message =  null

[line 262]

Up to 254 octets of short message user data.

The exact physical limit for short_message size may vary according to the underlying network.

Applications which need to send messages longer than 254 octets should use the message_payload parameter. In this case the sm_length field should be set to zero.

Note: The short message data should be inserted in either the short_message or message_payload fields. Both fields must not be used simultaneously.


Type:   string


[ Top ]

$sms_signal =

[line 284]


Type:   mixed


[ Top ]

$sm_default_msg_id =  null

[line 237]

Indicates the short message to send from a list of predefined (‘canned’) short messages stored on the SMSC.

If not using an SMSC canned message, set to NULL.


Type:   int


[ Top ]

$sm_length =  0

[line 244]

Length in octets of the short_message user data.

Type:   int


[ Top ]

$source_addr =  null

[line 132]

Address of SME which originated this message.

If not known, set to NULL


Type:   mixed


[ Top ]

$source_addr_npi =  NET_SMPP_NPI_UNK

[line 125]

Numbering Plan Indicator for source address

These fields define the Numeric Plan Indicator (NPI) to be used in the SME address parameters. The following NPI values are defined:

NPI Value Unknown 00000000 ISDN (E163/E164) 00000001 Data (X.121) 00000011 Telex (F.69) 00000100 Land Mobile (E.212) 00000110 National 00001000 Private 00001001 ERMES 00001010 Internet (IP) 00001110 WAP Client Id (to be 00010010 defined by WAP Forum)

If not known, set to NULL.


Type:   int


[ Top ]

$source_addr_subunit =

[line 267]


Type:   mixed


[ Top ]

$source_addr_ton =  NET_SMPP_TON_UNK

[line 100]

Type of Number for source address

These fields define the Type of Number (TON) to be used in the SME address parameters. The following TON values are defined: TON Value Unknown 00000000 (0x00) International 00000001 (0x01) National 00000010 (0x02) Network Specific 00000011 (0x03) Subscriber Number 00000100 (0x04) Alphanumeric 00000101 (0x05) Abbreviated 00000110 (0x06)

If not known, set to NULL.


Type:   int


[ Top ]

$source_port =

[line 266]


Type:   mixed


[ Top ]

$source_subaddress =

[line 280]


Type:   mixed


[ Top ]

$user_message_reference =

[line 265]


Type:   mixed


[ Top ]

$user_response_code =

[line 282]


Type:   mixed


[ Top ]

$ussd_service_op =

[line 292]


Type:   mixed


[ Top ]

$validity_period =  null

[line 204]

The validity period of this message.

Set to NULL to request the SMSC default validity period.


Type:   int


[ Top ]

$_defs = array(
        'service_type' => array(
            'type' => 'string',
            'max' => 6
        ),'source_addr_ton'=>array('type'=>'int','size'=>1,),'source_addr_npi'=>array('type'=>'int','size'=>1),'source_addr'=>array('type'=>'string','max'=>21,),'dest_addr_ton'=>array('type'=>'int','size'=>1,),'dest_addr_npi'=>array('type'=>'int','size'=>1,),'destination_addr'=>array('type'=>'string','max'=>21),'esm_class'=>array('type'=>'int','size'=>1),'protocol_id'=>array('type'=>'int','size'=>1),'priority_flag'=>array('type'=>'int','size'=>1),'schedule_delivery_time'=>array('type'=>'string','max'=>17),'validity_period'=>array('type'=>'string','max'=>17,),'registered_delivery'=>array('type'=>'int','size'=>1,),'replace_if_present_flag'=>array('type'=>'int','size'=>1),'data_coding'=>array('type'=>'int','size'=>1),'sm_default_msg_id'=>array('type'=>'int','size'=>1),'sm_length'=>array('type'=>'int','size'=>1),'short_message'=>array('type'=>'ostring','max'=>254,'lenField'=>'sm_length'),// Optional params
'user_message_reference'=>array('type'=>'int','size'=>2),'source_port'=>array('type'=>'int','size'=>2),'destination_port'=>array('type'=>'int','size'=>2),'sar_msg_ref_num'=>array('type'=>'int','size'=>2),'sar_total_segments'=>array('type'=>'int','size'=>1),'sar_segment_seqnum'=>array('type'=>'int','size'=>1),'payload_type'=>array('type'=>'int','size'=>1),'message_payload'=>array('type'=>'ostring','max'=>260),'privacy_indicator'=>array('type'=>'int','size'=>1),'callback_num'=>array('type'=>'sting','min'=>4,'max'=>19),'source_subaddress'=>array('type'=>'string','min'=>2,'max'=>23),'dest_subaddress'=>array('type'=>'string','min'=>2,'max'=>23),'user_response_code'=>array('type'=>'int','size'=>1),'language_indicator'=>array('type'=>'int','size'=>1),'its_session_info'=>array('type'=>'string','size'=>2),'network_error_code'=>array('type'=>'string','size'=>3),'message_state'=>array('type'=>'int','size'=>1),'receipted_message_id'=>array('type'=>'string','min'=>1,'max'=>65))

[line 301]

Paramater definitions for this command

Type:   array
Overrides:   Array


[ Top ]



Documentation generated on Tue, 01 Jun 2010 10:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.