Маркетолог

• название компании
• логин подключения
• описание проблемы
• пример сообщения: дата, время, system_id, имя отправителя, номер получателя, message_id, коды ошибок
• tcpdump, логи с ошибкой, статистика по ошибке
   

POST /messages 

Content-type: application/json 

Пример с использованием одного имени отправителя: 2 сообщения отправляются от имени SMS Naming. В этом случае объект "from" (и, при необходимости, поле "class") прописываются один раз в объекте "options"

{
 "messages": [
{
"content": {
"short_text": "sms text #1"
},
"to": [
{
"msisdn": "79836362346",
"message_id": "10345678-f123-4694-91d7-233df79f65445"
}
]
},
{
"content": {
"short_text": "sms text #2"
},
"to": [
{
"msisdn": "79836362347",
"message_id": "10345678-f123-4694-91d7-233df79f65446"
}
]
}
 ],
 "options": {
"class": 22,
"from": {
"sms_address": "SMS Naming"
}
 }
}

Пример с использованием разных имён. В этом случае объект "from" (и, при необходимости, поле "class") присутствуют в каждом элементе массива "messages". 

{
 "messages": [
{
"content": {
"short_text": "sms text #1"
},
"from": {
"sms_address": "SMS Naming #1"
},
"to": [
{
"msisdn": "79836362346",
"message_id": "10345678-f123-4694-91d7-233df79f65445"
}
]
},
{
"content": {
"short_text": "sms text #2"
},
"from": {
"sms_address": "SMS Naming #2"
},
"to": [
{
"msisdn": "79836362347",
"message_id": "10345678-f123-4694-91d7-233df79f65446"
}
]
}
 ]
}

	              
               Текст = СтрЗаменить(ТекстСообщения, Символы.ПС, " ");
              
               СтруктураОтправки = Новый Структура;
              
               МассивСообщений = Новый Массив;
              
               Для каждого Адресат Из Адресаты Цикл
              
                              ОчередноеСообщение = Новый Структура;
                             
                              ОчередноеСообщение.Вставить("content", Новый Структура("short_text", Текст));
                              Если НЕ ИспользоватьПользовательскийКласс Тогда
                                            ОчередноеСообщение.Вставить("from",Новый Структура("sms_address", Отправитель));
                              КонецЕсли;
                             
                              МассивАдресата = Новый Массив;
                              Идентификатор1С = Строка(Новый УникальныйИдентификатор);
                              МассивАдресата.Добавить(Новый Структура("msisdn, message_id", Адресат.Значение, Идентификатор1С));
                             
                              ОчередноеСообщение.Вставить("to", МассивАдресата);
                             
                              МассивСообщений.Добавить(ОчередноеСообщение); 
                             
                              СохранитьСообщениеВОтправленных(Новый Структура("Адресат, ТекстСообщения, Идентификатор1С", Адресат.Значение, Текст, Идентификатор1С));
                             
               КонецЦикла;
              
               СтруктураОтправки.Вставить("messages", МассивСообщений);
              
               Если ИспользоватьПользовательскийКласс Тогда
                              СтруктураОтправки.Вставить("options", Новый Структура("class, from", Класс, Новый Структура("sms_address", Отправитель)));
               КонецЕсли;
               Запись = Новый ЗаписьJSON;
               Запись.УстановитьСтроку();
               ЗаписатьJSON(Запись, Данные);
               СтрокаJSON = Запись.Закрыть();
               Соединение = Новый HTTPСоединение(Сервер, 443, Логин, Пароль,,, Новый ЗащищенноеСоединениеOpenSSL());
               ЗапросHTTP = Новый HTTPЗапрос;

               ЗапросHTTP.Заголовки.Вставить("Content-type", "application/json");
               ЗапросHTTP.УстановитьТелоИзСтроки(СтрокаJSON);
               ЗапросHTTP.АдресРесурса = АдресЗапроса;
              
               Ответ = Соединение.ВызватьHTTPМетод("POST",ЗапросHTTP);
               

Текст полученного JSON-файла

