本頁說明 RCS 企業即時通訊建立的資料檔案,這些檔案可協助電信業者進行帳單結算和稽核。如要瞭解 RCS 企業即時通訊的帳單模式,請參閱帳單常見問題。
檔案 | 說明 | 擁有存取權的使用者 |
---|---|---|
帳單事件報表 | 代理程式與使用者之間可計費事件的匯總報表。 | 所有積極為商家營運 RCS 的電信業者。 |
活動記錄 | RCS for Business 活動的原始資料記錄,包括可計費事件。 | 積極經營 RCS Business Messaging,並根據自身服務條款 (ToS) 經營 Google RCS 服務的電信業者。 |
檔案生成
每個資料檔案代表一天內使用 RCS 企業訊息服務的狀況 (以世界標準時間 (UTC) 為準)。系統每天都會產生檔案。生成過程可能需要數小時,完成時間可能有所不同。
如果是非對話式代理程式,檔案會包含檔案產生時間前 24 小時的資料。舉例來說,如果帳單事件報表是在 5 月 5 日世界標準時間上午 11 點產生,報表就會包含 5 月 4 日世界標準時間上午 11 點到 5 月 5 日世界標準時間上午 11 點的資料。
如果是對話代理程式,檔案會包含檔案產生時間前 1 到 2 天的 24 小時資料。舉例來說,如果系統在 5 月 5 日 11:00 (世界標準時間) 產生帳單事件報表,報表可能包含 5 月 3 日 11:00 (世界標準時間) 到 5 月 4 日 11:00 (世界標準時間) 的資料。
延遲的原因是,對話式代理程式的 RCS Business Messaging 活動會連結至對話,而這項作業最多可能需要 48 小時才能完成。這段延遲時間可讓 RCS Business Messaging 擷取對話中的所有訊息,再計算帳單事件。如要進一步瞭解對話型代理程式,請參閱「代理程式計費類別」。
重點:
沒有活動:如果特定日期沒有任何平台活動,系統就不會產生檔案。
命名:檔案名稱中的日期是檔案產生日期,而非檔案內資料的日期。
保留期限:檔案最多保留 63 天,期限一到就會刪除。
您可以使用這些檔案,以最新的平台使用情況指標更新資料倉儲。
檔案儲存空間和存取權
資料檔案在靜態和傳輸時都會加密。
如要透過安全檔案傳輸通訊協定 (SFTP) 擷取資料檔案,請提供 SFTP 公開金鑰。如要產生金鑰,請參閱產生 SFTP dropbox 的安全殼層 (SSH) 金鑰組。
SFTP 伺服器為 partnerupload.google.com
,連線時會使用高埠號 (19321),以提升安全性。
您可以使用下列指令存取資料檔案:
sftp -i <path_to_private_key> -P 19321 <username>@partnerupload.google.com
Google 提供的帳戶使用者名稱格式如下:
rbmreports-billableevents-<carrier name>
rbmreports-activity-<carrier name>
Google 會指定 <carrier name>
,並為每種報表類型提供個別帳戶。
您必須使用不同的帳戶,才能存取不同類型的報表。
檔案可用性
如果尚未產生任何資料檔案,您會看到類似 remote readdir("/"): No such file or directory
的 SFTP 錯誤,這是正常現象。
如果沒有 RCS 企業即時通訊流量可供回報,系統就不會產生檔案。 也就是說,系統可能不會每天產生檔案。如需空白檔案來簡化程序,請與 rbm-support@google.com 聯絡。
帳單事件報表
帳單事件報表會記錄帳單事件,這類事件是根據代理程式的帳單類別和傳送的訊息類型計算而得。只要是積極經營 RCS Business Messaging 的電信業者,都能使用帳單事件報表。
帳單事件報表包含機密資訊,但不含使用者個人識別資訊 (PII),例如 MSISDN、雜湊 MSISDN 或任何使用者專屬 ID。
代理商帳單類別
建立代理時,擁有者會根據代理與使用者的互動方式,設定代理的計費類別。帳單類別不會限制代理可傳送的訊息數量或類型。但會決定系統如何向服務專員收取訊息費用。下表說明兩大主要帳單類別。
帳單類別 | 服務專員類型 | 使用範例 | 計費方式 |
---|---|---|---|
非對話 (包括基本訊息和單一訊息類別。注意:這兩個類別已沒有任何差異。任一類別的服務專員都會以非對話式服務專員計費。 |
主要傳送單向訊息的代理程式。 |
|
系統會針對傳送給使用者的每則訊息收費。 |
對話式 | 這類服務專員的設計目的是與使用者來回互動。 |
|
以對話計費:如果一方 (代理程式或使用者) 在 24 小時內回覆另一方的訊息,系統就會開始計算對話。在對話視窗期間 (首次回覆後的 24 小時內),代理和使用者可以交換任意數量的訊息,且代理會以固定費率支付對話費用。 按訊息計費: 如果代理程式傳送訊息後,使用者在 24 小時內未回覆,系統會針對該訊息向代理程式收費,與非對話式代理程式類似。 |
下圖顯示對話式代理程式的 A2P 帳單結算工作階段範例:
對話式代理與非對話式代理
主要有兩大類帳單:對話式和非對話式。 非對話類別包括「基本訊息」和「單一訊息」類別,兩者在功能上完全相同。這兩個類別的代理程式都會以非對話式代理程式計費。
帳單類別的主要差異在於對話式和非對話式代理:
非對話式代理程式會針對傳送給使用者的每則訊息收費。
- 如果服務專員不常回覆,建議使用這個類別。
系統會以固定費率向您收取對話費用,包括 24 小時內的所有訊息。
- 這個類別最適合與使用者進行多輪對話的服務專員。
帳單事件
帳單事件報表會記錄五種不同類型的帳單事件。這類事件包括 A2P 和 P2A 訊息。
- A2P (應用程式對個人):由商家傳送。
- P2A (使用者對應用程式):由使用者傳送。
下表說明各項帳單事件如何套用至非對話式和對話式代理程式。
事件 | 說明 | 非對話式代理 | 對話式代理 |
---|---|---|---|
basic_message
|
僅含文字的 A2P 訊息,長度不得超過 160 個半形字元。如果文字包含具有 openGraph 標記的網站網址,訊息可能會顯示圖片預覽,合作夥伴無須支付額外費用。 | 無論使用者是否回覆,一律視為個別帳單事件。 | 除非使用者在 24 小時內回覆,否則系統會將其視為個別帳單事件。在這種情況下,訊息會成為 a2p_conversation 的一部分。
|
single_message
|
含有豐富內容的 A2P 訊息,或是超過 160 個半形字元的純文字訊息。 | 無論使用者是否回覆,一律視為個別帳單事件。 | 除非使用者在 24 小時內回覆,否則系統會將其視為個別帳單事件。在這種情況下,訊息會成為 a2p_conversation 的一部分。
|
a2p_conversation (商家發起)
|
使用者在收到 A2P 訊息後 24 小時內回覆,且不在現有對話中,就會觸發這項事件。 | 以上選項皆不適用,非對話式代理絕不會產生這類事件。 | 如果 P2A 訊息是在多則 A2P 訊息的 24 小時內傳送,系統只會使用緊接在 P2A 訊息前方的 A2P 訊息發起對話。這則 A2P 訊息和接下來 24 小時內傳送的任何訊息,都屬於 a2p_conversation 。
|
p2a_conversation (使用者選擇關機)
|
服務專員在收到 P2A 訊息後 24 小時內回覆,且不在現有對話中。 | 以上選項皆不適用,非對話式代理絕不會產生這類事件。 | 如果 A2P 訊息是在多則 P2A 訊息送達後的 24 小時內傳送,系統只會使用緊接在 A2P 訊息前傳送的 P2A 訊息發起對話。這則 P2A 訊息和接下來 24 小時內傳送的任何訊息,都屬於 p2a_conversation 。
|
p2a_message
|
任何類型的 P2A 訊息。 | 無論專員是否回覆,一律視為個別計費事件。 | 除非服務專員在 24 小時內回覆,否則系統會將其視為個別帳單事件。 |
帳單事件與帳單類別
請勿將 basic_message
和 single_message
帳單事件與基本訊息和單一訊息帳單類別混淆。
任何代理程式 (無論帳單類別為何) 都可以產生
basic_message
和single_message
帳單事件。「基本訊息」和「單一訊息」計費類別用於分類非對話式代理程式。這些計費類別的代理程式不會產生對話計費事件 (
a2p_conversations
或p2a_conversations
),而是會產生個別的basic_message
、single_message
和p2a_message
計費事件。
產生帳單報表
只有非測試人員流量的代理程式會產生帳單事件。帳單事件報表不會顯示測試電話號碼的活動。
這些報表假設系統會在傳送訊息時收費,而非在傳送訊息時收費。如果訊息未送達或在送達前取消,就不會觸發帳單事件。
帳單報表格式
帳單事件報表使用 rbm_billable_events_YYYY-MM-DD.csv
檔案名稱格式。檔案名稱中的日期是檔案產生日期。
報表中的每一行都是一筆記錄,代表單一帳單事件。 記錄中的欄位以 Tab 分隔。舉例來說,如果同一位代理程式進行兩次 A2P 對話,就會產生兩項帳單事件,帳單事件報表也會顯示兩筆記錄。
報表中的每筆記錄都包含下列資訊:
欄位 | 格式 | 說明 | 範例 |
---|---|---|---|
billing_event_id
|
string | UUID 識別碼。系統會在建立每個新活動時產生隨機數字。 | 242f1d9f-7c3f-4e5b-ab3f-818f188fa3ff
|
type
|
string | 活動類型:
|
single_message
|
agent_id
|
string | 參與事件的代理程式專屬 ID。 | rbm-welcome-bot@rbm.goog
|
agent_owner
|
string | 建立代理程式的合作夥伴帳戶現任擁有者電子郵件地址。 | name@aggregator.com
|
billing_party
|
string | 負責支付活動費用的當事人。
|
carrier
|
max_duration_single_message
|
數字 | 使用者回覆服務專員訊息的最長時間 (以小時為單位)。如果超過這個時間,對話啟動視窗就會關閉,且訊息會歸類為 single_message 事件。 |
24
|
max_duration_a2p_conversation
|
數字 | A2P 對話的時數上限。從使用者對服務專員初始訊息的第一個回覆開始計算。 | 24
|
max_duration_p2a_conversation
|
數字 | P2A 對話的時數上限。從對話中的第一則使用者訊息開始計算。 | 24
|
start_time
|
YYYY-mm-ddTHH:00:00Z | 活動開始的 UTC 日期/時間,採用 ISO 8601 格式,並四捨五入至最接近的小時。 A2P 訊息
P2A 訊息
|
2019-07-25T08:00:00Z
|
duration
|
數字 | 活動時間長度,四捨五入至最接近的分鐘數。 如果事件類型為 |
45
|
mt_messages
|
數字 | 事件中的行動裝置終端 (A2P) 訊息數。 | 11
|
mo_messages
|
數字 | 活動中以行動裝置發送 (P2A) 的訊息數。 | 9
|
size_kilobytes
|
數字 | 活動中所有郵件附件的總大小,四捨五入至最接近的 KB (1 KB = 1024 位元組)。 | 912
|
agent_name
|
string |
參與活動的代理商名稱。 |
XYZ Mobile USA
|
owner_name
|
string | 建立服務專員的合作夥伴帳戶現任擁有者名稱。 | XYZ Mobile
|
帳單事件報表範例
您可以下載帳單報表檔案範例。
一般檔案大小
有效 RCS Business Messaging 合作夥伴的每日報表大小,取決於他們在電信業者網路中產生的活動量。舉例來說,如果報表中有 53,000 筆記錄,檔案大小約為 8 MB。
活動記錄
活動記錄提供 RCS 商家訊息平台活動的原始資料。 您可以使用這些記錄稽核帳單事件,並建立自訂事件。
注意:活動記錄只會包含來自非測試人員電話號碼的流量。
由於活動記錄含有個人識別資訊 (PII),例如詳細交易資訊和訂閱者 MSISDN,因此只有在電信業者依據自家服務條款營運 RCS 時,才能使用活動記錄。如果您的網路有 RCS 企業版流量,並根據 Google 服務條款透過 Google RCS 啟用 RCS 活動,您就無法存取活動記錄。
活動記錄格式
活動記錄會使用 rbm_activity_YYYY-MM-DD.csv
檔案名稱格式。檔案名稱中的日期是檔案產生日期。
記錄中的欄位以 Tab 分隔,每行一筆記錄。
活動記錄中的每筆記錄都包含下列欄位:
欄位 | 格式 | 說明 | 範例 |
---|---|---|---|
activity_id
|
string | 活動的專屬 ID。 | b422e1d3-ac99-442a-853d-a875d5e61762
|
billing_event_id
|
string | 相關帳單事件的專屬 ID。如果活動與帳單事件無關 (例如沒有對應 delivery_receipt_event 的 text_message ),則此欄位可以留空。
|
91yeb201-7c3b-412b-98d2-b0a0f7abe536
|
agent_id
|
string | 代理程式的專屬 ID。 | welcome-bot@rbm.goog
|
user_id
|
string | 使用者的 MSISDN。 | 918369110173
|
direction
|
string | 訊息傳送方向:
|
MT
|
time
|
YYYY-mm-ddTHH:MM:SS.SSSZ | 以世界標準時間格式將事件提交至 RCS Business 平台時的日期和時間。請參閱「時間戳記」。 | 2019-07-25T00:29:07.033Z
|
type
|
string | 活動類型:
|
text_message
|
size_bytes
|
string | 附加至活動的檔案大小,以位元組為單位。 | 912
|
時間戳記
活動記錄中的時間戳記會記錄事件提交至 RCS 企業通訊平台的時間。如果是向使用者傳送內容的事件,系統會在訊息傳送後,才將事件記錄在活動記錄中。
舉例來說,如果系統在星期三下午 1 點傳送 RCS 企業訊息給使用者,但收件者直到星期日早上 9 點才上線,則該事件會顯示在星期日產生的活動記錄中,但時間戳記會是星期三下午 1 點。