Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Messente API Library

- Messente API version: 1.1.0
- Python package version: 1.1.0
- Messente API version: 1.2.0
- Python package version: 1.2.0

[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram messages, blacklist phone numbers to make sure you're not sending any unwanted messages, manage contacts and groups. Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
[Messente](https://messente.com) is a global provider of messaging and user verification services. * Send and receive SMS, Viber, WhatsApp and Telegram messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you're not sending any unwanted messages. Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.

## Installation

Expand Down Expand Up @@ -48,11 +48,19 @@ Messente API Library provides the operations described below to access the featu
1. Returns all groups [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
1. Updates a group with the provided name [`update_group`](docs/GroupsApi.md#update_group)

### NumberLookupApi

1. Requests info about phone numbers [`fetch_info`](docs/NumberLookupApi.md#fetch_info)

### OmnimessageApi

1. Cancels a scheduled Omnimessage [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)
1. Sends an Omnimessage [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)

### StatisticsApi

1. Requests statistics reports for each country [`create_statistics_report`](docs/StatisticsApi.md#create_statistics_report)

## Auth

**Type**: HTTP basic authentication
Expand Down
9 changes: 9 additions & 0 deletions docs/ErrorCodeStatistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ErrorCodeStatistics

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/ErrorItemNumberLookup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ErrorItemNumberLookup

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | [**ErrorItemNumberLookupError**](ErrorItemNumberLookupError.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/ErrorItemNumberLookupError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ErrorItemNumberLookupError

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | Error description |
**code** | **int** | Matches the following error title. This field is a constant * 101 - Unauthorized * 102 - Invalid arguments or parameters * 103 - Server error * 104 - Crediting error #1 * 105 - Crediting error #2 * 106 - Client error |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/ErrorItemStatistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ErrorItemStatistics

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | Error title |
**details** | **str** | Error details |
**code** | [**ErrorCodeStatistics**](ErrorCodeStatistics.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/ErrorNumberLookup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ErrorNumberLookup

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**errors** | [**list[ErrorItemNumberLookup]**](ErrorItemNumberLookup.md) | An array of errors |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/ErrorStatistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ErrorStatistics

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**errors** | [**list[ErrorItemStatistics]**](ErrorItemStatistics.md) | An array of errors |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/MobileNetwork.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# MobileNetwork

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mccmnc** | **str** | Mobile country and mobile network code | [optional]
**network_name** | **str** | Mobile network name | [optional]
**country_name** | **str** | Country name | [optional]
**country_prefix** | **str** | Country prefix | [optional]
**country_code** | **str** | Country code | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


71 changes: 71 additions & 0 deletions docs/NumberLookupApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# messente_api.NumberLookupApi

All URIs are relative to *https://api.messente.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**fetch_info**](NumberLookupApi.md#fetch_info) | **POST** /hlr/sync | Requests info about phone numbers


# **fetch_info**
> SyncNumberLookupSuccess fetch_info(numbers_to_investigate)

Requests info about phone numbers

### Example

* Basic Authentication (basicAuth):
```python
from __future__ import print_function
import time
import messente_api
from messente_api.rest import ApiException
from pprint import pprint
configuration = messente_api.Configuration()
# Configure HTTP basic authorization: basicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# Defining host is optional and default to https://api.messente.com/v1
configuration.host = "https://api.messente.com/v1"
# Create an instance of the API class
api_instance = messente_api.NumberLookupApi(messente_api.ApiClient(configuration))
numbers_to_investigate = {"numbers":["+37251000000","+37251000001"]} # NumbersToInvestigate | Numbers for lookup

try:
# Requests info about phone numbers
api_response = api_instance.fetch_info(numbers_to_investigate)
pprint(api_response)
except ApiException as e:
print("Exception when calling NumberLookupApi->fetch_info: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**numbers_to_investigate** | [**NumbersToInvestigate**](NumbersToInvestigate.md)| Numbers for lookup |

### Return type

[**SyncNumberLookupSuccess**](SyncNumberLookupSuccess.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Info about phone numbers returned | - |
**400** | Invalid request | - |
**401** | Unauthorized | - |
**402** | Failed crediting | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/NumbersToInvestigate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# NumbersToInvestigate

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**numbers** | **list[str]** | Array of phone numbers |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


72 changes: 72 additions & 0 deletions docs/StatisticsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# messente_api.StatisticsApi

All URIs are relative to *https://api.messente.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_statistics_report**](StatisticsApi.md#create_statistics_report) | **POST** /statistics/reports | Requests statistics reports for each country


# **create_statistics_report**
> StatisticsReportSuccess create_statistics_report(statistics_report_settings)

Requests statistics reports for each country

### Example

* Basic Authentication (basicAuth):
```python
from __future__ import print_function
import time
import messente_api
from messente_api.rest import ApiException
from pprint import pprint
configuration = messente_api.Configuration()
# Configure HTTP basic authorization: basicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# Defining host is optional and default to https://api.messente.com/v1
configuration.host = "https://api.messente.com/v1"
# Create an instance of the API class
api_instance = messente_api.StatisticsApi(messente_api.ApiClient(configuration))
statistics_report_settings = {"start_date":"2017-01-01","end_date":"2019-06-20","message_types":["sms"]} # StatisticsReportSettings | Settings for statistics report

try:
# Requests statistics reports for each country
api_response = api_instance.create_statistics_report(statistics_report_settings)
pprint(api_response)
except ApiException as e:
print("Exception when calling StatisticsApi->create_statistics_report: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**statistics_report_settings** | [**StatisticsReportSettings**](StatisticsReportSettings.md)| Settings for statistics report |

### Return type

[**StatisticsReportSuccess**](StatisticsReportSuccess.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Created reports by countries | - |
**400** | Client Error | - |
**401** | Unauthorized | - |
**422** | Invalid data | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions docs/StatisticsReport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# StatisticsReport

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total_messages** | **int** | Sum of all messages |
**total_price** | **str** | Price for all messages |
**country** | **str** | Target country of all messages |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/StatisticsReportSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# StatisticsReportSettings

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_date** | **date** | Start date for the report |
**end_date** | **date** | End date for the report |
**message_types** | **list[str]** | Optional list of message types (sms, viber, whatsapp, hlr) | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/StatisticsReportSuccess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# StatisticsReportSuccess

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reports** | [**list[StatisticsReport]**](StatisticsReport.md) | Array of report objects |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


18 changes: 18 additions & 0 deletions docs/SyncNumberLookupResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SyncNumberLookupResult

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number** | **str** | Phone number in e.164 format |
**roaming** | **bool** | Indicates if a number is roaming | [optional]
**ported** | **bool** | Indicates if a number is ported | [optional]
**roaming_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
**current_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
**original_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
**ported_network** | [**MobileNetwork**](MobileNetwork.md) | | [optional]
**status** | **str** | Status of the phone number | [optional]
**error** | **object** | Indicates if any error occurred while handling the request | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/SyncNumberLookupSuccess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SyncNumberLookupSuccess

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**request_id** | **str** | ID of the request |
**result** | [**list[SyncNumberLookupResult]**](SyncNumberLookupResult.md) | A container for phone number info objects |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading