1 of 11

API

Welcome to Miatel API documentation ✨

This documentation contains all the information you need to start using the Miatel API to send SMS or Flash Call and receive statistics

SMS API

Send SMS

If you wish to send SMS via HTTP API, please contact us at stating your Miatel account and the IP addresses to whitelist.

Endpoint

Parameters

Request Example

Response

You will get HTTP 202 response if the request was sent successfully, and HTTP 404 if there was an error.

Response template

Used response parameters:

Example responses

Receive SMS

HTTP request

You can receive SMS messages from our platform. We generate an HTTP or HTTPS request from our side and send it to your system. To receive SMS messages, please contact us at and provide a link that we can use to send incoming messages.

Link example

HTTP

HTTPS

Link parameters

The link you provided must support the following parameters:

Parameter Name

Type

Description

SMS to email

Response codes & errors

List with all response codes and errors

Response code

Response error status code

Response code description

Table with all response codes and errors

Flash Call API

Send Flash Call

If you wish to send Flash Call via HTTP API, please contact us at support@miatel.com stating your Miatel account and the IP addresses to whitelist.

Endpoint

https://sms-hub.miatel.ru:4849/sendsms?

Request Parameters

Name

Type

Description

Request Example

https://sms-hub.miatel.ru:4849/sendsms?username=client&password=98765&to=6585911223&text=1234

Statistics API

Statistics HTTP API

This API provides the ability to retrieve data, in JSON format, about SMS campaigns conducted by users of the Miatel platform.

Access to the Statistics HTTP API

The private key ip_auth_key is generated on the Miatel side. To obtain the key, please contact support at , providing your account on the Miatel platform and the IP addresses for whitelisting, or reach out to your personal manager.

Endpoint

Request parameters

Request example

API limitations

Maximum number of returned records: 100,000
Maximum request period: 31 days
Start and end time of the period are specified in GMT+0 format.
The request period should be optimized to minimize data volume.
Only one request at a time is allowed.

Send Flash Call

If you wish to send Flash Call via HTTP API, please contact us at support@miatel.com stating your Miatel account and the IP addresses to whitelist.

Endpoint

https://sms-hub.miatel.ru:4849/sendsms?

Request Parameters

Name

Type

Description

Request Example

https://sms-hub.miatel.ru:4849/sendsms?username=client&password=98765&to=6585911223&text=1234

Statistics HTTP API

This API provides the ability to retrieve data, in JSON format, about SMS campaigns conducted by users of the Miatel platform.

Access to the Statistics HTTP API

Endpoint

Request parameters

Request example

API limitations

Maximum number of returned records: 100,000
Maximum request period: 31 days
Start and end time of the period are specified in GMT+0 format.
The request period should be optimized to minimize data volume.
Only one request at a time is allowed.

The PIN code for the transfer. You can specify the value of the ring duration rt (ring time), since the time when the call is turned on differs in different directions, and you can adjust it.

rt5 means 5 seconds of the call.

(example: rt 5_1234, where 1234 is the transmitted PIN code with a call time limit of up to 5 seconds).

Receive SMS status

There are two ways to get SMS status:

Refer to our link

It is required to refer to our link https://sms-hub.miatel.ru:8008/sms_status?id={{message_id}} where {{message_id}} is the received message id when sending the request.

Response Headers

Name

Value

Response body

Name

Type

Description

Possible code statuses of the message

Status

Status name

Description

Response example

200400{"currency": "EUR","rate": "0.1","segments": 1,"status": 2}

Provide a link

You provide a link to which we will refer to inform the status of the subscriber.

Link example

https://api.client.com/miatel/res.php?id={{id}}&dlvr={{dlvrd}}&status={{status}}&{{statusname}}

Supported parameters

The URI string can contain these keywords to be replaced by real values.

Apache Kafka Bridge

The Apache Kafka Bridge is designed to duplicate all messages sent through the Miatel platform into the Apache Kafka message bus. Duplication is performed using the Change Data Capture (CDC) mechanism. Messages are serialized in JSON format.

Access to the Apache Kafka Bridge

Access is only granted via TLS using an ECC private key. The private key is generated by Miatel. To obtain the key, please contact support at support@miatel.com, specifying your Miatel platform account and the IP addresses to be whitelisted, or reach out to your personal manager.

Message Fields

Example of received data

{
"operation": "insert",
"schema": "data-sms_hub",
"table": "mdr",
"after": {
        "sms_hub_mccmnc_name": "Singapore - Singtel",
        "sms_hub_sms_time": "2023-03-05T15:20:29Z",
        "sms_hub_switch_id": 1,
        "src_num": "Miatel",
        "sms_hub_mccmnc_id": 525001,
        "username": "user_example",
        "message_body": "Hello",
        "segment_num": 1,
        "price": 0.036,
        "segment_total": 1,
        "dlr_code": 2,
        "message_id": "01d0fce6-bb81-11ed-a40f-9457a0122333",
        "resp_code": 0,
        "dst_num": "6585911223",
        "sms_hub_currency_id": 3,
        "sms_hub_sms_id": 999887766,
        "segment_id": null,
        "sms_hub_currency_name": "EUR",
        "dlr_time": "2023-03-05T15:30:01Z",
        "remote_ip": "127.0.0.1"
        },
"commit_time": "2023-09-13T12:14:33.287567138Z"
}

Kafka parameters

Apache Kafka brokers are located in two data centers within the 91.206.88.0/24 network.
Apache Kafka version: 3.5.
Consensus protocol used: KRaft.
Messages are delivered to the topic within 30 seconds after arriving on the Miatel platform.
Messages in Apache Kafka are read transactionally with the read_committed transaction isolation level.
The key of the message in the topic is the combination of sms_hub_sms_id and sms_hub_switch_id.