[TOC] > [規范](https://wiki.geekdream.com/Specification/json-rpc_2.0.html) ## 概述 SON-RPC是一個無狀態且輕量級的遠程過程調用(RPC)協議。 本規范主要定義了一些數據結構及其相關的處理規則。它允許運行在基于socket,http等諸多不同消息傳輸環境的同一進程中。其使用[JSON](http://www.json.org/)（[RFC 4627](http://www.ietf.org/rfc/rfc4627.txt)）作為數據格式。 ## 請求對象 **jsonrpc** > 指定JSON-RPC協議版本的字符串，必須準確寫為“2.0” **method** > 包含所要調用方法名稱的字符串，以rpc開頭的方法名，用英文句號（U+002E or ASCII 46）連接的為預留給rpc內部的方法名及擴展名，且不能在其他地方使用。 **params** > 調用方法所需要的結構化參數值，該成員參數可以被省略。 **id** > 已建立客戶端的唯一標識id，值必須包含一個字符串、數值或NULL空值。如果不包含該成員則被認定為是一個通知。該值一般不為NULL[\[1\]](https://wiki.geekdream.com/Specification/json-rpc_2.0.html#id1)，若為數值則不應該包含小數[\[2\]](https://wiki.geekdream.com/Specification/json-rpc_2.0.html#id2)。 ## 響應對象 **jsonrpc** > 指定JSON-RPC協議版本的字符串，必須準確寫為“2.0” **result** > 該成員在成功時必須包含。 > > 當調用方法引起錯誤時必須不包含該成員。 > > 服務端中的被調用方法決定了該成員的值。 **error** > 該成員在失敗是必須包含。 > > 當沒有引起錯誤的時必須不包含該成員。 > > 該成員參數值必須為5.1中定義的對象。 **id** > 該成員必須包含。 > > 該成員值必須于請求對象中的id成員值一致。 > > 若在檢查請求對象id時錯誤（例如參數錯誤或無效請求），則該值必須為空值。 響應對象必須包含result或error成員，但兩個成員必須不能同時包含。 ## 錯誤對象 **code** > 使用數值表示該異常的錯誤類型。 必須為整數。 **message** > 對該錯誤的簡單描述字符串。 該描述應盡量限定在簡短的一句話。 **data** > 包含關于錯誤附加信息的基本類型或結構化類型。該成員可忽略。 該成員值由服務端定義（例如詳細的錯誤信息，嵌套的錯誤等）。 \-32768至-32000為保留的預定義錯誤代碼。