Skip to content

Instantly share code, notes, and snippets.

@eugenehp

eugenehp/gist:3875877

Created October 11, 2012 22:16
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save eugenehp/3875877 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save eugenehp/3875877 to your computer and use it in GitHub Desktop.
Download ZIP
some SMPP definitions
Raw
gistfile1.js
exports.command_ids = { // Use command_ids to look up by ID
0x80000000: 'generic_nack',
0x00000001: 'bind_receiver',
0x80000001: 'bind_receiver_resp',
0x00000002: 'bind_transmitter',
0x80000002: 'bind_transmitter_resp',
0x00000003: 'query_sm',
0x80000003: 'query_sm_resp',
0x00000004: 'submit_sm',
0x80000004: 'submit_sm_resp',
0x00000005: 'deliver_sm',
0x80000005: 'deliver_sm_resp',
0x00000006: 'unbind',
0x80000006: 'unbind_resp',
0x00000007: 'replace_sm',
0x80000007: 'replace_sm_resp',
0x00000008: 'cancel_sm',
0x80000008: 'cancel_sm_resp',
0x00000009: 'bind_transceiver',
0x80000009: 'bind_transceiver_resp',
0x0000000B: 'outbind',
0x00000015: 'enquire_link',
0x80000015: 'enquire_link_resp',
0x00000021: 'submit_multi',
0x80000021: 'submit_multi_resp',
0x00000102: 'alert_notification',
0x00000103: 'data_sm',
0x80000103: 'data_sm_resp'
};
// Reverse command_ids into commands so we can have easy lookup either way!
for (var command_id in exports.command_ids) {
exports.commands[ exports.command_ids[command_id] ] = parseInt(command_id);
}
exports.command_status = {
ESME_ROK: { value: 0x00000000, description: "No Error" },
ESME_RINVMSGLEN: { value: 0x00000001, description: "Invalid message length" },
ESME_RINVCMDLEN: { value: 0x00000002, description: "Invalid command length" },
ESME_RINVCMDID: { value: 0x00000003, description: "Invalid command ID" },
ESME_RINVBNDSTS: { value: 0x00000004, description: "Incorrect bind status for given command" },
ESME_RALYBND: { value: 0x00000005, description: "ESME already in bound state" },
ESME_RINVPRTFLG: { value: 0x00000006, description: "Invalid priority flag" },
ESME_RINVREGDLVFLG: { value: 0x00000007, description: "Invalid registered delivery flag" },
ESME_RSYSERR: { value: 0x00000008, description: "System error" },
ESME_RINVSRCADR: { value: 0x0000000A, description: "Invalid source address" },
ESME_RINVDSTADR: { value: 0x0000000B, description: "Invalid destination address" },
ESME_RINVMSGID: { value: 0x0000000C, description: "Invalid message ID" },
ESME_RBINDFAIL: { value: 0x0000000D, description: "Bind failed" },
ESME_RINVPASWD: { value: 0x0000000E, description: "Invalid password" },
ESME_RINVSYSID: { value: 0x0000000F, description: "Invalid system ID" },
ESME_RCANCELFAIL: { value: 0x00000011, description: "Cancel SM failed" },
ESME_RREPLACEFAIL: { value: 0x00000013, description: "Replace SM failed" },
ESME_RMSGQFUL: { value: 0x00000014, description: "Message queue full" },
ESME_RINVSERTYP: { value: 0x00000015, description: "Invalid service type" },
ESME_RINVNUMDESTS: { value: 0x00000033, description: "Invalid number of destinations" },
ESME_RINVDLNAME: { value: 0x00000034, description: "Invalid distribution list name" },
ESME_RINVDESTFLAG: { value: 0x00000040, description: "Invalid destination flag" },
ESME_RINVSUBREP: { value: 0x00000042, description: "Invalid 'submit with replace' request" },
ESME_RINVESMCLASS: { value: 0x00000043, description: "Invalid esm_class field" },
ESME_RCNTSUBDL: { value: 0x00000044, description: "Cannot submit to distribution list" },
ESME_RSUBMITFAIL: { value: 0x00000045, description: "submit_sm or submit_multi failed" },
ESME_RINVSRCTON: { value: 0x00000048, description: "Invalid source address TON" },
ESME_RINVSRCNPI: { value: 0x00000049, description: "Invalid source address NPI" },
ESME_RINVDSTTON: { value: 0x00000050, description: "Invalid destination address TON" },
ESME_RINVDSTNPI: { value: 0x00000051, description: "Invalid destination address NPI" },
ESME_RINVSYSTYP: { value: 0x00000053, description: "Invalid system type" },
ESME_RINVREPFLAG: { value: 0x00000054, description: "Invalid replace_if_present flag" },
ESME_RINVNUMMSGS: { value: 0x00000055, description: "Invalid number of messages" },
ESME_RTHROTTLED: { value: 0x00000058, description: "Throttling error" },
ESME_RINVSCHED: { value: 0x00000061, description: "Invalid scheduled delivery time" },
ESME_RINVEXPIRY: { value: 0x00000062, description: "Invalid message validity period" },
ESME_RINVDFTMSGID: { value: 0x00000063, description: "Predefined message invalid or not found" },
ESME_RX_T_APPN: { value: 0x00000064, description: "ESME receiver temporary app error code" },
ESME_RX_P_APPN: { value: 0x00000065, description: "ESME receiver permanent app error code" },
ESME_RX_R_APPN: { value: 0x00000066, description: "ESME receiver reject message error code" },
ESME_RQUERYFAIL: { value: 0x00000067, description: "query_sm request failed" },
ESME_RINVOPTPARSTREAM: { value: 0x000000C0, description: "Error in optional part of PDU body" },
ESME_ROPTPARNOTALLWD: { value: 0x000000C1, description: "Optional parameter not allowed" },
ESME_RINVPARLEN: { value: 0x000000C2, description: "Invalid parameter length" },
ESME_RMISSINGOPTPARAM: { value: 0x000000C3, description: "Expected optional parameter missing" },
ESME_RINVOPTPARAMVAL: { value: 0x000000C4, description: "Invalid optional parameter value" },
ESME_RDELIVERYFAILURE: { value: 0x000000FE, description: "Delivery failure" },
ESME_RUNKNOWNERR: { value: 0x000000FF, description: "Unknown error" }
};
exports.command_status_codes = {
0x00000000: "ESME_ROK",
0x00000001: "ESME_RINVMSGLEN",
0x00000002: "ESME_RINVCMDLEN",
0x00000003: "ESME_RINVCMDID",
0x00000004: "ESME_RINVBNDSTS",
0x00000005: "ESME_RALYBND",
0x00000006: "ESME_RINVPRTFLG",
0x00000007: "ESME_RINVREGDLVFLG",
0x00000008: "ESME_RSYSERR",
0x0000000A: "ESME_RINVSRCADR",
0x0000000B: "ESME_RINVDSTADR",
0x0000000C: "ESME_RINVMSGID",
0x0000000D: "ESME_RBINDFAIL",
0x0000000E: "ESME_RINVPASWD",
0x0000000F: "ESME_RINVSYSID",
0x00000011: "ESME_RCANCELFAIL",
0x00000013: "ESME_RREPLACEFAIL",
0x00000014: "ESME_RMSGQFUL",
0x00000015: "ESME_RINVSERTYP",
0x00000033: "ESME_RINVNUMDESTS",
0x00000034: "ESME_RINVDLNAME",
0x00000040: "ESME_RINVDESTFLAG",
0x00000042: "ESME_RINVSUBREP",
0x00000043: "ESME_RINVESMCLASS",
0x00000044: "ESME_RCNTSUBDL",
0x00000045: "ESME_RSUBMITFAIL",
0x00000048: "ESME_RINVSRCTON",
0x00000049: "ESME_RINVSRCNPI",
0x00000050: "ESME_RINVDSTTON",
0x00000051: "ESME_RINVDSTNPI",
0x00000053: "ESME_RINVSYSTYP",
0x00000054: "ESME_RINVREPFLAG",
0x00000055: "ESME_RINVNUMMSGS",
0x00000058: "ESME_RTHROTTLED",
0x00000061: "ESME_RINVSCHED",
0x00000062: "ESME_RINVEXPIRY",
0x00000063: "ESME_RINVDFTMSGID",
0x00000064: "ESME_RX_T_APPN",
0x00000065: "ESME_RX_P_APPN",
0x00000066: "ESME_RX_R_APPN",
0x00000067: "ESME_RQUERYFAIL",
0x000000C0: "ESME_RINVOPTPARSTREAM",
0x000000C1: "ESME_ROPTPARNOTALLWD",
0x000000C2: "ESME_RINVPARLEN",
0x000000C3: "ESME_RMISSINGOPTPARAM",
0x000000C4: "ESME_RINVOPTPARAMVAL",
0x000000FE: "ESME_RDELIVERYFAILURE",
0x000000FF: "ESME_RUNKNOWNERR"
};
exports.command_formats = {
bind_transmitter : {
command_id : 0x00000002,
body : [
{ name: "system_id", type: "c-string", min: 1, max: 16 },
{ name: "password", type: "c-string", min: 1, max: 9 },
{ name: "system_type", type: "c-string", min: 1, max: 13 },
{ name: "interface_version", type: "int", bytes: 1 },
{ name: "addr_ton", type: "int", bytes: 1 },
{ name: "addr_npi", type: "int", bytes: 1 },
{ name: "address_range", type: "c-string", min: 1, max: 13 },
]
},
bind_transmitter_resp : {
command_id : 0x80000002,
body: [
{ name: "system_id", type: "c-string", min: 1, max: 16 }
]
},
bind_receiver : {
command_id : 0x00000001,
body : [
{ name: "system_id", type: "c-string", min: 1, max: 16 },
{ name: "password", type: "c-string", min: 1, max: 9 },
{ name: "system_type", type: "c-string", min: 1, max: 13 },
{ name: "interface_version", type: "int", bytes: 1 },
{ name: "addr_ton", type: "int", bytes: 1 },
{ name: "addr_npi", type: "int", bytes: 1 },
{ name: "address_range", type: "c-string", min: 1, max: 13 },
]
},
bind_receiver_resp : {
command_id : 0x80000001,
body: [
{ name: "system_id", type: "c-string", min: 1, max: 16 }
]
},
bind_transceiver : {
command_id : 0x00000009,
body : [
{ name: "system_id", type: "c-string", min: 1, max: 16 },
{ name: "password", type: "c-string", min: 1, max: 9 },
{ name: "system_type", type: "c-string", min: 1, max: 13 },
{ name: "interface_version", type: "int", bytes: 1 },
{ name: "addr_ton", type: "int", bytes: 1 },
{ name: "addr_npi", type: "int", bytes: 1 },
{ name: "address_range", type: "c-string", min: 1, max: 13 },
]
},
bind_transceiver_resp : {
command_id : 0x80000009,
body: [
{ name: "system_id", type: "c-string", min: 1, max: 16 }
]
},
outbind : {
command_id : 0x0000000B,
body : [
{ name: "system_id", type: "c-string", min: 1, max: 16 },
{ name: "password", type: "c-string", min: 1, max: 9 },
]
},
unbind : {
command_id : 0x00000006,
body : []
},
unbind_resp : {
command_id : 0x80000006,
body : []
},
generic_nack : {
command_id : 0x80000000,
body : []
},
submit_sm : {
command_id : 0x00000004,
body : [
{ name: "service_type", type: "c-string", min: 1, max: 6, default: "" },
{ name: "source_addr_ton", type: "int", bytes: 1, default: 5 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 21 },
{ name: "dest_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "dest_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "destination_addr", type: "c-string", min: 1, max: 21 },
{ name: "esm_class", type: "int", bytes: 1, default: 0 },
{ name: "protocol_id", type: "int", bytes: 1, default: 0 },
{ name: "priority_flag", type: "int", bytes: 1, default: 0 },
{ name: "schedule_delivery_time", type: "c-string", length: 17, default: "" },
{ name: "validity_period", type: "c-string", length: 17, default: "" },
{ name: "registered_delivery", type: "int", bytes: 1, default: 0 },
{ name: "replace_if_present_flag", type: "int", bytes: 1, default: 0 },
{ name: "data_coding", type: "int", bytes: 1, default: 8 },
{ name: "sm_default_msg_id", type: "int", bytes: 1, default: 0 },
{ name: "sm_length", type: "int", bytes: 1, default: 0 },
{ name: "short_message", type: "string", min: 1, max: 254, length_field: "sm_length", default: "" },
]
},
submit_sm_resp : {
command_id : 0x80000004,
body : [
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" },
]
},
deliver_sm : {
command_id : 0x00000005,
body : [
{ name: "service_type", type: "c-string", min: 1, max: 6, default: "" },
{ name: "source_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 21 },
{ name: "dest_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "dest_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "destination_addr", type: "c-string", min: 1, max: 21 },
{ name: "esm_class", type: "int", bytes: 1, default: 0 },
{ name: "protocol_id", type: "int", bytes: 1, default: 0 },
{ name: "priority_flag", type: "int", bytes: 1, default: 0 },
{ name: "schedule_delivery_time", type: "c-string", length: 17, default: "" },
{ name: "validity_period", type: "c-string", length: 17, default: "" },
{ name: "registered_delivery", type: "int", bytes: 1, default: 0 },
{ name: "replace_if_present_flag", type: "int", bytes: 1, default: 0 },
{ name: "data_coding", type: "int", bytes: 1, default: 0 },
{ name: "sm_default_msg_id", type: "int", bytes: 1, default: 0 },
{ name: "sm_length", type: "int", bytes: 1, default: 0 },
{ name: "short_message", type: "string", min: 1, max: 254, length_field: "sm_length", default: "" },
]
},
deliver_sm_resp : {
command_id : 0x80000005,
body : [
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" },
]
},
data_sm : {
command_id : 0x00000103,
body : [
{ name: "service_type", type: "c-string", min: 1, max: 6, default: "" },
{ name: "source_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 21 },
{ name: "dest_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "dest_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "destination_addr", type: "c-string", min: 1, max: 21 },
{ name: "esm_class", type: "int", bytes: 1, default: 0 },
{ name: "registered_delivery", type: "int", bytes: 1, default: 0 },
{ name: "data_coding", type: "int", bytes: 1, default: 0 },
]
},
data_sm_resp : {
command_id : 0x80000103,
body : [
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" }
]
},
query_sm : {
command_id : 0x00000003,
body : [
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" },
{ name: "source_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 21 },
]
},
query_sm_resp : {
command_id : 0x80000003,
body: [
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" },
{ name: "final_date", type: "c-string", length: 17, default: "" },
{ name: "message_state", type: "int", bytes: 1, default: 0 },
{ name: "error_code", type: "int", bytes: 1, default: 0 },
]
},
cancel_sm : {
command_id : 0x00000008,
body: [
{ name: "service_type", type: "c-string", min: 1, max: 6, default: "" },
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" },
{ name: "source_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 21 },
{ name: "dest_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "dest_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "destination_addr", type: "c-string", min: 1, max: 21 },
]
},
cancel_sm_resp : {
command_id : 0x80000008,
body : []
},
replace_sm : {
command_id : 0x00000007,
body : [
{ name: "message_id", type: "c-string", min: 1, max: 65, default: "" },
{ name: "source_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 21 },
{ name: "schedule_delivery_time", type: "c-string", length: 17, default: "" },
{ name: "validity_period", type: "c-string", length: 17, default: "" },
{ name: "registered_delivery", type: "int", bytes: 1, default: 0 },
{ name: "sm_default_msg_id", type: "int", bytes: 1, default: 0 },
{ name: "sm_length", type: "int", bytes: 1, default: 0 },
{ name: "short_message", type: "string", min: 1, max: 254, length_field: "sm_length", default: "" },
]
},
replace_sm_resp : {
command_id : 0x80000007,
body : []
},
enquire_link : {
command_id : 0x00000015,
body : []
},
enquire_link_resp : {
command_id : 0x80000015,
body : []
},
alert_notification : {
command_id : 0x00000102,
body : [
{ name: "source_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "source_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "source_addr", type: "c-string", min: 1, max: 65 },
{ name: "esme_addr_ton", type: "int", bytes: 1, default: 1 },
{ name: "esme_addr_npi", type: "int", bytes: 1, default: 0 },
{ name: "esme_addr", type: "c-string", min: 1, max: 65 },
],
}
};
exports.optional_params = {
dest_addr_subunit: { tag: 0x0005, type: "int", octets: 1 },
dest_network_type: { tag: 0x0006, type: "int", octets: 1 },
dest_bearer_type: { tag: 0x0007, type: "int", octets: 1 },
dest_telematics_id: { tag: 0x0008, type: "int", octets: 2 },
source_addr_subunit: { tag: 0x000D, type: "int", octets: 1 },
source_network_type: { tag: 0x000E, type: "int", octets: 1 },
source_bearer_type: { tag: 0x000F, type: "int", octets: 1 },
source_telematics_id: { tag: 0x0010, type: "int", octets: 1 },
qos_time_to_live: { tag: 0x0017, type: "int", octets: 4 },
payload_type: { tag: 0x0019, type: "int", octets: 1 },
receipted_message_id: { tag: 0x001E, type: "c-string", octets_max: 65 },
ms_msg_wait_facilities: { tag: 0x0030, type: "int", octets: 1 },
privacy_indicator: { tag: 0x0201, type: "int", octets: 1 },
source_subaddress: { tag: 0x0202, type: "octets", octets_max: 23 },
dest_subaddress: { tag: 0x0203, type: "octets", octets_max: 23 },
user_message_reference: { tag: 0x0204, type: "int", octets: 2 },
user_response_code: { tag: 0x0205, type: "int", octets: 1 },
source_port: { tag: 0x020A, type: "int", octets: 2 },
destination_port: { tag: 0x020B, type: "int", octets: 2 },
sar_msg_ref_num: { tag: 0x020C, type: "int", octets: 2 },
language_indicator: { tag: 0x020D, type: "int", octets: 1 },
sar_total_segments: { tag: 0x020E, type: "int", octets: 1 },
sar_segment_seqnum: { tag: 0x020F, type: "int", octets: 1 },
SC_interface_version: { tag: 0x0210, type: "int", octets: 1 },
callback_num_pres_ind: { tag: 0x0302, type: "octets", octets: 1 },
callback_num_atag: { tag: 0x0303, type: "octets", octets_max: 65 },
number_of_messages: { tag: 0x0304, type: "int", octets: 1 },
callback_num: { tag: 0x0381, type: "octets", octets_max: 19 },
dpf_result: { tag: 0x0420, type: "int", octets: 1 },
set_dpf: { tag: 0x0421, type: "int", octets: 1 },
ms_availability_status: { tag: 0x0422, type: "int", octets: 1 },
network_error_code: { tag: 0x0423, type: "octets", octets: 3 },
message_payload: { tag: 0x0424, type: "string" },
delivery_failure_reason:{ tag: 0x0425, type: "int", octets: 1 },
more_messages_to_send: { tag: 0x0426, type: "int", octets: 1 },
message_state: { tag: 0x0427, type: "int", octets: 1 },
ussd_service_op: { tag: 0x0501, type: "octets", octets: 1 },
display_time: { tag: 0x1201, type: "int", octets: 1 },
sms_signal: { tag: 0x1203, type: "int", octets: 2 },
ms_validity: { tag: 0x1204, type: "int", octets: 1 },
its_reply_type: { tag: 0x1380, type: "int", octets: 1 },
its_session_info: { tag: 0x1383, type: "octets", octets: 2 },
additional_status_info_text: { tag: 0x001D, type: "c-string", octets_max: 256 },
alert_on_message_delivery: { tag: 0x130C, type: "int", octets: 0 }
};
exports.optional_param_tags = {};
for (var param_name in exports.optional_params) {
exports.optional_param_tags[ exports.optional_params[param_name].tag ] = param_name;
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment