訊息寄送方 - 內容
寄送方可能需要內容資訊以定義系統所需的其他資訊,才能成功傳送傳出訊息。開啟
,然後導覽至內容頁面。頁面描述
定義內容類型與內容值,包含需要更多資訊時寄送方適用的參數。對於其他類型之寄送方的支援內容值,請參閱下方內容。
電子郵件寄送方內容
電子郵件寄送方由傳送即時電子郵件訊息的業務服務使用。
電子郵件寄送方必須指向訊息類別 RTHTTPSNDR。此外,應對此類型的寄送方定義下列內容記錄。
內容類型 | 描述 |
---|---|
SMTP 主機名稱 | SMTP 伺服器主機名稱。 |
SMTP 使用者名稱 | 用於存取 SMTP 伺服器的使用者 ID。 |
SMTP 密碼 | 用於存取 SMTP 伺服器的密碼。 |
回應逾時 | 系統應等候即時回應的時間。 |
HTTP 寄送方
HTTP 寄送方是使用 HTTP 通訊協定將訊息傳送至 HTTP 伺服器的寄送方。HTTP 寄送方應參考 RTHTTPSNDR、RTJSONSNDR 或 SOAPSNDR 訊息類別。
建立目標 HTTP 伺服器的工作階段時需要各種參數。您可以對寄送方定義內容值集合來指定這些參數。產品提供一組與 HTTP 變數相關的內容類型。下節描述內容類型並視情況指出有效值。
定義 HTTP 寄送方之前,您必須瞭解它端 HTTP 伺服器預期如何接收要求,尤其是如何回答下列問題:
- HTTP 伺服器的位址為何?
- HTTP 伺服器使用的是 POST 還是 GET HTTP 方法?
- 如果伺服器使用的是 POST,那麼如何傳遞訊息內容?它是使用 HTTP 格式,還是以 XML 訊息本文傳遞資料?
內容類型 | 描述 | 值 |
---|---|---|
HTTP URL1 - URL9 |
用於建構目標 HTTP 伺服器的 URL。 由於 URL 可能冗長且複雜,您可以將它分成較小部分,並以個別內容記錄來定義每一部分。串連 URL1 到 URL9 中的值來建立完整的 URL。 您可以在輸入 URL 各部分的值時使用替代變數。請注意,如果已套用 XSL 將訊息轉換為 HTTP GET 參數,則可對 GET 呼叫使用替代字串 @XMLMSG@。如果 HTTP 格式不適用於訊息的類型,這項功能就很實用。 請參考支援動態 URL,以瞭解傳送外傳訊息時支援動態 URL 所需的組態。 |
|
HTTP 方法 | 用於傳送訊息的 HTTP 方法。 備註:SOAP 寄送方訊息類別 SOAPSNDR 僅支援 POST 方法。
|
POST 或 GET |
HTTP 傳輸方法 | 指定訊息的類型。您可以傳送訊息或傳送並等候回應。 | Send 或 sendReceive |
HTTP 格式資料 |
訊息為 HTML 格式時使用 ( 此內容會指定 HTTP 訊息應傳遞的格式參數 (資料)。由於格式可能有多個參數,您應對每個格式參數新增內容記錄。 格式參數的值採用 x=y 格式,其中 x 是格式參數名稱,y 則是參數值。 如果 y 包含字串 @XMLMSG@ (區分大小寫),則此字串會由服務回應 XML 訊息的內容取代。@XMLMSG@ 字串可用於 HTTP 格式資料或 HTTP URL,但無法同時用於這兩者。 如果對寄送方定義此類型的內容記錄,那麼即使其中一筆內容記錄未指定 @XMLMSG@,寄送方仍會使用 HTML 格式訊息格式來傳送訊息。 如果未對寄送方定義此類型的內容記錄,則會以 使用 GET 方法時一律必須指定。如果您使用的是 GET 方法而未指定格式資料內容記錄,則不會將任何訊息轉移至 HTTP 伺服器。 您可以在輸入格式資料的值時使用替代變數。 |
|
HTTP 登入使用者 | HTTP 伺服器可能需要驗證。新增此類型的內容記錄以指定要使用的登入使用者。 | |
HTTP 登入密碼 | HTTP 伺服器可能需要驗證。新增此類型的內容記錄以指定要使用的登入密碼。 | |
HTTP 標頭 |
有時候它端 HTTP 伺服器可能需要將 HTTP 標頭新增至訊息。 針對每個必須指定的 HTTP 標頭,您應新增值為 x:y 格式的內容記錄,其中 x 是標頭名稱,y 則是標頭值。 |
|
HTTP 逾時 | 指出等候與遠端系統建立連線的時間。 | |
字元編碼 | 指出訊息是否應編碼。寄送方會將字串 ;charset=x 新增至 HTTP 內容類型標頭 (其中 x 是此內容的值),並在傳送訊息時以該編碼進行資料編碼。 |
UTF-8 或 UTF-16 |
回應逾時 | 系統應等候遠端系統傳送回應的時間。 | |
寄送方安全性類型 | 指出要套用的所需安全性類型。(請注意,其他安全性類型僅適用於 SOAP 寄送方。如需詳細資訊,請參閱下方說明。) | BASIC (HTTP Basic)、TEXT (使用者名稱權杖純文字)、DIGEST - 使用者名稱權杖摘要、OWSM - 透過 OWSM 的 OAuth 安全性、OAUTH - OAuth 安全性。 |
OWSM 原則集 |
只有在寄送方安全性類型為 OWSM 時才適用。定義要套用的原則集。 |
輸入可延伸查尋原則集 (F1-SetOfPolicies) 的有效值。產品會提供此處可使用的值 F1-OAUTH。 |
OAuth 授權類型 |
只有在寄送方安全性類型為 OAUTH 時才適用。定義取得存取權杖的 OAuth 規格方法。 |
client_credentials |
OAuth 存取權杖 URL |
用於建構目標授權伺服器的 URL。您可以使用替代變數來建構 URL。 |
|
OAuth 用戶端 ID |
外部系統授權伺服器中目前應用程式產生的識別碼。 |
|
OAuth 用戶端密碼 |
與外部系統授權伺服器所提供 OAuth 用戶端 ID 配對的密碼。 |
|
OAuth 金鑰環 |
定義用來儲存外部系統授權伺服器所提供 OAuth 用戶端 ID 和密碼的金鑰環。如果指定金鑰環,則不允許使用 OAuth 用戶端 ID 和 OAuth 用戶端密碼內容項目。 |
|
OAuth REST API 範圍 |
端點授與的授權等級。 |
|
本文中的 OAuth 權杖要求明細 |
授權權杖要求預設會在訊息標頭中包含用戶端 ID 和密碼資訊。此內容類型可用來指出此資訊應改以要求本文傳送。 |
將此設為 'Y',即可將用戶端 ID 和密碼資訊作為授權權杖要求本文的一部分傳送。 |
即時 HTTP 寄送方
下列內容類型僅適用於具有 RTHTTPSNDR 訊息類別的寄送方。
內容類型 | 描述 |
---|---|
內容類型 | 在此處植入值以置換 HTTP 標頭中的 Content-Type 屬性,該屬性預設為 text/xml。 |
SOAP 寄送方
SOAP 寄送方是自動新增 SOAP 格式支援的 HTTP 寄送方。對於此類型的寄送方 (SOAPSNDR 訊息類別),除了上方所列的內容值之外,也可以提供下列內容項目。
內容類型 | 描述 | 值 |
---|---|---|
訊息命名空間 URI | 用於指出要納入此寄送方訊息的特定命名空間。請注意,只有在此寄送方的外部訊息連結已將命名空間選項設定為已在寄送方設定時,才使用此值。 | |
SOAP 插入時間戳記 | 指出是否應新增時間戳記。預設值為 'N'。 | Y 或 N |
SOAP 到期延遲 (單位為秒) | 指出要新增至時間戳記的到期延遲。預設值為 60。 | |
寄送方安全性類型 | 特定第三方整合的 SOAP 寄送方支援其他安全性類型。 | CIM - 使用適當的命名空間,並在 Landis+Gyr 特定的 SOAP 標頭中新增安全性資訊,MS_V30 - 使用適當的命名空間,並在 MultiSpeak v3.0 特定的 SOAP 標頭中新增安全性資訊,MS_V41R - 使用適當的命名空間,並在 MultiSpeak v4.1 特定的 SOAP 標頭中新增安全性資訊,ITRON - 在 Itron 特定的 SOAP 標頭中使用適當的 SOAP 標頭資訊安全資訊。 |
JMS 寄送方
JMS 寄送方是將訊息傳送至 JMS 佇列或 JMS 主題的寄送方。JMS 寄送方應分別參考 RTJMSQSNDR 或 RTJMSTSNDR 訊息類別。
下列參數用於連線至 JMS 資源。
內容類型 | 描述 | 值 |
---|---|---|
JMS 訊息類型 (位元組(Y)/文字(N)) | 指出資料是以位元組訊息或文字訊息形式傳送。 | Y 或 N |
JMS 使用者名稱 | 輸入連線至 JMS 資源的使用者名稱。 | |
JMS 使用者密碼 | 輸入連線至 JMS 資源所使用的密碼。 | |
JMS 標頭 |
如果訊息需要 JMS 標頭值,則使用此內容類型。 針對每個必須指定的 JMS 標頭,新增值為 x:y 格式的內容記錄,其中 x 是標頭名稱,y 則是值。 |
應用程式變數
下列參數可用來擷取應用程式變數。
內容類型 | 描述 | 值 |
---|---|---|
應用程式 ID | 識別此 API 目前的環境。 | 由 API 提供者在佈建時間決定。 |
租用戶 ID | 識別此 API 的目前租用戶。 | 由 API 提供者在佈建時間決定。 |