constants.go

package smpp34

const (
	// SMPP Protocol Version
	SMPP_VERSION = 0x34

	// Max PDU size to minimize some attack vectors
	MAX_PDU_SIZE = 4096 // 4KB

	// Sequence number start/end
	SEQUENCE_NUM_START = 0x00000001
	SEQUENCE_NUM_END   = 0x7FFFFFFF
)

const (
	// ESME Error Constants
	ESME_ROK              CMDStatus = 0x00000000 // OK!
	ESME_RINVMSGLEN       CMDStatus = 0x00000001 // Message Length is invalid
	ESME_RINVCMDLEN       CMDStatus = 0x00000002 // Command Length is invalid
	ESME_RINVCMDID        CMDStatus = 0x00000003 // Invalid Command ID
	ESME_RINVBNDSTS       CMDStatus = 0x00000004 // Incorrect BIND Status for given command
	ESME_RALYBND          CMDStatus = 0x00000005 // ESME Already in Bound State
	ESME_RINVPRTFLG       CMDStatus = 0x00000006 // Invalid Priority Flag
	ESME_RINVREGDLVFLG    CMDStatus = 0x00000007 // Invalid Registered Delivery Flag
	ESME_RSYSERR          CMDStatus = 0x00000008 // System Error
	ESME_RINVSRCADR       CMDStatus = 0x0000000A // Invalid Source Address
	ESME_RINVDSTADR       CMDStatus = 0x0000000B // Invalid Dest Addr
	ESME_RINVMSGID        CMDStatus = 0x0000000C // Message ID is invalid
	ESME_RBINDFAIL        CMDStatus = 0x0000000D // Bind Failed
	ESME_RINVPASWD        CMDStatus = 0x0000000E // Invalid Password
	ESME_RINVSYSID        CMDStatus = 0x0000000F // Invalid System ID
	ESME_RCANCELFAIL      CMDStatus = 0x00000011 // Cancel SM Failed
	ESME_RREPLACEFAIL     CMDStatus = 0x00000013 // Replace SM Failed
	ESME_RMSGQFUL         CMDStatus = 0x00000014 // Message Queue Full
	ESME_RINVSERTYP       CMDStatus = 0x00000015 // Invalid Service Type
	ESME_RINVNUMDESTS     CMDStatus = 0x00000033 // Invalid number of destinations
	ESME_RINVDLNAME       CMDStatus = 0x00000034 // Invalid Distribution List name
	ESME_RINVDESTFLAG     CMDStatus = 0x00000040 // Destination flag is invalid
	ESME_RINVSUBREP       CMDStatus = 0x00000042 // Invalid 'submit with replace' request
	ESME_RINVESMCLASS     CMDStatus = 0x00000043 // Invalid esm_class field data
	ESME_RCNTSUBDL        CMDStatus = 0x00000044 // Cannot Submit to Distribution List
	ESME_RSUBMITFAIL      CMDStatus = 0x00000045 // submit_sm or submit_multi failed
	ESME_RINVSRCTON       CMDStatus = 0x00000048 // Invalid Source address TON
	ESME_RINVSRCNPI       CMDStatus = 0x00000049 // Invalid Source address NPI
	ESME_RINVDSTTON       CMDStatus = 0x00000050 // Invalid Destination address TON
	ESME_RINVDSTNPI       CMDStatus = 0x00000051 // Invalid Destination address NPI
	ESME_RINVSYSTYP       CMDStatus = 0x00000053 // Invalid system_type field
	ESME_RINVREPFLAG      CMDStatus = 0x00000054 // Invalid replace_if_present flag
	ESME_RINVNUMMSGS      CMDStatus = 0x00000055 // Invalid number of messages
	ESME_RTHROTTLED       CMDStatus = 0x00000058 // Throttling error
	ESME_RINVSCHED        CMDStatus = 0x00000061 // Invalid Scheduled Delivery Time
	ESME_RINVEXPIRY       CMDStatus = 0x00000062 // Invalid message validity period (Expiry time)
	ESME_RINVDFTMSGID     CMDStatus = 0x00000063 // Predefined Message Invalid or Not Found
	ESME_RX_T_APPN        CMDStatus = 0x00000064 // ESME Receiver Temporary App Error Code
	ESME_RX_P_APPN        CMDStatus = 0x00000065 // ESME Receiver Permanent App Error Code
	ESME_RX_R_APPN        CMDStatus = 0x00000066 // ESME Receiver Reject Message Error Code
	ESME_RQUERYFAIL       CMDStatus = 0x00000067 // Query_sm request failed
	ESME_RINVOPTPARSTREAM CMDStatus = 0x000000C0 // Error in the optional part of the PDU Body
	ESME_ROPTPARNOTALLWD  CMDStatus = 0x000000C1 // Optional Parameter not allowed
	ESME_RINVPARLEN       CMDStatus = 0x000000C2 // Invalid Parameter Length
	ESME_RMISSINGOPTPARAM CMDStatus = 0x000000C3 // Expected Optional Parameter missing
	ESME_RINVOPTPARAMVAL  CMDStatus = 0x000000C4 // Invalid Optional Parameter Value
	ESME_RDELIVERYFAILURE CMDStatus = 0x000000FE // Delivery Failure (used for data_sm_resp)
	ESME_RUNKNOWNERR      CMDStatus = 0x000000FF // Unknown Error
)