{
"messages": [
{
"content": {
"short_text": "SMS text"
}
,
"from": {
"sms_address": "SMS Naming"
}
,
"to": [
{
"msisdn": "msisdn here",
"message_id": "UUID here"
}
]
}
]
}

Также вы можете интегрироваться с 1С с помощью специального расширения или обработки

Скачать файлом 

import requests
from requests.auth import HTTPBasicAuth
def sent_message(login, password, naming, to, text_message):
   url = 'https://omnichannel.mts.ru/http-api/v1/messages'
   body = {
   "messages": [
   {
   "content": {
   "short_text": text_message
   },
   "from": {
   "sms_address": naming
   },
   "to": [
   {
   "msisdn": to
   }
   ]
   }]
   }
   resp = requests.post(url , json=body, auth = HTTPBasicAuth(login, password)) 
   return resp
     
def check_message(login, password, message_id):
   url = 'https://omnichannel.mts.ru/http-api/v1/messages/info'
   body = {"int_ids": [message_id]}
   resp_info = requests.post(url , json=body, auth = HTTPBasicAuth(login, password))      
   return resp_info  
   
# Параметры отправки
login = 'ЛОГИН_из_личного_кабинета_раздел_интеграции'
password = 'ПАРОЛЬ_из_личного_кабинета_раздел_интеграции'
naming = 'НЕЙМИНГ_согласованное_имя_отправителя_из_ЛК_Маркетолога'
text_message = 'Текст сообщения'
to = '79001111111'
# Отправка сообщения
sent_message(login, password, naming, to, text_message)
# Проверка статуса
if resp.status_code == 200:
   message_id = resp.json()['messages'][0]["internal_id"]
   print("Запрос отработал успешно message_id = " + message_id)
   resp_info = check_message(login, password, message_id)
   if resp_info.status_code == 200:
       event_code = resp_info.json()["events_info"][0]["events_info"][0]["status"]
       if event_code == 200:
           print("SMS отправлено получателю " + to + ". message_id = " + message_id)
       elif event_code == 201:
           print("SMS НЕ отправлено message_id = " + message_id + " Детали см по кодам ошибок в документации " + str(resp_info.content))
else:
   print("Запрос не отработал. Детали: " + str(resp.content))

Скачать файлом

<?php

class Client
{
    /**
     * @var string
     */
    var $host;
    /**
     * @var string
     */
    var $auth;

    var $timeout;

    /**
     * @param $host string
     * @param $login string
     * @param $password string
     */
    function __construct($host, $login, $password, $timeout = 60)
    {
        $this->host = $host;
        $this->auth = "Basic " . base64_encode($login . ":" . $password);

        $this->timeout = $timeout;
    }

    /**
     * @param $naming string
     * @param $text string
     * @param $phone string
     * @return $id string
     */
    function sendSms($naming, $text, $phone)
    {
        $req = [
            "messages" => [
                [
                    "content" => [
                        "short_text" => $text
                    ],
                    "to" => [
                        [
                            "msisdn" => $phone
                        ]
                    ],
                ]
            ],
            "options" => [
                "class" => 1,
                "from" => [
                    "sms_address" => $naming,
                ],
            ]
        ];
        $respStr = $this->curlRequest("messages", json_encode($req), [], "POST");

        $resp = json_decode($respStr, true);

        if (isset($resp["code"])) {
            var_dump($respStr);
            return "0";
        }


        if (!isset($resp["messages"][0]["internal_id"])) {
            var_dump($respStr);
            return "0";
        }

        var_dump("successes response:", $respStr);

        return $resp["messages"][0]["internal_id"];
    }

    /**
     * @param $ids []string
     * @return array []
     */
    function getSmsInfo($ids)
    {

        $respStr = $this->curlRequest("messages/info", json_encode(["int_ids" => $ids]), [], "POST");

        $resp = json_decode($respStr, true);

        if (isset($resp["code"])) {
            var_dump($respStr);
            return [];
        }

        var_dump("successes response:", $respStr);

        return $resp;
    }

    /**
     * @param $url
     * @param $data
     * @param $headers
     * @return bool|string
     */
    function curlRequest($url, $data = NULL, $headers = NULL, $method = "GET")
    {
        $ch = curl_init();

        curl_setopt($ch, CURLOPT_URL, $this->host . $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);

        if (!empty($data)) {
            curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        }

        $headers = array_merge($headers, ["Authorization: " . $this->auth, "Content-Type: application/json; charset=utf-8"]);

        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);

        $response = curl_exec($ch);

        if (curl_error($ch)) {
            trigger_error('Curl Error:' . curl_error($ch));
        }


        curl_close($ch);
        return $response;
    }
}


$client = new Client("https://omnichannel.mts.ru/http-api/v1/", "ЛОГИН", "ПАРОЛЬ");

// отправка сообщения
$id = $client->sendSms("НЕЙМИНГ", "ТЕКСТ СООБЩЕНИЯ", "79999999999"); // отправка смс
// если $id == 0, то была ошибка запроса

if ($id != "0") {
    // получение статуса по id сообщения
    $status = $client->getSmsInfo([$id]);
    var_dump($status);
}

Логин от подключения указан в личном кабинете: Рассылки по своей базе PRO → Интеграции → API

Код https-ответа — 200 

⚠️Успешный ответ означает, что сообщение принято платформой для обработки. HTTPS-код ответа 200 не связан со статусом сообщения 200 и не означает, что сообщение отправлено.

{
 "messages": [
 {
"msisdn": "79117903795",
"email": "example@mail.ru",
"message_id": "uuid",
"internal_id": "uuid2"
 }
 ]
}

Параметры

Код http-ответа — 400 

Код http-ответа 200 возвращается, когда общая структура запроса и авторизация корректны. Если при обработке сообщения из списка возникла ошибка — она будет описана в полях «code» и «message». 

Если получите код http-ответа, которого нет в списке — напишите в техподдержку

{
 "msg_ids": [
 "string"
 ],
 "int_ids": [
 "string"
 ]
}

{
"int_ids": [
"88b1-4622-9308", "88b1-4646-9109"
]
}

{
 "events_info": [
{
"events_info": [
{
"channel": 4,
"destination": "79870061042",
"event_at": "2021-05-18T13:45:01.000+03:00",
"internal_errors": null,
"internal_id": "c128187b-145f-4b86-b47f-8e99cf513a59",
"message_id": "10345678-f123-4694-91d7-233df79f65445",
"naming": "viber_naming",
"received_at": "2021-05-18T13:45:00.000+03:00",
"status": 200,
"total_parts": 1
},
{
"channel": 4,
"destination": "79870061042",
"event_at": "2021-05-18T13:45:05.000+03:00",
"internal_errors": null,
"internal_id": "c128187b-145f-4b86-b47f-8e99cf513a59",
"message_id": "10345678-f123-4694-91d7-233df79f65445",
"naming": "viber_naming",
"received_at": "2021-05-18T13:45:00.000+03:00",
"status": 300,
"total_parts": 1
}
],
"key": "c128187b-145f-4b86-b47f-8e99cf513a59"
}
 ]
}

{
  "messages": [
    {
      "content": {
        "text": "some message"
      },
      "from": {
        "naming": "4444",
        "user_contact": "79117903795",
        "received_at": "2022-02-04T00:00:00Z"
      },
      "channel_id": 1,
      "internal_id": "10345678-f123-4694-91d7-233df79f65445"
    }
  ]
}

Код HTTP-ответа должен быть:

• 200   OK,
• 400  — ошибки обработки параметров,
• 500 — недоступность сервисов.

{
 "items": [
 {
"message_id": "uuid",
"internal_id": "76305352-7994-4f2e-984a-95a39432d777",
"naming": "string",
"destination": "79117903795",
"status": 300,
"channel": 1,
"total_parts": 1,
"received_at": "2020-02-04T00:00:00Z",
"event_at": "2020-02-04T00:00:00Z",
"internal_errors": [
10100,
10801
]
 }
 ]
}

Код HTTPS-ответа должен быть 204 (No Content)