Получение списка отправителей

Спецификация для получения списка отправителей: XML

Метод отправки POST

Кодировка XML-документов: UTF-8

Обязательный заголовок: Content-type: text/xml; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/xml/originator.php

Параметры запроса на отправку сообщения

Параметр
Тип
Описание

request

.security

.login

[value]*

String

Ваш логин в системе

request

.security

.password

[value]*

String

Ваш пароль в системе

request

.security

.token

[value]*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

*- обязательный параметр

В случае получения правильного XML-документа

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <any_originator>FALSE</any_originator>
     <list_originator>
          <originator MCC="МСС" MNC="МНС" template="шаблон" comment="комментарий" history="комментарий" operator="оператор" state="rejected" type_sending="sms" type_traffic="multi">Отправитель</originator>
     </list_originator>
</response>
Параметр
Тип
Описание

response

.any_originator

String

TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных.

  • Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается.

  • Если FALSE, то клиент может использовать только отправителей со статусом «ready»

response

.list_originator

.originator

[state]

String

Статус отправителя:

  • «order» – оформляется

  • «ready» - готов к использованию

  • «rejected» – отклонен

response

.list_originator

.originator

[mcc]

String

Мобильный код страны

response

.list_originator

.originator

[mnc]

String

Мобильный код оператора

response

.list_originator

.originator

[template]

String

Наименование шаблона

response

.list_originator

.originator

[comment]

String

Комментарий клиента

response

.list_originator

.originator

[history]

String

Комментарий менеджера

response

.list_originator

.originator

[operator]

String

Используемое направление

response

.list_originator

.originator

[type_sending]

String

Тип отправителя. Возможные значения:

  • sms

  • flashsms

  • wappush

  • vcard

  • silence

  • viber

  • vk

  • telegram

  • whatsapp

  • skype

  • facebook

  • e_mail

  • voice

  • voice_ivr

  • hlr

  • pingsms

  • flashcall

  • twitter

  • instagram

  • hangouts

  • yandex

  • icq

  • wechat

  • qq

  • snapchat

  • discord

  • line

  • hlr_whatsapp

  • hlr_telegram

  • hlr_viber

  • hlr_voice

  • hlr_voice_ivr

  • hlr_flashcall

response

.list_originator

.originator

[type_traffic]

String

Тип трафика. Возможные значения

  • multi

  • transaction

  • service

  • commercial

  • authorization

В случае возникновения ошибки в отправленном XML-документе

<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
Параметр
Тип
Описание

response

.error

String

Текст ошибки может принимать следующие значения:

  • Неправильный формат XML документа

  • Ваш аккаунт заблокирован

  • Неправильный логин или пароль

  • POST данные отсутствуют

Пример XML запроса

<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>

Last updated