EIE41D1消息接口協(xié)議

1、eie消息接口協(xié)議一、概述eie消息接口為企業(yè)用戶提供了一個可編程的接入接口。使用該協(xié)議可以使企業(yè)應用系 統(tǒng)同企業(yè)信息機z間建立基于tcp/ip的連接，企業(yè)應用系統(tǒng)使用協(xié)議定義的命令可以收發(fā) 短信。二、連接企業(yè)應用系統(tǒng)通過eie消息接口與企業(yè)信息機連接，企業(yè)應用系統(tǒng)是客戶端，企業(yè)信 息機作為服務器?？蛻舳酥鲃觿?chuàng)建連接，連接一旦建立z后，將一直保持，直到企業(yè)端和信 息機端主動斷開連接或者通訊出現(xiàn)故障。目前企業(yè)信息機默認的消息接口監(jiān)聽端口是7777,在應用吋需要參考企業(yè)信息機的具 體配置。三、數(shù)據(jù)交互模式企業(yè)端同信息機端在連接上的數(shù)據(jù)交互，使用同步應答模式。即企業(yè)端首先發(fā)送一個請 求數(shù)據(jù)包，信息機

2、端接收到企業(yè)端發(fā)送的請求包后，進行內(nèi)部處理，然后將處理結杲打包返 回。在這種模式下，企業(yè)端的應用在發(fā)送請求數(shù)據(jù)包后，通常應該等待應答數(shù)據(jù)包返回，不 能在應答數(shù)據(jù)包未返冋之前發(fā)送新的數(shù)據(jù)包。所有的請求和應答數(shù)據(jù)包均使用文本進行封裝。采用類似http協(xié)議的格式，即消息頭 +消息體的格式。消息頭通過冋車換行兩個字符分割成多行，每行表示一個消息參數(shù)，消 息參數(shù)包含參數(shù)名和參數(shù)值，參數(shù)名與參數(shù)值使用冒號隔開。消息頭以一個空行表示結束。 消息體緊跟消息頭的空行（注：空行后也需要回車換行字符）。對于帶有消息體的消息必須 在頭部中，使用一個消息參數(shù)指定消息體長度參數(shù)，這個參數(shù)的參數(shù)名為content-leng

3、tho示例如下：eie-proxy-command: submilsmsubmit-time: 2004-06-04 10:20:20source-address: 1860destination-address:tatereport-request: 0 serviceld-request: eiefeetype-request: 01 feecode-request: 10content-length: 6hello!企業(yè)端應用向信息機發(fā)送請求消息到信息機返冋應答消息的過程稱為會話，會話根據(jù)每 次發(fā)送的請求不同而不同。目前定義了一些在消息頭屮通用的參數(shù)。列表如下：

4、eie-proxy-command:這個參數(shù)在所有的請求消息頭屮都必須定義。它用來表示請 求信息機完成什么處理。會話也是通過這個參數(shù)來進行分類。目前定義了 5個值：submitsm、 submitsmex、getsm、querysm. quito分別表示發(fā)送短信、發(fā)送短信（支持帳號密碼校 驗）、接收短信、查詢短信、退出接口。eie-proxy-response:這個參數(shù)在所有的應答消息頭中都必須定義。它表示請求處 理結果的狀態(tài)。目前定義了兩個狀態(tài)值，一個是0k,表示成功；另一個是error,表示出 錯。additional-info：這個參數(shù)在應答消息頭中可能會使用。它用來保存處理結果的一 些

5、額外信息。通常當應答消息的eie-proxy-response參數(shù)值為enor時，這個參數(shù)將包含出 現(xiàn)錯誤的原因描述。content-length；在所有包含了消息體的消息中都將包含這個參數(shù)。它用來定義消 息體的長度。企業(yè)端應用程序在讀完消息頭之后（即在socket緩沖區(qū)中讀到連續(xù)兩個回車 換行字符串時）。從消息頭中讀取該參數(shù)的參數(shù)值，然后繼續(xù)從socket緩沖區(qū)中讀取指定長 度的數(shù)據(jù)。（注：該參數(shù)記錄消息體長度的單位是字節(jié)）四、會話定義1、發(fā)送短信會話 請求消息包：eie-proxy-command: submitsmsubmit-time: 2004-06-04 10:20:20sourc

6、e-address: 1860destination-address:tatereport-request: 0 serviceld-request: eiefeetype-request: 01feecode-request: 10content-length: 6hello!企業(yè)端發(fā)送短信時，需要提供發(fā)送時間、源地址、目的地址、是否需要狀態(tài)報告、業(yè)務 類型、資費類別、資費代碼和短信內(nèi)容，其中發(fā)送時間、源地址、目標地址、是否需要狀態(tài) 報告、業(yè)務類型、資費類別、資費代碼保存在消息頭部中，短信內(nèi)容存放在消息體中。相關頭部參數(shù)：submit-time：企業(yè)端定義的發(fā)送時間

7、。source-address：短信源地址。destination-address:短信目標地址。statereport-request：是否需要狀態(tài)報告，0代表不要，1代表要 serviceld-request：業(yè)務類型，是數(shù)字、字母和符號的組合feetype-request：資費類別，01：對“短信目標地址”免費；02：對“短信目標地 址”按條計信息費；feecode-request：資費代碼，以分為單位，如：50代表5角content-length：短信內(nèi)容長度。應答消息包：eie-proxy-response: oksm-id: 0604-1234信息機成功接受短信后，將向企業(yè)端返冋該

8、短信的一個標識，以便企業(yè)端以后跟蹤該短 信的發(fā)送狀態(tài)。如果出現(xiàn)錯誤，將在消息頭部中返回一個錯誤原因。相關頭部參數(shù)：sm-id：短信成功提交后系統(tǒng)分配的短信id,這個id值是一個字符串，客戶端不 必解析這個id值，只需把它作為發(fā)送短信的一個標識即可。additional-info：額外的提示信息，該參數(shù)通常在出現(xiàn)錯誤后返回錯誤的原因描述。 但是在處理成功的情況下，也可能會返回，當一條短信內(nèi)容過長，系統(tǒng)會將該短信截斷，而 這條短信提交仍然成功，同吋使用該參數(shù)返回信息通知短信內(nèi)容已被截斷。2、發(fā)送短信會話（支持帳號密碼校驗） 請求消息包：eie-proxy-command: submitsmexsu

9、bmit-user: 0000password: 123456submit-time: 2004-06-04 10:20:20source-address: 1860destination-address:talereport-request: 0serviceld-request: eiefeetype-request: 01feecode-request: 10content-length: 6hello!企業(yè)端發(fā)送短信時，需要提供發(fā)送帳號、發(fā)送密碼、發(fā)送時間、源地址、目的地址、是 否需要狀態(tài)報告、業(yè)務類型、資費類別、資費代碼和短信內(nèi)容，其中發(fā)送帳號、發(fā)送密碼、

10、發(fā)送時間、源地址、目標地址、是否需要狀態(tài)報告、業(yè)務類型、資費類別、資費代碼保存在 消息頭部中，短信內(nèi)容存放在消息體中。相關頭部參數(shù)：submit-user：企業(yè)信息機設置的帳號名,一般以4位數(shù)字定義，如0000、0001等。 password:帳號名對應的密碼。submit-time：企業(yè)端定義的發(fā)送時間。source-address：短信源地址。destination-address:短信目標地址。statereport-request：是否需要狀態(tài)報告，0代表不要，1代表要 serviceld-request：業(yè)務類型，是數(shù)字、字母和符號的組合feetype-request：資費類別，01

11、：對“短信目標地址”免費；02：對“短信目標地 址”按條計信息費；feecode-request：資費代碼，以分為單位，如：50代表5角content-length：短信內(nèi)容長度。應答消息包：eie-proxy-response: oksm-id: 0604-1234信息機成功接受短信后，將向企業(yè)端返冋該短信的一個標識，以便企業(yè)端以后跟蹤該短 信的發(fā)送狀態(tài)。如果出現(xiàn)錯誤，將在消息頭部中返回一個錯誤原因。相關頭部參數(shù)：sm-id：短信成功提交后系統(tǒng)分配的短信id,這個id值是一個字符串，客戶端不 必解析這個id值，只需把它作為發(fā)送短信的一個標識即可。additional-info：額外的提示信息

12、，該參數(shù)通常在出現(xiàn)錯誤后返回錯誤的原因描述。 但是在處理成功的情況下，也可能會返回，當一條短信內(nèi)容過長，系統(tǒng)會將該短信截斷，而 這條短信提交仍然成功，同吋使用該參數(shù)返回信息通知短信內(nèi)容已被截斷3、接收短信會話 請求消息包：eie-proxy-command: getsmdestination-address-mask: 1860123企業(yè)端從企業(yè)信息機中接收一條上行短信時，可以通過消息接口向信息機發(fā)送該請求 消息包，從企業(yè)信息機緩存的上行短信隊列頭部獲取一條短信。企業(yè)信息機要求企業(yè)端必須 提供一個目標地址掩碼（掩碼是一個號碼，表示所有以該號碼串開始的手機或者特服號碼）。 其中的destinat

13、ion-address-mask參數(shù)保存企業(yè)端提供的掩碼。（注：企業(yè)端提供的掩碼通常 應該是：從移動運營簡分配的特服號+企業(yè)端內(nèi)部短號）。應答消息包：eie-proxy-response: oksm-id: 1234source-address:estination-address: 1860123receive-time: 2004-06-04 11:10:10content-length: 6hello!從企業(yè)信息機返回的上行短信采用類似發(fā)送短信使用的數(shù)據(jù)格式。相關頭部參數(shù)：sm-id：企業(yè)信息機為該上行短信分配的idosource-address：上行短信的源手

14、機號，即發(fā)送該短信的用戶手機號。destination-address：上行短信的目的手機號，應該是企業(yè)特服號開頭的號碼。receive-time：企業(yè)信息機接收到該上行短信的時間。4、查詢短信狀態(tài)會話 請求消息包：eie-proxy-command: querysmsm-id: 0604-1234企業(yè)信息機每次成功的接受企業(yè)端發(fā)送短信的請求后，都會向企業(yè)端返回該短信的一 個id值（參考發(fā)送短信會話）。企業(yè)端可以使用這個id值查詢這條短信的當前狀態(tài)。目前 定義了 6 個狀態(tài)值：cached a submited submitfailed> receivefailed、received &

15、gt; notfound, 狀態(tài)值均以文本形式定義。這些狀態(tài)含義如下：cached表示企業(yè)信息機正忙，該短信正在 緩存中。submited表示信息機已經(jīng)將短信成功發(fā)出，但還不能確認目標手機是否已經(jīng)收到 該短信。submitfailed表示信息機在發(fā)出該短信吋失敗，即該短信并未被發(fā)出。receivefailed 表示信息機已經(jīng)成功發(fā)出短信，但長吋間不能確認目標手機是否已經(jīng)收到短信，這種情況通 常認為目標手機并未接收到短信。received表示目標手機已經(jīng)接收到短信。notfound表示 企業(yè)端提供的短信id在信息機中沒有找到。應答消息包：eie-proxy-response: oksm-id: 0604-1234sm-state: submited企業(yè)信息機返回的短信狀態(tài)保存在應答消息頭部的sm-state參數(shù)中。如果企業(yè)端在請 求查詢狀態(tài)時提供了一個不合法的sm-id串，將返冋eie-peoxy-response為error的應答消 息，消息中的additional-info將保存錯誤的原因。5、退出消息接口會話 請求消息包eie-proxy-command: quit企業(yè)端準備關閉消息接口時，發(fā)送該消息通知信息機它將退出。應答消息包：