GDEP communication protocol

Supported device types and versions
Communication line configuration
Communication station configuration
I/O tag configuration
Literature
Changes and modifications
Document revisions

Supported device types and versions

This protocol is used for sending and receiving SMS messages and MMS ones, processing WAP requirements and playing SMS games.
The protocol is built on the standards such as TCP, HTTP (or HTTPS) and XML. GAP server (GAme Platform) on Orange side and an application (D2000 KOM process) are the communication partners.
The implementation in D2000 System supports the following messages:

Table 1

Message	Direction	Meaning
HELLO	KOM->GAP	Logging on (name + password) to GAP platform when starting the connection.
INQUIRE_LINK	KOM->GAP GAP->KOM	Testing the functionality of connection after a longer period of inactivity.
INQ_RSP	KOM->GAP GAP->KOM	Response to INQUIRE.
RECEIVE (sms)	GAP->KOM	Receiving SMS from GAP server.
RCV_RSP (sms)	KOM->GAP	Confirmation of receiving SMS by D2000 KOM.
SEND (sms)	KOM->GAP	Sending SMS message.
SND_RSP (sms)	GAP->KOM	Confirmation of receiving SMS by GAP server.
ACCEPTED	GAP->KOM	Confirmation of receiving SMS or MMS by SMS/MMS center.
ACC_RSP	KOM->GAP	Response to ACCEPTED from D2000 KOM.
RECEIPT (sms)	GAP->KOM	Confirmation of receiving SMS by an end user.
REC_RSP	KOM->GAP	Response to RECEIPT from D2000 KOM.
BY	KOM->GAP	End of connection by D2000 KOM.
BY_RSP	GAP->KOM	Response to BY from GAP server.
NAK	GAP->KOM	Unacceptable message is declined.

The following messages have not been implemented yet:

Table 2

Message	Direction	Meaning
RECEIVE (wap)	GAP->KOM	Receiving WAP requirement from GAP server.
RCV_RSP (wap)	KOM->GAP	WAP requirement by D2000 KOM.
RECEIVE (mms-xml)	GAP->KOM	Receiving MMS from GAP server.
RCV_RSP (mms-xml)	KOM->GAP	Confirmation of receiving MMS by D2000 KOM.
SEND (mms-xml)	KOM->GAP	Sending MMS.
SND_RSP (mms-xml)	GAP->KOM	Confirmation of receiving MMS by GAP server.
RECEIPT (mms)	GAP->KOM	Confirmation of receiving MMS by an end user.
SCORE	KOM->GAP	Changing the player's score.
SCO_RSP	GAP->KOM	Response to SCORE from GAP server.
NICK	KOM->GAP	Administration of nicknames: creation, canceling, adding, deleting and searching.
NICK_RSP	GAP->KOM	Response to NICK from GAP server.

Communication line configuration

Communication line category: TCP/IP-TCP
TCP Parameters:

Host: String max. 80 characters – server name in INET format (name or numerical address a.b.c.d).
Port: TCP port number (1 to 65535).
Line number: Not used, enter any number.

Note: GDEP protocol is built over HTTP or HTTPS protocol. D2000 KOM process does not include HTTPS communication. It uses the stunnel program (modular method). The stunnel program is able to wrap both the client and server communication in SSL layer. As GDEP protocol needs the implementation the both client and server on each side (both GAP server and D2000 KOM), you must start two stunnel processes:

one of them is in a server mode, which will wait on connection of GAP server. After processing the SSL layer, it will send data to the defined port, on which D2000 KOM is waiting as GDEP server (see the parameter Server Port).
other one is in a client mode, which waits on the defined port. D2000 KOM (client side) will be connected with it. After wrapping data in SSL layer, the stunnel will send them to a target computer and port (server port of GAP server). Therefore, in the parameter Host there will be localhost and in the parameter Port there will be the port number on which the stunnel process is waiting in a client mode.

Communication station configuration

Communication protocol: GDEP
Station address: not used

Note: There must be exactly ONE communication station on the line.

Station protocol parameters

You can set the following station protocol parameters:

Table 3

