twsms2 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c9b64329c26980a4442660b5d63122cf0e0f716
-  data.tar.gz: d9c410f2c1024f1c2debc649d1ece684e1856427
+  metadata.gz: d39c490008149fc9f2d6a6738c1de1bdcba3ed8b
+  data.tar.gz: 1db018aafffe92c2124f607ded73d47d1959c7b6
 SHA512:
-  metadata.gz: 4a604ca2daab6d18ce54609f2b0c85aa877d7c03c11a2bc7a55b540a4fb08711b79d3d5845fe43b48161df8cc68b2650a34fca050ab907ffcc0480d873a55e59
-  data.tar.gz: d85225365844f09670f052985419df9d43615bf77c728d170c3e22c45c723fe61340e374fbc3b139182d4682b9cb95e23c55fedb47226e49bc84a9038a7444f0
+  metadata.gz: 67f2cc587cbbfaa478827e217b3d5d4451e68f6d0fb7f53776d2a0b7b6899e7483bd58f2ad20c5ec2be5ffea35e4743e3b8991645433ef3ef5a5718afbc57931
+  data.tar.gz: ae2e987cfbd410d852c064b290a583ca84d2ea9d41c319ee7a250e6870009bc69a136930c57ebe20d0d1d1b84e7c4287c46a64575332bcb8688c1ade197fda9b

data/README.md

@@ -22,7 +22,7 @@ Ruby 2 以上的版本，也可在 Ruby On Rails 專案引入
 請在您的 Ruby 或 Rails 專案裡的 Gemfile 加入以下指令
 
 ```ruby
-gem 'twsms2', '~> 1.1.0'
+gem 'twsms2', '~> 1.2.0'
 ```
 
 然後執行 bundle install 更新套件組
@@ -145,7 +145,7 @@ error code 的部分，請以 台灣簡訊 API 文件的定義為主，本套件
 
 ----
 
-### 查詢簡訊餘額
+### 查詢目前帳號所持有的簡訊餘額
 
 若你需要查詢您會員帳號的簡訊餘額，可以用以下指令處理
 
@@ -153,7 +153,7 @@ error code 的部分，請以 台灣簡訊 API 文件的定義為主，本套件
 sms_client.get_balance
 ```
 
-### 查詢簡訊餘額 的 回傳結果
+### 查詢目前帳號所持有的簡訊餘額 的 回傳結果
 
 #### 得到簡訊餘額
 
@@ -176,6 +176,56 @@ message_quota 則是簡訊餘額，代表你還剩幾封可以用，若為 0 就
 {:access_success=>false, :message_quota=>0, :error=>"TWSMS:00010"}
 ```
 
+### 查詢特定的簡訊發送狀態
+
+若你需要查詢特定的簡訊發送狀態，您可以指定 手機號碼 跟 message id 向簡訊商查詢該封簡訊最後是否已發送成功
+
+```ruby
+sms_client.get_message_status(message_id: '在 send_message 得到的 message_id', phone_number: '手機號碼')
+```
+
+### 查詢特定的簡訊發送狀態 的 回傳結果
+
+#### 得到發送狀況
+
+當你執行完成後，get_message_status 方法會回傳一組 hash 型態的結果
+
+只要 access_success 的值為 true 就一定代表系統有成功取得資料
+
+is_delivered 代表是否已寄到用戶手機，true 為是、false 為有發生 delivered 以外的狀況
+
+message_status 代表訊息狀態，可以知道是否已抵達 或是 發生通信上的錯誤 等等的相關資訊
+
+```ruby
+{:access_success=>true, :is_delivered=>true, :message_status=>"delivered", :error=>nil}
+```
+
+#### get_message_status 裡的 message_status 涵義
+
+```ruby
+'delivered'                   # 簡訊已抵達 
+'expired'                     # 簡訊寄送超過有效時間 
+'deleted'                     # 已被刪除 
+'undelivered'                 # 無法送達 
+'transmitting'                # 傳輸中，正在接收 
+'unknown'                     # 未知錯誤，可能無效 
+'rejected'                    # 被拒絕 
+'incorrect_sms_system_syntax' # 簡訊商編碼錯誤 
+'incorrect_phone_number'      # 不正確的電話號碼 
+'incorrect_content'           # 不正確的內容 
+'sms_system_other_error'      # 簡訊商系統錯誤 
+'illegal_content'             # 不合法的簡訊內容 
+'status_undefined'            # 核心 API 無法得知狀況 
+```
+
+#### 發生錯誤時
+
+若 access_success 為 false 則表示過程有出現錯誤，同時 is_delivered 會為 false，message_status 也會是 nil
+
+```ruby
+{:access_success=>false, :is_delivered=>false, :message_status=>nil, :error=>"TWSMS:00010"})
+```
+
 ----
 
 例外狀況的處理

data/lib/twsms2/version.rb

@@ -1,3 +1,3 @@
 module Twsms2
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twsms2
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Guanting Chen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler