LogoLogo
DocsMiatel Platform
  • API
  • SMS API
    • Send SMS
    • Receive SMS status
    • Receive SMS
    • Response codes & errors
  • Flash Call API
    • Send Flash Call
  • Statistics API
    • Apache Kafka Bridge
Powered by GitBook
On this page
Export as PDF
  1. SMS API

Send SMS

PreviousAPINextReceive SMS status

Last updated 11 months ago

Was this helpful?

CtrlK
  • Endpoint
  • Parameters
  • Request Example
  • Response
  • Response template
  • Used response parameters:
  • Example responses

Was this helpful?

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

Endpoint

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

Parameters

username

string

Username or account name

password

string

The password associated with the given username

from

string

Sender ID (SRC-number)

to

string

Recipient's phone number (DST-number).

text

string

Text of SMS. If the content does not fit into the maximum message size according to the currently set encoding, the message will be split into multiple messages.

comment

string

(optional) The name of the communication or other comment about the sent SMS

Request Example

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

Response

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

Response template

<html><body>request_code: request_description. id:message_id. count:dlvrd_count. code:code_number</body></html>
<html><body>request_code: request_description. status:status_code. code:-code_number</body></html>

Used response parameters:

Name
Type
Description

request_code

number

The code of the delivery message (0 - Accepted; 4 - Failed)

request_description

string

Description of the delivery message code

message_id

string

The unique identifier of the send message

dlvrd_count

number

Number of short messages delivered. The value may be padded with leading zeros.

status_code

number

Response error status code of Miatel platform

code_number

number

Response code of Miatel platform

Example responses

<html><body>0: Accepted for delivery. id:1111e111-2d22-3c33-4b44-55555a555555. count:1. code:0</body></html>
<html><body>4: Failed to send sms. status:255. code:-5002</body></html>