Key wore	Full name	Meaning	Unit	Default value
RD	Relogin Delay	Waiting before repeated attempt to log on to GAP server.	sec	10
TKI	TCP KeepInit option	KeepInit setting of TCP protocol.	-	False
CE	Station Communication Error	Number of failed attempts to connect to server when the station switches to StCOMERR status.	-	1
HE	Station Hard Error	Number of failed attempts to connect to server when the station switches to StHARDERR status.	-	3
U	User Name	User name to log on to GAP server.	-	-
P	UserPassword	Password to log on to GAP server.	-	-
HH	HTTP Host	IP address or server name, which is specified in HTTP request.	-	-
HP	HTTP Port	Port of server, which is specified in HTTP request.	-	0
SP	Server Port	Port on which KOM is listening as server.	-	1000
TSI	Timeout Send Inquire	After this timeout, KOM will send INQUIRE message (0=disabled).	sec	90
TRI	Timeout Receive Inq_Rsp	Till this timeout, KOM will wait INQ_RSP (response to INQUIRE).	sec	10
TRA	Timeout Receive Accept	After this timeout, KOM process denotes the message as expired (confirmation level 2), if ACCEPTED message does not come.	sec	10
TRR	Timeout Receive Receipt	After this timeout, KOM process denotes the message as expired (confirmation level 3), if RECEIPT message does not come.	sec	60
K1 H1 P1 K2 H2 P2	KOM Name 1 Host Address 1 Port Number 1 KOM Name 2 Host Address 2 Port Number 2	When using in D2000 System redundancy (two D2000 KOM): if name of workstation, on which D2000 KOM is running, is the same than K1 (or K2) parameter, when connecting to GAP server, HELLO message will contain the optional parameters host and port with values H1 and P1 (or H2 and P2). GAP knows on which of two D2000 KOM shall connect.

I/O tag configuration

I/O tag is defined by itsr address, which must correspond with the address specified in the tables below. I/O tag names can be different.

SMS receiving: After receiving SMS, the values of the following I/O tags will be set (if I/O tags have been configured).

Table 4

Address	Type	I/O tag name	Meaning
1	TxtO	Rcv_Id	64-bit ID of received SMS (RECEIVE message). After processing of the message by an application, KOM process should be informed, by writing into this I/O tag, to confirm the receiving by RCV_RSP message and make accessible next SMS to application (if it is in a queue). [message sequence ID on the Game Platform (64-bit number displayed decimally in ASCII format). It is used for duplicate receipt detection when a session has been re-established after the connection failure.]
2	TxtI	Rcv_Serv_Id	Parameter serv_id of received message. [service ID that this message belongs to.]
3	TxtI	Rcv_AppAddr	Parameter appaddr of received message. [destination number. It can be short or long number dedicated to the service (External Application). It is identification of the game. It is never encrypted. ]
4	TxtI	Rcv_AppAddrType	Type attribute of parameter appaddr.
5	TxtI	Rcv_Msisdn	Parameter msisdn of received message. [source number. Can be encrypted, see the type attribute.]
6	TxtI	Rcv_MsisdnType	Attribute type of parameter msisdn.
7	Ci	Rcv_Employee	Parameter employee of received message. [if application have enabled mark of employee, then element employee has value 0 – if source MSISDN is NOT employee 1 – if source MSISDN is employee]
8	Ci	Rcv_Dcs	Parameter dcs of received message. [parameter data_coding of the GDEP protocol (DCS) [SMPP PS v3.4]. (8-bit integer defined in the ASCII). Default = 0.]
9	Ci	Rcv_Esm	Parameter esm of received message. [parameter esm of the SMPP protocol (DCS) [SMPP PS v3.4]. (8-bit integer defined in the ASCII). Default = 0.]
10	TxtI	Rcv_Recv_Date	Parameter receive_date of received message. [time of receive SMS to SMS center.]
11	TxtI	Rcv_Coding	Attribute coding of parameter content. [type of coding in the element content. Currently used are: text ASCII text, base64 content is coded by code base64 – this is used for binary data.]
12	TxtI	Rcv_Content	Parameter content of received message. [nothing but data. Data sent by the subscriber to the External Application (SMS).]
13	TxtI	Rcv_MsgPart	Parameter msg_part of received message (trio ref_num/seg_num/tot_seg). [ref_num - contain an originator generated reference number so that a segmented short message may be reassembled into a single original message seg_num - sequence number of particular message within the concatenated message tot_seg - indicating the total number of fragments]

SMS sending: When sending SMS message, you should set the values for the following I/O tags (if they have been configured). The message will be sent after setting the value of I/O tag Snd_AppDefId.
The symbol (o), stated at I/O tag means that the tag is optional (it may not be configured because GDEP protocol denotes this attribute as optional).

Table 5

Address	Type	I/O tag name	Meaning
101	TxtO	Snd_Serv_Id	Parameter serv_id of sent message. [service ID that this message belongs to.]
102	TxtO	Snd_Rcv_Msg_Id (o)	Parameter rcv_msg_id of sent message. [ID of received message (RECEIVE) that this message is a response to]
103	TxtO	Snd_AppAddr

Orange GDEP

GDEP communication protocol

Communication line configuration

Communication station configuration

Station protocol parameters

I/O tag configuration