中國(guó)電信qchat業(yè)務(wù)終端參數(shù)配置接口要求-系統(tǒng)和用戶數(shù)據(jù)分冊(cè)

中國(guó)電信 Qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 系統(tǒng)和用戶數(shù)據(jù)分冊(cè) （征求意見(jiàn)稿） 中國(guó)電信股份有限公司廣州研究院 二零 壹零 年 三 月 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 2 頁(yè) 目錄 1 范圍 .3 1.1 文檔更改歷史 .3 2 縮略語(yǔ) .5 3 管理終端數(shù)據(jù)配置文檔的 XCAP 服務(wù) .6 3.1 終端數(shù)據(jù)配置文檔 .6 3.2 支持的 HTTP 方法 .6 3.3 支持的 HTTP 頭 .6 3.3.1 適用于所有操作的頭 .6 3.3.2 PUT 必須攜帶的頭 .6 3.3.3 用于條件操作 HTTP 頭 .7 3.4 終端數(shù)據(jù)配置服務(wù)器 XCAP 請(qǐng)求 URL.8 3.5 終端數(shù)據(jù)配置服務(wù)器器后向兼容對(duì)客戶端 XML 解析的要求 .9 4 終端數(shù)據(jù)配置服務(wù)器 XCAP 接口規(guī)范 . 10 4.1 概述 . 10 4.2 正常響應(yīng) . 10 4.2.1 正常響應(yīng)描述 . 10 4.3 錯(cuò)誤響應(yīng) . 10 4.3.1 錯(cuò)誤響 應(yīng)描述 . 11 4.4 操作終端數(shù)據(jù)配置文檔 . 15 4.4.1 Data Schema . 15 4.4.2 使用場(chǎng)景 . 18 5 終端數(shù)據(jù)配置服務(wù)器 短消息（ SMS）接口規(guī)范 . 28 5.1 TDCS 通知的短消息負(fù)荷 . 28 5.2 收到通知后如何產(chǎn)生獲取用戶配置文檔 更新的 URL . 29 6 終端數(shù)據(jù)配置服務(wù)器客戶端的配置信息 . 30 6.1 配置信息 . 30 6.2 主副地址切換建議 . 30 7 對(duì)手機(jī)終端和用戶管理平臺(tái)群組操作能力的建 議 . 31 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 3 頁(yè) 1 范圍 終端數(shù)據(jù)配置服務(wù)器 (Terminal Data Configuraiton Server: TDCS) 是用戶終端配置數(shù)據(jù)管理和下發(fā)的 XML 文檔管理服務(wù)器 .文檔的管理操作包括新建 /讀取 /修改 . 這些操作是通過(guò) XCAP 接口完成的。終端數(shù)據(jù)配置服務(wù)器 (TDCS) 還提供數(shù)據(jù)下發(fā)給終端的能力。下發(fā)通知是通過(guò)短信實(shí)現(xiàn)的。 本文定義終端與終端數(shù)據(jù)配置服務(wù)器 (TDCS)進(jìn)行通信時(shí)的接口規(guī)范。 本文用 TDCS 表示終端數(shù)據(jù)配置服務(wù)器。 1.1 文檔更改歷史 時(shí)間 說(shuō)明 2009.2.12 以下為更改的主要內(nèi)容： : 增加 content-type application/xcap-el+xml 3.4 : 增加對(duì) FQDN 使用的解釋 4.4.2: 修改示例消息中的幾處錯(cuò)誤。 .2: 增加使用 CR order 的注意事項(xiàng) . 5.1 : 短消息負(fù)荷更改 5.2 : 終端獲取 XUI 的方法更改 6.1 : 服務(wù)器故障轉(zhuǎn)移定時(shí)參數(shù)取值修改 6.2 : 增加了主副地址切換的方法建議 7 : 增加了手機(jī) UIM 卡更換的考慮 另外修改了一些文字錯(cuò)誤。 2009.3.2 : 響應(yīng)消息改為 201 Created. 并在 .1 中加入對(duì)已有 Call Restriction 替換的注釋。 2009.7.14 5.1：修改 TDCS 采用 SMGP 協(xié)議 要求及流程 說(shuō)明。 2009.8.5 5.1：修改 TDCS 發(fā)送的 為 ，以及針對(duì)的樣例“ QCHAT”修改 為 “ PTT” 。 2009.8.5 修改配置信息更新流程圖。 2009.8.31 1 4.4.1 的 data schema 中加入 xs:any 元素以備將來(lái)擴(kuò)展 2. 文檔 URI 示例中 改為 3. 文檔示例中用戶域名改為 2009.11.18 更正圖 5-1 中的協(xié)議標(biāo)識(shí)。 2009.11.23 修改文檔中所有“ ”為“ ”。 2010.3.1 修改文檔中所有“ ”為“ ”。 2010.3.25 修改文檔中所有“ ”為“ sh.glms.vnet.mobi:9445”。 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 4 頁(yè) 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 5 頁(yè) 2 縮略語(yǔ) Term/Acronym Definition 3GPP 3rd Generation Partnership Project AUID Application Usage ID FQDN Fully Qualified Domain Name TDCS Terminal Data Configuration Server HTTP Hypertext Transfer Protocol IETF Internet Engineering Task Force OMA Open Mobile Alliance SMPP Short Message Peer-to-peer Protocol SMSC Short Message Service Center URI Uniform Resource Identifier URL Uniform Resource Locator XCAP XML Configuration Access Protocol XDM XML Document Management XDMC XML Document Management Client XDMS XML Document Management Server XML Extensible Markup Language XUI XCAP User Identity 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 6 頁(yè) 3 管理終端數(shù)據(jù)配置文檔的 XCAP 服務(wù) 3.1 終端數(shù)據(jù)配置文檔 在 TDCS 中，存在用戶終端配置文檔，即適用于某一用戶的終端配置文檔。該文檔包含該用戶的終端進(jìn)行 PTT 適用的配置信息。 3.2 支持的 HTTP 方法 TDCS支持以下 HTTP/XCAP操作 : HTTP GET （獲取 用戶配置文檔 信息） HTTP PUT (新建 或修改 用戶配置文檔 ) HTTP DELETE （ 修改 用戶配置文檔中某些信息） 3.3 支持的 HTTP 頭 3.3.1 適 用于 所有操作的頭 用于認(rèn)證的頭 : ClientID “ClientID” 在每個(gè) HTTP請(qǐng)求中都必須攜帶 . “ClientID” 可以被 WAP 網(wǎng)關(guān)或用戶群組管理平臺(tái)加入，并隨請(qǐng)求消息送到 TDCS。 ClientID應(yīng)該攜帶明文的用戶 ID 信息。 TDCS 信任“ ClientID”所包含的用戶 ID 就是請(qǐng)求發(fā)起者的用戶 ID。 注意：運(yùn)營(yíng)商也可以選用其它的 HTTP 頭作為用于認(rèn)證的頭，如： P-Asserted-Identity. 但所有的發(fā)送到 TDCS 的請(qǐng)求必須使用相同的頭。 用于識(shí)別客戶端協(xié)議版本的頭 : GLMSClientVersion “GLMSClientVersion” 在每個(gè) HTTP請(qǐng)求中都必須攜帶 . TDCS 客戶端用 “GLMSClientVersion”表示它所實(shí)現(xiàn)的 TDCS 協(xié)議版本。對(duì)應(yīng)于本規(guī)范，版本號(hào)應(yīng)為“ 11.01” 注意：運(yùn)營(yíng)商也可以選用其它的 HTTP 頭作為用于版本標(biāo)識(shí)的頭，如： GLMS-Group-Version. 但所有的發(fā)送到 TDCS 的請(qǐng)求必須使用相同的頭。 3.3.2 PUT 必須攜帶的頭 對(duì) XCAP PUT 操作 , 下列 HTTP 頭必須攜帶： “Content Type” 和 “Content Length”. 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 7 頁(yè) Content Type Content-Type 頭域指定所包含的消息體的媒體類型。其格式 為 : Content-Type = Content-Type : media-type TDCS 中有效的 content type 為 : Content-Type: application/user-config+xml Content-Type: application/xcap-el+xml 在不同場(chǎng)景下的具體使用參見(jiàn)第 4 章。 Content Length Content-Length 頭域指定消息體的長(zhǎng)度 （ 8 位字節(jié)數(shù)）。其格式為： Content-Length = Content-Length : 1*DIGIT 例如 : Content-Length: 3495 3.3.3 用于條件操作 HTTP 頭 HTTP 定義了幾個(gè)可以被客戶端用來(lái)做條件請(qǐng)求的頭域： If-None-Match 和 If-Match。 客戶端可以根據(jù)所請(qǐng)求資源的實(shí)體標(biāo)簽（ entity tag）來(lái)做條件請(qǐng)求 . 這些條件請(qǐng)求的頭域在請(qǐng)求消息里是可選用的 . 條件請(qǐng)求的頭域可以解決并發(fā)請(qǐng)求的沖突問(wèn)題。 If-Match If-Match 請(qǐng)求頭域被 HTTP 方法 (PUT/DELETE)用來(lái)做有條件操作 . 對(duì)一個(gè)或多個(gè)從群組服務(wù)器獲得的實(shí)體， XDS 客戶端可以在請(qǐng)求的 If-Match 頭中包含某個(gè)實(shí)體的entity tag 以 確認(rèn)它所具有的那個(gè)實(shí)體是最新的 . If-Match 頭可以被用在以下場(chǎng)景中 : 條件 PUT XDM 客戶端想增加或修改服務(wù)器 XDM 文檔中的某個(gè)元素（ element），并且希望服務(wù)器所具有的文檔版本和客戶端當(dāng)前所具有的那個(gè)文檔相同時(shí)才能修改?？蛻舳丝梢栽谡?qǐng)求中包含 If-Match 頭 , 并將客戶端所具有的實(shí)體標(biāo)簽（ entity tag）值寫(xiě)在里面 . 如果文檔已 經(jīng)改變，群組服務(wù)器會(huì)拒絕這個(gè)請(qǐng)求返回 412 （條件失敗） . 在這種情況下，客戶端需要重新用 GET 請(qǐng)求從服務(wù)器獲取這個(gè)文檔并保存服務(wù)器在 200 OK 中返回的新的實(shí)體標(biāo)簽（ entity tag）。 客戶端可以把新的 實(shí)體標(biāo)簽（ entity tag）放在 If-Matc 頭中 重新請(qǐng)求修改文檔。 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 8 頁(yè) 如果操作成功， 響應(yīng)消息的 etag 頭會(huì)包含剛被修改過(guò)的資源的新的實(shí)體標(biāo)簽（ entity tag）。 條件 DELETE XDM 客戶端也可以在 DELETE 請(qǐng)求中包含 If-Match 頭來(lái)做條件刪除 . DELETE 請(qǐng)求的 200 OK 響應(yīng)會(huì)包含一個(gè) etag 頭域 , 帶有所刪除元素所在的整個(gè)文檔的實(shí)體標(biāo)簽（ entity tag） If-None-Match If-None-Match請(qǐng)求頭域可以和 GET請(qǐng)求方法一起使用做條件請(qǐng)求 . If-None-Match頭中 可以包含客戶端以前從服務(wù)器所獲取的資源實(shí)體的 實(shí)體標(biāo)簽（ entity tag） 。 If-None-Match 頭可以被用在以下場(chǎng)景中 : 條件 GET 當(dāng) XDM 客戶端本地存有一個(gè)文檔的版本，它可以做條件 GET 來(lái)判斷服務(wù)器對(duì)統(tǒng)一文檔是否有更新。如果本地文檔仍然是最 新的，客戶端就不會(huì)重新下載文檔，以此節(jié)省網(wǎng)絡(luò)的使用。為了達(dá)到這個(gè)目的，客戶端在 GET 請(qǐng)求中攜帶 If-None-Match 頭域，其中包含客戶端當(dāng)前文檔的 實(shí)體標(biāo)簽（ entity tag） . 終端數(shù)據(jù)配置服務(wù)器 如果發(fā)現(xiàn)服務(wù)器文檔標(biāo)簽和客戶端不同，會(huì)響應(yīng) 200 OK. 如果服務(wù)器文檔標(biāo)簽和客戶端相同 , 服務(wù)器會(huì)響應(yīng) 304 Not Modified. 3.4 終端數(shù)據(jù)配置服務(wù)器 XCAP 請(qǐng)求 URL 1. XCAP 根節(jié)點(diǎn) （ XCAP root） XCAP 根定義了所有可被請(qǐng)求的資源所在的位置 . XCAP 根用 HTTP URI 表示 , 被稱為XCAP 根 RUI。對(duì) 終端數(shù)據(jù)配置服務(wù)器 XCAP 根 被定義為 /TDCS FQDN/tdcs-services/. 注：在具體構(gòu)造 HTTP 請(qǐng)求時(shí)， TDCS FQDN 應(yīng)該為 TDCS 服務(wù)器的地址，并且在發(fā)出HTTP 請(qǐng)求時(shí)放在 HOST HTTP 頭中，而不是 Request-URI 中。另外，由于 TDCS 有主副地址， TDCS FQDN 可能是兩個(gè)。（關(guān)于主副地址，請(qǐng)參見(jiàn)第 6 章） 2. 文檔選擇器 （ Document Selector） 在文檔根節(jié)點(diǎn)下的每一個(gè) XML 文檔使用文檔選擇器 作為 唯一標(biāo)識(shí)，文檔選擇器類似于由多個(gè)路徑標(biāo)識(shí)符組成的一個(gè)完整路徑，使用“ /”作為路徑分隔符 . 第一個(gè)路徑部分必須是XCAP AUID。 終端數(shù)據(jù)配置服務(wù)器支持 以下 XCAP AUID: 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 9 頁(yè) USER-CONFIG: 用來(lái)進(jìn)行群組的操作 在每個(gè) AUID 下有兩個(gè)子 XCAP 分支 . 一個(gè)稱 為 “用戶樹(shù)”（“ user” tree） , 保存某個(gè)用戶的終端配置文檔“ index” 。 另一個(gè)分支是“全局樹(shù)”（“ global” tree） , 保存適用于所有用戶的 終端配置 文檔 “ index” . AUID 之后的路徑部分必須是 global 或 users. 每個(gè)用戶對(duì)服務(wù)器而言都有一個(gè)用戶名，被稱為 XCAP 用戶 標(biāo)識(shí)符 （ XCAP User Identifier: XUI). 文檔選擇器余下的部分 (global 或 XUI 以后的路徑 )指向具體的文檔名 . 終端數(shù)據(jù)配置文件名為“ index”，并被保存在 users 樹(shù)下。 3. 節(jié)點(diǎn)選擇器 （ Node selector） 節(jié)點(diǎn)選擇器指定 XML 文檔中具體被操作的節(jié)點(diǎn) . 節(jié)點(diǎn)選擇器指向 XML 元素或元素屬性 . 4. 產(chǎn) 生 TDCS 請(qǐng)求 URL 訪問(wèn) 終端數(shù)據(jù)配置服務(wù)器 的某個(gè)用戶的 XML 文檔 , 使用以下的 URL 格式 : http:/FQDN of TDCS server/service name/AUID/users/XUI of user/index 訪問(wèn) TDCS 文檔的 XML 元素，使用以下的 URL 格式 : document selector/node selector 3.5 終端數(shù)據(jù)配置服務(wù)器 器后向兼容對(duì)客戶端 XML 解析的要求 這里的 終端數(shù)據(jù)配置服務(wù)器 客戶端指所有與 TDCS 進(jìn)行 HTTP/XCAP 通信客戶端應(yīng)用程序。 TDCS 會(huì)不斷加入新的功能 . 群組管理的 XML schema 在將來(lái)可能會(huì) 被 擴(kuò)展。 TDCS 升級(jí)到新的版本而客戶端有可能仍然是舊的版本。為了使 TDCS 后向兼容， TDCS 客戶端的實(shí)現(xiàn)必須要遵循以下建議 : o TDCS 客戶端必須忽略服務(wù)器返回的合法的 XML 文檔中不能識(shí)別的 XML 元素 或?qū)傩裕皇菆?bào)錯(cuò)退出對(duì)文檔的處理 . 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 10 頁(yè) 4 終端數(shù)據(jù)配置服務(wù)器 XCAP 接口 規(guī)范 4.1 概述 TDCS 為客戶端應(yīng)用提供 XCAP 接口來(lái)管理服務(wù)器存儲(chǔ)的 終端配置 XML 文檔 . 客戶端應(yīng)用可以 新建 /讀取 XML 文檔及其 XML 元素和屬性 . 本章給出 終端數(shù)據(jù)配置服務(wù)器 XCAP 接口規(guī)范。 4.2 正常響應(yīng) 如果客戶端的請(qǐng)求被成功處理， TDCS支持成功的 2xx 狀態(tài)碼： 狀態(tài)碼 描述 200 OK 201 Created 4.2.1 正常響應(yīng)描述 200 (OK) 響應(yīng) 當(dāng) XCAP GET/PUT/DELETE 請(qǐng)求被成功處理時(shí)返回 . 示例消息 : HTTP/1.1 200 OK etag: bcbcbc Content-Length: 0 . . . 201 (Created) 響應(yīng) 當(dāng) XCAP PUT 請(qǐng)求被執(zhí)行并其請(qǐng)求 的 resrouce 已經(jīng)產(chǎn)生 . 示例消息 : HTTP/1.1 201 Created etag: ababab . . . Content-Length: 0 4.3 錯(cuò)誤響應(yīng) XCAP 使用與 HTTP協(xié)議相同定義的錯(cuò)誤響應(yīng)狀態(tài)碼。 TDCS支持 3類錯(cuò)誤狀態(tài)碼： 3xx, 4xx, 和 5xx. 3xx 是重定向狀態(tài)碼，指示客戶端為滿足請(qǐng)求去采取其它的行動(dòng)。 4xx 是客戶端錯(cuò)中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 11 頁(yè) 誤碼，指出客戶端請(qǐng)求可能包含的錯(cuò)誤 . 5xx 是服務(wù)器錯(cuò)誤碼，指示服務(wù)器知道自己遇到問(wèn)題而不能處理當(dāng)前的請(qǐng)求。 狀態(tài)碼 描述 304 Not Modified 400 Bad Request 403 Forbidden 404 Not Found 405 Method Not Allowed 409 Conflict 412 Precondition Failed 415 Unsupported Media Type 500 Internal Server Error 503 Service Unavailable Error 4.3.1 錯(cuò)誤響應(yīng)描述 304 (Not Modified) 響應(yīng) 在條件 GET 中使用 . 客戶端在 If-None-Match 頭中包含的 etag 與服務(wù)器所具有的該文檔 etag相同 響應(yīng)消息示例 : HTTP/1.1 304 Not Modified Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 403 (Forbidden) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng) . TDCS 不能處理該請(qǐng)求 ， 盡管理解該請(qǐng)求。 TDCS 可能攜帶請(qǐng)求被拒絕的原因在 403 響應(yīng) 的“ reason-phrase” 中。 響應(yīng)消息示例 : HTTP/1.1 403 Forbidden. The request is not allowed since the associated feature is locked. Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 400 (Bad Request) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng)。由于語(yǔ)法錯(cuò)誤 TDCS 不能理解該請(qǐng)求 . 響應(yīng)消息示例 : HTTP/1.1 400 Bad Request Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 12 頁(yè) 404 (Not Found) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng) . TDCS 不能找到被請(qǐng)求的資源。 響應(yīng)消息示例 : HTTP/1.1 404 Not Found Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 405 (Method Not Allowed) 響應(yīng) 可以對(duì) XCAP 請(qǐng)求 響應(yīng) . TDCS 理解請(qǐng)求的方法但是不支持該操作 響應(yīng)消息示例 : HTTP/1.1 405 Method Not Allowed Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 409 (Conflict) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng)。請(qǐng)求因?qū)Ξ?dāng)前資源的沖突而不能完成。 409 響應(yīng)可攜帶 XML 消息體來(lái)指定沖突的具體原因。 以下是 409 響應(yīng)中所包含的 “xcap-error” data schema. “xcap-error” 可以用來(lái)給出具體沖突原因。客戶端應(yīng)該支持以下 schema： 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 13 頁(yè) 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 14 頁(yè) 響應(yīng)消息示例 : HTTP/1.1 409 Conflict Content-Type: application/xcap-error+xml Content-Length: xxxxx 412 (Precondition Failed) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng)。 客戶端可以攜帶 If-Match 頭域來(lái)包含客戶端所具有的 etag. 如果文檔在服務(wù)器中已改變， 412 就會(huì)被返回 . 響應(yīng)消息示例 : HTTP/1.1 412 Precondition Failed Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 415 (Unsupported Media Type) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng)。 終端數(shù)據(jù)配置服務(wù)器 不接受請(qǐng)求消息中的內(nèi)容編碼。 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 15 頁(yè) 響應(yīng)消息示例 : HTTP/1.1 415 Unsupported Media Type Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 500 (Internal Server Error) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng) . 終端數(shù)據(jù)配置服務(wù)器 遇到不可預(yù)料的情況不能完成請(qǐng)求 . 響應(yīng)消息示例 : HTTP/1.1 500 Internal Server Error Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 0 503 (Service Unavailable) 響應(yīng) 可以對(duì) XCAP GET/PUT/DELETE 操作響應(yīng) . 終端數(shù)據(jù)配置服務(wù)器 因過(guò)載或維護(hù)等原因暫時(shí)不能處理請(qǐng)求 . 響應(yīng)消息示例 : HTTP/1.1 503 Service Unavailable Content-Type: text/plain; charset=ISO-8859-1 Content-Length: 0 4.4 操作 終端數(shù)據(jù)配置 文檔 4.4.1 Data Schema TDCS 支持以下終端數(shù)據(jù)配置文檔 schema。 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 16 頁(yè) 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 17 頁(yè) 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 18 頁(yè) 4.4.2 使用場(chǎng)景 場(chǎng)景總結(jié) 創(chuàng)建 /替換用戶終端數(shù)據(jù)配置 文檔 查詢用戶終端數(shù)據(jù)配置文檔 增加 Call Restriction 刪除 Call Restriction 查詢和更新用戶其它配置參數(shù) 創(chuàng)建 /替換用戶終端數(shù)據(jù)配置 文檔 .1. 概述 該操作用來(lái)創(chuàng)建 /替換適用于某 用戶的 終端數(shù)據(jù)配置 文檔 . 只有系統(tǒng)管理員可以創(chuàng)建 /替換用戶的終端配置文檔。 成功的 XCAP PUT 操作會(huì)返回 201 Created 響應(yīng) （創(chuàng)建文檔）或 200 OK 響應(yīng) （替換文檔） . 失敗的操作會(huì)返回 403 (Forbidden), 404 (Not Found) , 409 (Conflict) 或 412 (Precondition Failed)。 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 19 頁(yè) .2. 用例 A d m i n T D C S1 . X C A P P U T2 . a 201 C r e a t e d2 . b 403 / 404 / 409 / 412圖 4-1 管理員創(chuàng)建用戶終端書(shū)記配置文檔 1. 管理員創(chuàng)建一個(gè)用戶終端數(shù)據(jù)配置文檔 。它發(fā)起一個(gè) XCAP PUT 請(qǐng)求 請(qǐng)求消息 : PUT http:/FQDN of TDCS server/service name/user-config/users/XUI of user/index HTTP/1.1 . . . ClientID: requestors XUI Content-Type: application/user-config+xml Content-Length: xxxxx document content 請(qǐng)求消息示例 : 創(chuàng)建不含 Call Restrictions 的配置文件 PUT http:/sh.glms.vnet.mobi:9445/tdcs-services/user-config/users/4600013311111111111PTT.189.cn/index HTTP/1.1 . . . ClientID: systemadmPTT.189.cn Content-Type: application/user-config+xml Content-Length: xxxxxTT.189.cn 0280 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 20 頁(yè) true false 請(qǐng)求消息示例 : 創(chuàng)建含 Call Restrictions 的配置文件 PUT http:/sh.glms.vnet.mobi:9445/tdcs-services/user-config/users/4600013311111111111PTT.189.cn/index HTTP/1.1 . . . ClientID: systemadmPTT.189.cn Content-Type: application/user-config+xml Content-Length: xxxxxTT.189.cnTT.189.cn 0 1 1 1 1 0 0280 true false 2.a TDCS 接受請(qǐng)求返回 201 Created. 2.b TDCS 拒絕請(qǐng)求返回 403/404/409/412 錯(cuò)誤響應(yīng)，并包含詳細(xì)的錯(cuò)誤信息 響應(yīng)消息 : HTTP/1.1 201 Created . . . etag: etag number Content-Length: 0 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 21 頁(yè) 響應(yīng)消息示例 : HTTP/1.1 201 Created . . . etag: ababab Content-Length: 0 查詢用戶終端數(shù)據(jù)配置文檔 .1. 概述 該操作用來(lái)從“用戶樹(shù)”下獲取用戶 終端數(shù)據(jù)配置 文檔 . XCAP GET 請(qǐng)求的響應(yīng)消息包含詳細(xì)的文檔 信息 . 某用戶可以獲取自己的用戶終端配置文檔。系統(tǒng)管理員可以獲取所有用戶的終端配置文檔。 終端也要利用該操作獲取創(chuàng)建或更新的配置信息。 成功的 XCAP GET 操作會(huì)返回 200 OK 響應(yīng)，并包含群組信息 . 失敗的操作會(huì)返回 304 (Not Modified ), 403 (Forbidden) 或 404 (Not Found)等。 .2. 用例 A d m i n T D C S1 . X C A P G E T2 . a 200 OK2 . b 304 / 403 / 404圖 4-2 管理員得到一個(gè)終端數(shù)據(jù)配置文檔 1. 管理員 要得到一個(gè)用戶 的終端配置 文檔。它發(fā)起 XCAP GET 請(qǐng)求 請(qǐng)求消息 : GET http:/FQDN of TDCS server/service name/user-config/users/XUI of user/index HTTP/1.1 . . . If-None-Match: etag number 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 22 頁(yè) ClientID: requestors XUI Content-Length: 0 請(qǐng)求消息示例 : GET http:/sh.glms.vnet.mobi:9445/tdcs-services/user-config/users/4600013311111111111PTT.189.cn/index HTTP/1.1 . . . If-None-Match: ababab ClientID: systemadmPTT.189.cn Content-Length: 0 2.a TDCS 接受 XCAP GET 請(qǐng)求返回 200 OK 響應(yīng)，并包含 配置 信息 2.b TDCS 拒絕請(qǐng)求返回 304/403/404 錯(cuò)誤響應(yīng)，并包含詳細(xì)的錯(cuò)誤信息 響應(yīng)消息 : HTTP/1.1 200 OK etag: etag number Content-Type: application/user-config+xml Content-Length: xxxxx . . . document content 響應(yīng)消息示例 : HTTP/1.1 200 OK etag: bcbcbc Content-Type: application/vnd.oma.poc.groups+xml Content-Length: xxxxxTT.189.cnTT.189.cn 0 1 1 1 1 0 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 23 頁(yè) 0280 true false 增加 Call Restriction .1. 概述 該操作可以用來(lái) 修改 終端數(shù)據(jù)配置文檔 增加 Call Restriction。 XCAP PUT 被使用。請(qǐng)求消息中攜帶新的 Call Restriction。 只有系統(tǒng)管理員可以發(fā)起此操作。 成功的 XCAP PUT 操作返回 201 Created 響應(yīng) . 失敗的操作會(huì)返回 403 (forbidden), 404 (not found)， 409 (conflict)和 412 (Precondition Failed)。 注：增加的 Call Restriction 是由 cr-order 來(lái)唯一標(biāo)識(shí)的 。如果新加的 Call Restriction 的 cr-order 在文檔中已經(jīng)存在，本操作會(huì)變 成對(duì)已有 Call Restriction 的替換，如果成功會(huì)返回200 OK. .2. 用例 A d m i n T D C S1 . X C A P P U T2 . a 20 12 . b 403 / 404 / 409 / 412圖 4-3 管理員增加某一用戶的 call restrictions 配置信息 1. 管理員想增加某一用戶的 Call Restriction 配置信息，發(fā)起一個(gè) XCAP PUT 請(qǐng)求 注意：發(fā)起的請(qǐng)求 URI 中，必須指定新的 Call Restriction 的 CR-order. CR-order 表示該Call Restriction 的順序，它必須與已有 Call Restriction 的 CR-order 不同。否則， TDCS認(rèn)為這是對(duì)已有 Call Restriction 的替換。 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 24 頁(yè) 請(qǐng)求消息： PUT http:/FQDN of TDCS server/service name/user-config/users/XUI of user/index/user-config/carrier-level-call-restrictions/call-restrictioncr-order=”CR Order Attribute Value” HTTP/1.1 . . . If-Match: etag number ClientID: requestors XUI Content-Type: application/xcap-el+xml Content-Length: xxxxx document content 請(qǐng)求消息示例 : PUT http:/sh.glms.vnet.mobi:9445/tdcs-services/user-config/users/4600013311111111111PTT.189.cn/index/user-config/carrier-level-call-restrictions/call-restrictioncr-order=”3” HTTP/1.1 . . . If-Match: abcde ClientID: systemadmPTT.189.cn Content-Type: application/xcap-el+xml Content-Length: xxxxx * 1 1 0 2.a TDCS 接受請(qǐng)求返回 201 Created. 2.b TDCS 拒絕請(qǐng)求返回 403/404/409/412 錯(cuò)誤響應(yīng)，并包含詳細(xì)的錯(cuò)誤信息 響應(yīng)消息： HTTP/1.1 201 Created . . . etag: etag number Content-Length: 0 響應(yīng)消息示例 : HTTP/1.1 201 Created . . . etag: ababab Content-Length: 0 中國(guó)電信 qchat 業(yè)務(wù)終端參數(shù)配置接口技術(shù)要求 -系統(tǒng)和用戶數(shù)據(jù)分冊(cè) 第 25 頁(yè) 刪除 Call Restriction .1. 概述 該操作可以用 來(lái) 修改 終端數(shù)據(jù)配置文檔 刪除 Call Restriction。 XCAP DELETE 被使用。 只有系統(tǒng)管理員可以發(fā)起此操作。 成功的 XCAP DELETE 操作返回 200 OK 響應(yīng) .