const (
	// PDU Types
	GENERIC_NACK          CMDId = 0x80000000
	BIND_RECEIVER         CMDId = 0x00000001
	BIND_RECEIVER_RESP    CMDId = 0x80000001
	BIND_TRANSMITTER      CMDId = 0x00000002
	BIND_TRANSMITTER_RESP CMDId = 0x80000002
	QUERY_SM              CMDId = 0x00000003
	QUERY_SM_RESP         CMDId = 0x80000003
	SUBMIT_SM             CMDId = 0x00000004
	SUBMIT_SM_RESP        CMDId = 0x80000004
	DELIVER_SM            CMDId = 0x00000005
	DELIVER_SM_RESP       CMDId = 0x80000005
	UNBIND                CMDId = 0x00000006
	UNBIND_RESP           CMDId = 0x80000006
	REPLACE_SM            CMDId = 0x00000007
	REPLACE_SM_RESP       CMDId = 0x80000007
	CANCEL_SM             CMDId = 0x00000008
	CANCEL_SM_RESP        CMDId = 0x80000008
	BIND_TRANSCEIVER      CMDId = 0x00000009
	BIND_TRANSCEIVER_RESP CMDId = 0x80000009
	OUTBIND               CMDId = 0x0000000B
	ENQUIRE_LINK          CMDId = 0x00000015
	ENQUIRE_LINK_RESP     CMDId = 0x80000015
	SUBMIT_MULTI          CMDId = 0x00000021
	SUBMIT_MULTI_RESP     CMDId = 0x80000021
	ALERT_NOTIFICATION    CMDId = 0x00000102
	DATA_SM               CMDId = 0x00000103
	DATA_SM_RESP          CMDId = 0x80000103
)

const (
	// Encoding Types
	ENCODING_DEFAULT   = 0x00 // SMSC Default
	ENCODING_IA5       = 0x01 // IA5 (CCITT T.50)/ASCII (ANSI X3.4)
	ENCODING_BINARY    = 0x02 // Octet unspecified (8-bit binary)
	ENCODING_ISO88591  = 0x03 // Latin 1 (ISO-8859-1)
	ENCODING_BINARY2   = 0x04 // Octet unspecified (8-bit binary)
	ENCODING_JIS       = 0x05 // JIS (X 0208-1990)
	ENCODING_ISO88595  = 0x06 // Cyrillic (ISO-8859-5)
	ENCODING_ISO88598  = 0x07 // Latin/Hebrew (ISO-8859-8)
	ENCODING_ISO10646  = 0x08 // UCS2 (ISO/IEC-10646)
	ENCODING_PICTOGRAM = 0x09 // Pictogram Encoding
	ENCODING_ISO2022JP = 0x0A // ISO-2022-JP (Music Codes)
	ENCODING_EXTJIS    = 0x0D // Extended Kanji JIS (X 0212-1990)
	ENCODING_KSC5601   = 0x0E // KS C 5601
)

const (
	// ESM_CLASS Types
	ESM_CLASS_MSGMODE_DEFAULT      = 0x00 // Default SMSC mode (e.g. Store and Forward)
	ESM_CLASS_MSGMODE_DATAGRAM     = 0x01 // Datagram mode
	ESM_CLASS_MSGMODE_FORWARD      = 0x02 // Forward (i.e. Transaction) mode
	ESM_CLASS_MSGMODE_STOREFORWARD = 0x03 // Store and Forward mode (use this to select Store and Forward mode if Default mode is not Store and Forward)

	ESM_CLASS_MSGTYPE_DEFAULT     = 0x00 // Default message type (i.e. normal message)
	ESM_CLASS_MSGTYPE_DELIVERYACK = 0x08 // Message containts ESME Delivery Acknowledgement
	ESM_CLASS_MSGTYPE_USERACK     = 0x10 // Message containts ESME Manual/User Acknowledgement

	ESM_CLASS_GSMFEAT_NONE          = 0x00 // No specific features selected
	ESM_CLASS_GSMFEAT_UDHI          = 0x40 // UDHI Indicator (only relevant for MT msgs)
	ESM_CLASS_GSMFEAT_REPLYPATH     = 0x80 // Set Reply Path (only relevant for GSM net)
	ESM_CLASS_GSMFEAT_UDHIREPLYPATH = 0xC0 // Set UDHI and Reply Path (for GSM net)
)

const (
	// FIELDS
	SYSTEM_ID               = "system_id"
	PASSWORD                = "password"
	SYSTEM_TYPE             = "system_type"
	INTERFACE_VERSION       = "interface_version"
	ADDR_TON                = "addr_ton"
	ADDR_NPI                = "addr_npi"
	ADDRESS_RANGE           = "address_range"
	SERVICE_TYPE            = "service_type"
	SOURCE_ADDR_TON         = "source_addr_ton"
	SOURCE_ADDR_NPI         = "source_addr_npi"
	SOURCE_ADDR             = "source_addr"
	DEST_ADDR_TON           = "dest_addr_ton"
	DEST_ADDR_NPI           = "dest_addr_npi"
	DESTINATION_ADDR        = "destination_addr"
	ESM_CLASS               = "esm_class"
	PROTOCOL_ID             = "protocol_id"
	PRIORITY_FLAG           = "priority_flag"
	SCHEDULE_DELIVERY_TIME  = "schedule_delivery_time"
	VALIDITY_PERIOD         = "validity_period"
	REGISTERED_DELIVERY     = "registered_delivery"
	REPLACE_IF_PRESENT_FLAG = "replace_if_present_flag"
	DATA_CODING             = "data_coding"
	SM_DEFAULT_MSG_ID       = "sm_default_msg_id"
	SM_LENGTH               = "sm_length"
	SHORT_MESSAGE           = "short_message"
	MESSAGE_ID              = "message_id"
	FINAL_DATE              = "final_date"
	MESSAGE_STATE           = "message_state"
	ERROR_CODE              = "error_code"
)

const (
	// Optional Field Tags
	DEST_ADDR_SUBUNIT           = 0x0005
	DEST_NETWORK_TYPE           = 0x0006
	DEST_BEARER_TYPE            = 0x0007
	DEST_TELEMATICS_ID          = 0x0008
	SOURCE_ADDR_SUBUNIT         = 0x000D
	SOURCE_NETWORK_TYPE         = 0x000E
	SOURCE_BEARER_TYPE          = 0x000F
	SOURCE_TELEMATICS_ID        = 0x0010
	QOS_TIME_TO_LIVE            = 0x0017
	PAYLOAD_TYPE                = 0x0019
	ADDITIONAL_STATUS_INFO_TEXT = 0x001D
	RECEIPTED_MESSAGE_ID        = 0x001E
	MS_MSG_WAIT_FACILITIES      = 0x0030
	PRIVACY_INDICATOR           = 0x0201
	SOURCE_SUBADDRESS           = 0x0202
	DEST_SUBADDRESS             = 0x0203
	USER_MESSAGE_REFERENCE      = 0x0204
	USER_RESPONSE_CODE          = 0x0205
	SOURCE_PORT                 = 0x020A
	DESTINATION_PORT            = 0x020B
	SAR_MSG_REF_NUM             = 0x020C
	LANGUAGE_INDICATOR          = 0x020D
	SAR_TOTAL_SEGMENTS          = 0x020E
	SAR_SEGMENT_SEQNUM          = 0x020F
	SC_INTERFACE_VERSION        = 0x0210
	CALLBACK_NUM_PRES_IND       = 0x0302
	CALLBACK_NUM_ATAG           = 0x0303
	NUMBER_OF_MESSAGES          = 0x0304
	CALLBACK_NUM                = 0x0381
	DPF_RESULT                  = 0x0420
	SET_DPF                     = 0x0421
	MS_AVAILABILITY_STATUS      = 0x0422
	NETWORK_ERROR_CODE          = 0x0423
	MESSAGE_PAYLOAD             = 0x0424
	DELIVERY_FAILURE_REASON     = 0x0425
	MORE_MESSAGES_TO_SEND       = 0x0426
	DR_MESSAGE_STATE            = 0x0427
	USSD_SERVICE_OP             = 0x0501
	DISPLAY_TIME                = 0x1201
	SMS_SIGNAL                  = 0x1203
	MS_VALIDITY                 = 0x1204
	ALERT_ON_MESSAGE_DELIVERY   = 0x130C
	ITS_REPLY_TYPE              = 0x1380
	ITS_SESSION_INFO            = 0x1383
)