Skip to content

SocialApi.md

Latest commit

 

History

History
301 lines (217 loc) · 12.2 KB

SocialApi.md

File metadata and controls

301 lines (217 loc) · 12.2 KB
Raw

openapi_client.SocialApi

All URIs are relative to https://v2.namsor.com/NamSorAPIv2

Method HTTP request Description
phone_code GET /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber} [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.
phone_code_batch POST /api2/json/phoneCodeBatch [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, detecting automatically the local context given a name and formatted / unformatted phone number.
phone_code_geo GET /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2} [USES 11 UNITS PER NAME] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
phone_code_geo_batch POST /api2/json/phoneCodeGeoBatch [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, with a local context (ISO2 country of residence).
phone_code_geo_feedback_loop GET /api2/json/phoneCodeGeoFeedbackLoop/{firstName}/{lastName}/{phoneNumber}/{phoneNumberE164}/{countryIso2} [CREDITS 1 UNIT] Feedback loop to better infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).

phone_code

FirstLastNamePhoneCodedOut phone_code(first_name, last_name, phone_number)

[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = openapi_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SocialApi(openapi_client.ApiClient(configuration))
first_name = 'first_name_example' # str | 
last_name = 'last_name_example' # str | 
phone_number = 'phone_number_example' # str | 

try:
    # [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.
    api_response = api_instance.phone_code(first_name, last_name, phone_number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocialApi->phone_code: %s\n" % e)

Parameters

Name Type Description Notes
first_name str
last_name str
phone_number str

Return type

FirstLastNamePhoneCodedOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

phone_code_batch

BatchFirstLastNamePhoneCodedOut phone_code_batch(batch_first_last_name_phone_number_in=batch_first_last_name_phone_number_in)

[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, detecting automatically the local context given a name and formatted / unformatted phone number.

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = openapi_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SocialApi(openapi_client.ApiClient(configuration))
batch_first_last_name_phone_number_in = openapi_client.BatchFirstLastNamePhoneNumberIn() # BatchFirstLastNamePhoneNumberIn | A list of personal names (optional)

try:
    # [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, detecting automatically the local context given a name and formatted / unformatted phone number.
    api_response = api_instance.phone_code_batch(batch_first_last_name_phone_number_in=batch_first_last_name_phone_number_in)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocialApi->phone_code_batch: %s\n" % e)

Parameters

Name Type Description Notes
batch_first_last_name_phone_number_in BatchFirstLastNamePhoneNumberIn A list of personal names [optional]

Return type

BatchFirstLastNamePhoneCodedOut

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

phone_code_geo

FirstLastNamePhoneCodedOut phone_code_geo(first_name, last_name, phone_number, country_iso2)

[USES 11 UNITS PER NAME] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = openapi_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SocialApi(openapi_client.ApiClient(configuration))
first_name = 'first_name_example' # str | 
last_name = 'last_name_example' # str | 
phone_number = 'phone_number_example' # str | 
country_iso2 = 'country_iso2_example' # str | 

try:
    # [USES 11 UNITS PER NAME] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
    api_response = api_instance.phone_code_geo(first_name, last_name, phone_number, country_iso2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocialApi->phone_code_geo: %s\n" % e)

Parameters

Name Type Description Notes
first_name str
last_name str
phone_number str
country_iso2 str

Return type

FirstLastNamePhoneCodedOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

phone_code_geo_batch

BatchFirstLastNamePhoneCodedOut phone_code_geo_batch(batch_first_last_name_phone_number_geo_in=batch_first_last_name_phone_number_geo_in)

[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, with a local context (ISO2 country of residence).

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = openapi_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SocialApi(openapi_client.ApiClient(configuration))
batch_first_last_name_phone_number_geo_in = openapi_client.BatchFirstLastNamePhoneNumberGeoIn() # BatchFirstLastNamePhoneNumberGeoIn | A list of personal names (optional)

try:
    # [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, with a local context (ISO2 country of residence).
    api_response = api_instance.phone_code_geo_batch(batch_first_last_name_phone_number_geo_in=batch_first_last_name_phone_number_geo_in)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocialApi->phone_code_geo_batch: %s\n" % e)

Parameters

Name Type Description Notes
batch_first_last_name_phone_number_geo_in BatchFirstLastNamePhoneNumberGeoIn A list of personal names [optional]

Return type

BatchFirstLastNamePhoneCodedOut

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

phone_code_geo_feedback_loop

FirstLastNamePhoneCodedOut phone_code_geo_feedback_loop(first_name, last_name, phone_number, phone_number_e164, country_iso2)

[CREDITS 1 UNIT] Feedback loop to better infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = openapi_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SocialApi(openapi_client.ApiClient(configuration))
first_name = 'first_name_example' # str | 
last_name = 'last_name_example' # str | 
phone_number = 'phone_number_example' # str | 
phone_number_e164 = 'phone_number_e164_example' # str | 
country_iso2 = 'country_iso2_example' # str | 

try:
    # [CREDITS 1 UNIT] Feedback loop to better infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
    api_response = api_instance.phone_code_geo_feedback_loop(first_name, last_name, phone_number, phone_number_e164, country_iso2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocialApi->phone_code_geo_feedback_loop: %s\n" % e)

Parameters

Name Type Description Notes
first_name str
last_name str
phone_number str
phone_number_e164 str
country_iso2 str

Return type

FirstLastNamePhoneCodedOut

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]