Skip to content

Commit c0022a5

Browse files
committed
private preview concept doc for NLS
1 parent fe13d78 commit c0022a5

File tree

3 files changed

+91
-0
lines changed

3 files changed

+91
-0
lines changed
142 KB
Loading
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Number Lookup API concepts in Azure Communication Services
3+
titleSuffix: An Azure Communication Services concept document
4+
description: Learn about Communication Services Number Lookup API concepts.
5+
author: hkaraa
6+
manager: rcole
7+
services: azure-communication-services
8+
9+
ms.author: hkaraa
10+
ms.date: 05/02/2023
11+
ms.topic: conceptual
12+
ms.service: azure-communication-services
13+
ms.subservice: number lookup
14+
---
15+
16+
# Number Lookup overview
17+
18+
[!INCLUDE [Private Preview Notice](../../includes/private-preview-include.md)]
19+
> This feature is available today only for US and Canadian phone numbers.
20+
21+
Azure Communication Services enables you to retrieve insights and lookup a specific phone number using the Communication Services Number Lookup SDK. It's part of the Number Management SDK and can be used to support customer service scenarios, appointment reminders, two-factor authentication, and other real-time communication needs. Communication Services Number Lookup allows you to reliably retrieve number insights before engaging with end users.
22+
[!INCLUDE ]
23+
24+
25+
## Number Lookup features
26+
27+
Key features of Azure Communication Services Number Lookup SDKs include:
28+
29+
- **Simple** Our API is easy to integrate with your application. We provide detailed documentation to guide you through the process, and our team of experts is always available to assist you.
30+
- **High Accuracy** We gather data from the most reliable suppliers to ensure that you receive accurate data. Our data is updated regularly to guarantee the highest quality possible.
31+
- **High Velocity** Our API is designed to deliver fast and accurate data, even under high loads. It is optimized for speed and performance to ensure that you always receive the information you need, quickly and reliably.
32+
- **SMS Capability Check** Our API provides you with the associated number type to determine whether or not an SMS can be sent to a particular number. This helps avoid frustrating attempts to send messages to non-SMS capable numbers.
33+
- **Carrier Details** We provide information about the country of destination and carrier information. This can help you estimate potential costs and find alternative messaging methods (e.g. sending an email).
34+
35+
## Value Proposition
36+
37+
The main benefits the solution will provide to ACS customers can be summarized on the below:
38+
- **Reduce Cost:** optimize your communication expenses by sending messages only to phone numbers that are SMS ready and still active
39+
- **Increase efficiency:** better target customers based on subscribers’ data (name, type, location…). You can also decide the best communication channel to choose based on status (e.g. SMS or email while roaming instead of calls).
40+
41+
## Key Use Cases
42+
43+
- **Validate the number can receive the SMS before you send it:** Check if a number has SMS capabilities or not and decide if needed to use different communication channels.
44+
*Contoso bank collected the phone numbers of the people who are interested in their services on their site. Contoso wants to send an invite to register for the promotional offer. Contoso checks before sending the link on the offer if SMS is possible channel for the number that customer provided on the site and don’t waste money to send SMS on landline or disconnected mobile numbers.*
45+
- **Estimate the total cost of an SMS campaign before you launch it:** Get the current carrier of the target number and compare that with the list of known carrier surcharges.
46+
*Contoso, a marketing company, wants to launch a large SMS campaign to promote a product. Contoso checks the current carrier details for the different numbers he is targeting with this campaign to estimate the cost based on what ACS is charging him.*
47+
48+
![Diagram showing call recording architecture using calling client sdk.](../numbers/MVP_Use_Case.png)
49+
50+
## Next steps
51+
52+
> [!div class="nextstepaction"]
53+
> [Get started with Number Lookup API](../../quickstarts/number-lookup/getdata.md)
54+
55+
The following documents may be interesting to you:
56+
57+
- Familiarize yourself with the [Number Lookup SDK](../numbers/number-lookup-sdk.md)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Number Lookup SDK overview for Azure Communication Services
3+
titleSuffix: An Azure Communication Services concept document
4+
description: Provides an overview of the Number Lookup SDK and its offerings.
5+
author: hkaraa
6+
manager: rcole
7+
services: azure-communication-services
8+
9+
ms.author: hkaraa
10+
ms.date: 05/02/2023
11+
ms.topic: conceptual
12+
ms.service: azure-communication-services
13+
ms.subservice: number lookup
14+
---
15+
16+
# Number Lookup SDK overview
17+
18+
[!INCLUDE [Private Preview Notice](../../includes/private-preview-include.md)]
19+
20+
Azure Communication Services Number Lookup SDK can be used to your applications in order to add additional checks before sending and SMS or placing a call.
21+
22+
## Number Lookup SDK capabilities
23+
24+
The following list presents the set of features which are currently available in our SDKs.
25+
26+
| Group of features | Capability | .NET | JS | Java | Python |
27+
| ----------------- | ------------------------------------------------------------------------------------- | --- | ---- | ---- | ------ |
28+
| Core Capabilities | Get Number Type | ✔️ ||||
29+
| | Get Country of origin (ISO code) | ✔️ ||||
30+
| | Get Carrier registered name | ✔️ ||||
31+
| | Get associated Mobile Network Code, if available(two or three decimal digits used to identify network operator within a country) | ✔️ ||||
32+
| | Get associated Mobile Country Code, if available(three decimal digits used to identify the country of a mobile operator) | ✔️ ||||
33+
| Phone Number | All number types in US&Canada and in E164 format | ✔️ ||||
34+

0 commit comments

Comments
 (0)