Skip to content

Commit 0c1874d

Browse files
hmoraleshmorales
authored
Merge pull request #15 from erikkai/patch-1
updates to fix links
2 parents 47a57f3 + 1e8ebcc commit 0c1874d

File tree

1 file changed

+23
-25
lines changed

1 file changed

+23
-25
lines changed

‎README.rst‎

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,23 @@
22
TeleSign
33
========
44

5-
:Info:
6-
For more information, visit the `TeleSign web site <http://www.TeleSign.com>`_.
7-
For the latest source code, visit the `TeleSign github repository <https://github.com/TeleSign/csharp_telesign/tree>`_.
5+
**Information**: For more information, visit the `TeleSign website <http://www.TeleSign.com>`_ or the `TeleSign Developer Portal <https://developer.telesign.com/>`_.
86

9-
:Author:
10-
Telesign Corp.
7+
**Author**: Telesign Corp.
118

12-
---------------------------------
139
TeleSign Web Services: .NET SDK
1410
---------------------------------
1511

16-
**TeleSign Web Services** conform to the `REST Web Service Design Model <http://en.wikipedia.org/wiki/Representational_state_transfer>`_. Services are exposed as URI-addressable resources through the set of *RESTful* procedures in our **TeleSign REST API**.
12+
**TeleSign web services** conform to the `REST Web Service Design Model <http://en.wikipedia.org/wiki/Representational_state_transfer>`_. Services are exposed as URI-addressable resources through the set of *RESTful* procedures in our **TeleSign REST API**.
1713

18-
The **TeleSign .NET SDK** is a Microsoft .NET component that provides an interface to `TeleSign Web Services <http://www.telesign.com/products-demos/>`_.
14+
The **TeleSign .NET SDK** is a Microsoft .NET component that provides an interface to `TeleSign web services <https://developer.telesign.com/docs/getting-started-with-the-rest-api>`_.
1915

2016
It contains a .NET Framework class library that presents our web services in an intuitive, hierarchical object model, so you can create and manipulate them in the way you're accustomed to. You can use this SDK to build TeleSign‑based .NET applications.
2117

2218
Authentication
2319
--------------
2420

25-
**You will need a Customer ID and API Key in order to use TeleSign’s REST API**. If you are already a customer and need an API Key, you can generate one in the `Client Portal <https://teleportal.telesign.com>`_. If you are not a customer and would like to get an API Key, please contact `[email protected] <mailto:[email protected]>`_
21+
**You will need a Customer ID and API Key in order to use TeleSign’s REST API**. If you are already a customer and need an API Key, you can generate one in `TelePortal <https://teleportal.telesign.com>`_. If you are not a customer and would like to get an API Key, please contact `[email protected] <mailto:[email protected]>`_.
2622

2723
You supply your credentials to the API either by editing the TeleSign.config.xml file and filling in the CustomerId and
2824
SecretKey values or you can create the credentials in code. Passing null to the service constructors uses the file.
@@ -67,7 +63,7 @@ You can use the TeleSign .NET SDK in either of two modes. The rich mode is recom
6763
+======================+==========================================================================+
6864
| Rich | Provides an object-oriented framework that models web services as |
6965
| | high-level actors, and low-level processes as mediator objects. |
70-
| | Automatically parses the JSON data from server responses, and creates |
66+
| | Automatically parses the JSON data from server responses and creates |
7167
| | Response objects from it. |
7268
| | |
7369
+----------------------+--------------------------------------------------------------------------+
@@ -94,51 +90,53 @@ Rich Mode Classes
9490
| | |
9591
| | ``public PhoneIdStandardResponse StandardLookup(string phoneNumber)`` |
9692
| | Retrieves the standard set of details about the specified phone |
97-
| | number. This includes the type of phone (e.g., land line or mobile), |
98-
| | and it's approximate geographic location. |
93+
| | number. This includes the type of phone (for example, land line or |
94+
| | mobile), and its approximate geographic location. |
9995
| | ``public PhoneIdScoreResponse ScoreLookup(string phoneNumber)`` |
10096
| | Retrieves a score for the specified phone number. This ranks the |
10197
| | phone number's "risk level" on a scale from 0 to 1000, so you can |
102-
| | code your web application to handle particular use cases (e.g., to |
103-
| | stop things like chargebacks, identity theft, fraud, and spam). |
98+
| | code your web application to handle particular use cases (for |
99+
| | example, to stop things like chargebacks, identity theft, fraud, |
100+
| | and spam). |
104101
| | ``public PhoneIdContactResponse ContactLookup(string phoneNumber)`` |
105102
| | In addition to the information retrieved by *standard*, this service |
106-
| | provides the Name & Address associated with the specified phone |
103+
| | provides the name and address associated with the specified phone |
107104
| | number. |
108105
| | |
109106
| | ``public PhoneIdLiveResponse LiveLookup(string phoneNumber)`` |
110107
| | In addition to the information retrieved by *standard*, this service |
111108
| | provides information about the subscriber status, device status, |
112-
| | roaming status and roaming country. |
109+
| | roaming status, and roaming country. |
113110
| | |
114111
| | |
115112
+----------------------+--------------------------------------------------------------------------+
116-
| VerifyService.cs | The **VerifyService** class exposes two services for sending users a |
113+
| VerifyService.cs | The **VerifyService** class exposes four services for sending users a |
117114
| | verification token (a three to five-digit number). You can use this |
118-
| | mechanism to simply test whether you can reach users at the phone number |
115+
| | mechanism to test whether you can reach users at the phone number |
119116
| | they supplied, or you can have them use the token to authenticate |
120117
| | themselves with your web application. In addition, this class also |
121118
| | exposes a service that allows you to confirm the result of the |
122119
| | authentication. |
123120
| | |
124121
| | You can use this verification factor in combination with *username* |
125-
| | & *password* to provide *two-factor* authentication for higher |
122+
| | and *password* to provide *two-factor* authentication for higher |
126123
| | security. |
127124
| | |
128125
| | ``public VerifyResponse SendSms(string phoneNumber)`` |
129-
| | Send a text message containing the verification code to the |
126+
| | Sends a text message containing the verification code to the |
130127
| | specified phone number (supported for mobile phones only). |
131128
| | |
132129
| | ``public VerifyResponse InitiateCall(string phoneNumber)`` |
133-
| | Calls the specified phone number, and using a recorded message speaks|
134-
| | the verification code to the user. |
130+
| | Calls the specified phone number and uses a recorded message to |
131+
| | speak the verification code to the user. |
135132
| | |
136133
| | ``public VerifyResponse ValidateCode(`` |
137134
| | ``string referenceId,`` |
138135
| | ``string verifyCode)`` |
139136
| | |
140-
| | Checks the code supplied is correct. You make this call in your |
141-
| | application after users complete the authentication transaction. |
137+
| | Checks that the code supplied is correct. You make this call in |
138+
| | your application after users complete the authentication |
139+
| | transaction. |
142140
| | |
143141
| | ``public VerifyResponse CheckStatus(string referenceId)`` |
144142
| | |
@@ -147,7 +145,7 @@ Rich Mode Classes
147145

148146
Code Example: PhoneId Contact Lookup
149147
------------------------------------
150-
These example assume you are using the file for authentication/configuration described above.
148+
These examples assume you are using the file for authentication/configuration described above.
151149

152150
>>>
153151
string phoneNumber = "+1 555-555-5555";

0 commit comments

Comments
 (0)