Merge pull request #127 from PacoVu/master

Phong update
ringcentral · Oct 19, 2020 · 462987e · 462987e
2 parents c162a87 + 3a337a3
commit 462987e
Show file tree

Hide file tree

Showing 3 changed files with 215 additions and 10 deletions.
diff --git a/docs/messaging/sms/high-volume/toll-free-sms-vs-local-numbers.md b/docs/messaging/sms/high-volume/toll-free-sms-vs-local-numbers.md
@@ -17,4 +17,217 @@ Local numbers are enrolled in a Commercial Long Code / 10DLC program with wirele
 
 ## Supported Countries
 
-Currently, High Volume SMS is supported for numbers in the United States and Canada.
+Currently, High Volume SMS is supported for numbers in the United States and Canada.
+
+
+## Listing Valid High Volume SMS Numbers
+
+Send and receive SMS messages using the High Volume SMS API (`a2p-sms`) requires a phone number with the `A2PSmsSender` feature.
+
+To determine which numbers a user can use to send and receive High Volume SMS, retrieve the user's list of phone numbers from the `extension/phone-number` endpoint and then filter by numbers with the `A2PSmsSender` feature. The `extension/phone-number` is as follows where `{accountId}` and `{extensionId}` can be replaced by actual values or `~` for the current user's account and extension values.
+
+=== "HTTP"
+	```http
+	GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number
+	```
+
+=== "JavaScript"
+	```javascript
+	const RingCentral = require('@ringcentral/sdk').SDK
+
+	var rcsdk = new RingCentral( {server: "server_url", clientId: "client_id", clientSecret: "client_secret"} );
+	var platform = rcsdk.platform();
+
+	platform.login( {username: "username", password: "password", extension: "extension_number"} )
+
+	platform.on(platform.events.loginSuccess, function(e){
+			console.log("Login success")
+			detect_high_volume_sms_feature()
+	});
+
+	async function detect_high_volume_sms_feature(){
+		try{
+			var resp = await platform.get("/restapi/v1.0/account/~/extension/~/phone-number")
+			var jsonObj = await resp.json()
+			for (var record of jsonObj.records){
+				for (var feature of record.features){
+					if (feature == "A2PSmsSender"){
+						if (record.paymentType == "TollFree")
+							console.log(`This phone number ${record.phoneNumber} is a toll-free number and provisioned for using to send high volume SMS`)
+						else
+							console.log(`This phone number ${record.phoneNumber} is a local 10-DLC number and provisioned for using to send high volume SMS`)
+					}
+				}
+			}
+		}catch(e){
+			console.log(e.message)
+		}
+	}
+	```
+
+=== "Python"
+	```python
+	from ringcentral import SDK
+
+	sdk = SDK( "client_id", "client_secret", "server_url" )
+	platform = sdk.platform()
+	platform.login( "username", "extension", "password" )
+
+	response = platform.get('/restapi/v1.0/account/~/extension/~/phone-number')
+	for record in response.json().records:
+		print "This phone number " + record.phoneNumber + " has the following features: "
+		for feature in record.features:
+			if feature == "A2PSmsSender":
+				if record.paymentType == "TollFree":
+					print (" This phone number " + record['phoneNumber'] + " is a toll-free number and provisioned for using to send high volume SMS")
+				else:
+					print (" This phone number " + record['phoneNumber'] + " is a 10-DCL local number and provisioned for using to send high volume SMS")
+	```
+
+=== "PHP"
+	```php
+	<?php
+	require('vendor/autoload.php');
+
+	$rcsdk = new RingCentral\SDK\SDK( "client_id", "client_secret", "server_url" );
+	$platform = $rcsdk->platform();
+	$platform->login( "username", "extension_number", "password" );
+
+	$response = $platform->get('/account/~/extension/~/phone-number');
+	foreach ($response->json()->records as $record){
+		foreach ($record->features as $feature){
+			if ($feature == "A2PSmsSender"){
+				if ($record->paymentType == "TollFree")
+					print_r ("This phone number ".$record->phoneNumber." is a toll-free number and provisioned for using to send high volume SMS\n");
+				else
+					print_r ("This phone number ".$record->phoneNumber." is a 10-DLC local number and provisioned for using to send high volume SMS\n");
+			}
+		}
+	}
+	```
+
+=== "C#"
+	```c#
+	using System;
+	using System.Threading.Tasks;
+	using RingCentral;
+
+	namespace Read_Phone_Number
+	{
+		class Program
+		{
+			static void Main(string[] args)
+			{
+				detect_phone_number_feature().Wait();
+			}
+			static private async Task detect_phone_number_feature()
+			{
+				RestClient rc = new RestClient("client_id", "client_secret", "server_url");
+		    await rc.Authorize("username", "extension_number", "password");
+
+		    var response = await rc.Restapi().Account().Extension().PhoneNumber().Get();
+
+		    foreach (var record in response.records)
+		    {
+					foreach (var feature in record.features) {
+						if (feature == "A2PSmsSender")
+						{
+							if (record.paymentType == "TollFree")
+							{
+								Console.WriteLine("This phone number " + record.phoneNumber + " is a toll-free number and provisioned for using to send high volume SMS" );
+							}
+							else
+							{
+								Console.WriteLine("This phone number " + record.phoneNumber + " is a 10-DLC local number and provisioned for using to send high volume SMS" );
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+	```
+
+=== "Java"
+	```java
+	import com.ringcentral.*;
+	import com.ringcentral.definitions.*;
+
+	public class Read_Phone_Number {
+		public static void main(String[] args) {
+			try {
+				detect_phone_number_feature();
+			} catch (RestException | IOException e) {
+				e.printStackTrace();
+			}
+		}
+
+		public static void detect_phone_number_feature() throws RestException, IOException{
+			RestClient restClient = new RestClient("client_id", "client_secret", "server_url");
+			restClient.authorize("username", "extension_number", "password");
+
+			var response = restClient.restapi().account().extension().phonenumber().get();
+			for (var record : response.records) {
+				for (var feature : record.features) {
+					if (feature == "A2PSmsSender"){
+						if (record.paymentType == "TollFree") {
+							System.out.println("This phone number " + record.phoneNumber + " is a toll-free number and provisioned for using to send high volume SMS" );
+						}else{
+							System.out.println("This phone number " + record.phoneNumber + " is a 10-DLC local number and provisioned for using to send high volume SMS" );
+						}
+					}
+				}
+			}
+		}
+	}
+	```
+
+=== "Ruby"
+	```ruby
+	require 'ringcentral'
+
+	rc = RingCentral.new( 'client_id', 'client_secret', 'server_url')
+	rc.authorize( username:  'username', extension: 'extension_number', password:  'password')
+	response = rc.get ('/restapi/v1.0/account/~/extension/~/phone-number')
+
+	for record in response.body['records'] do
+	    for feature in record['features'] do
+					if feature == "A2PSmsSender"
+							if record.paymentType == "TollFree"
+									puts "This phone number " + record['phoneNumber'] + " is a toll-free number and provisioned for using to send high volume SMS"
+							else
+									puts "This phone number " + record['phoneNumber'] + " is a 10-DLC local number and provisioned for using to send high volume SMS"
+							end
+					end
+	    end
+	end
+	```
+
+### Response
+
+This example response shows the `A2PSmsSender` feature:
+
+```json hl_lines="12"
+{
+  "uri":"https://platform.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/phone-number?page=1&perPage=100",
+  "records":[
+    {
+      "id":33333333,
+      "phoneNumber":"+16505550100",
+      "paymentType":"Local",
+      "type":"VoiceFax",
+      "usageType":"DirectNumber",
+      "features":[
+        "CallerId",
+        "A2PSmsSender",
+      ],
+      "status":"Normal",
+      "country":{
+        "uri":"https://platform.devtest.ringcentral.com/restapi/v1.0/dictionary/country/1",
+        "id":"1",
+        "name":"United States"
+      }
+    }
+  ]
+}
+```
diff --git a/docs/messaging/sms/high-volume/valid-a2p-sms-numbers.md b/docs/messaging/sms/high-volume/valid-a2p-sms-numbers.md
@@ -2,13 +2,6 @@
 
 Send and receive SMS messages using the High Volume SMS API (`a2p-sms`) requires a phone number with the `A2PSmsSender` feature.
 
-A High Volume SMS phone number can be either a 10-DLC local number or a Toll-Free number.
-
-| paymentType | Description |
-|-|-|
-| `Local` |  |
-| `TollFree` |  |
-
 
 ## Listing Valid High Volume SMS Numbers
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -97,10 +97,9 @@ pages:
       - 'Sending High Volume SMS': 'messaging/sms/high-volume/sending-highvolume-sms.md'
       - 'Reading High Volume Message Store': 'messaging/sms/high-volume/message-store.md'
       - 'Toll-Free vs. Local Numbers': 'messaging/sms/high-volume/toll-free-sms-vs-local-numbers.md'
-      - 'Valid High Volume SMS Numbers': 'messaging/sms/high-volume/valid-a2p-sms-numbers.md'
       - 'Opt-in / Opt-out': 'messaging/sms/high-volume/opt-out.md'
       - 'Event Notifications': 'messaging/sms/high-volume/events.md'
-      - 'Errors Description': 'messaging/sms/high-volume/handling-errors.md'
+      - 'Errors Handling': 'messaging/sms/high-volume/handling-errors.md'
     - 'Fax':
       - 'Sending Faxes': 'messaging/fax/sending-faxes.md'
       - 'Multipart Formats': 'messaging/fax/fax-multipart-formats.md'