KiT Docs Portal

sendBulkMessage

POSThttp://kazinfoteh.org:809/

Запрос для отправки массовой рассылки смс сообщения. В одном запросе множество телефонов

:::highlight gray 📌
Тех. поддержка: support@kazinfoteh.kz
:::

Request

message

object

required

default

string

optional

Default – тег, в котором определяются общие атрибуты (например, заголовок), указываемые для всех отправляемых сообщений в массиве тегов . Если какой-либо параметр указан в самом атрибуте тега сообщения, то атрибут данного тега default игнорируется. Тег default является необязательным.

Воможные атрибуты:

sender – (varchar(11)) отправитель сообщения (заголовок сообщения).

date_beg – (datetime, ISO8601) дата и время отправки сообщения, необязательный атрибут, указывается для отложенной отправки сообщений. Пример 2022-12-28T15:55

msg

array[string]

required

Массив из тегов msg

msg – тег сообщения, в качестве параметра указывается текст отправляемого сообщения (обязательный параметр), может содержать следующие атрибуты параметр:

id – (integer) пользовательский числовой идентификатор сообщения, необязательный атрибут, при использовании пользователь должен гарантировать уникальность данного идентификатора в пределах своей учетной записи.

recipient – (varchar(21)) получатель сообщения (номер телефона) (обязательный атрибут), в формате 7XXXXXXXXX (без 8 и без +, например 77011234567).

sender – (varchar(11)) отправитель сообщения (заголовок сообщения) (обязательный атрибут).

date_beg – (datetime, ISO8601) дата и время отправки сообщения, необязательный атрибут, указывается для отложенной отправки сообщений. Пример 2022-12-28T15:55

type – (integer) тип сообщения: 0-текстовое сообщение. (обязательный атрибут)

<?xml version="1.0" encoding="utf-8" ?>
<package login="mycompany" password="123456">
  <message>
    <default sender="INFO_KAZ"/>
    <msg id="111" recipient="77011234567" sender="KiT_Notify" date_beg="2023-09-24:55" type="0">text</msg>
    <msg recipient="77011234568">text2</msg>
  </message>
</package>

Request samples

Responses

OK(200)

ERR_UNKNOWN (200)

ERR_FORMAT(200)

ERR_AUTHORIZATION(200)

Record Not Found(404)

HTTP Code: 200

Content Type : XMLapplication/xml

message

object

required

msg

array[string]

required

Массив из тегов msg

msg – тег сообщения, в качестве параметра возвращается код статуса, может содержать следующие атрибуты:

id – (integer) пользовательский числовой идентификатор сообщения, необязательный атрибут, возвращается при указании данного атрибута в запросе.

sms_id – (integer) числовой идентификатор сообщения присвоенный шлюзом.

sms_count – (integer) количество SMS к отправке.

Коды статусов сообщений.
Данные коды используются при возврате статусов сообщений.

статусы сообщений:
SCHEDULED = 100, // Сообщение в ожидании (задан параметр date_beg отложенная отправка сообщения и дата и время еще не наступили)
ENROUTE = 101, // Неверный номер телефона.
DELIVERED = 102, // Доставленно до абонента
UNDELIVERABLE = 105, // Не доставеленно до абонента.
ACCEPTED = 106, // Успешно принято.

статусы ошибок:
ERR_UNKNOWN = 200, // Неизвестная ошибка
ERR_ID = 201, // Неправильный ID сообщения
ERR_SENDER = 202, // Неправильный идентификатор отправителя
ERR_RECIPIENT = 203, // Неправильный номер получателя
ERR_LENGTH = 204, // Слишком длинное или пустое сообщение
ERR_USER_DISABLE = 205, // Пользователь отключен
ERR_BILLING = 206, // Ошибка биллинга
ERR_OVERLIMIT = 207 // Превышение лимита выделенных сообщений

<?xml version="1.0" encoding="utf-8" ?>
<package>
	<message>
		<msg id="111" sms_id="37839" sms_count="1">106</msg>
		<msg sms_id="37840" sms_count="1">106</msg>
	</message>
</package>

Last modified: a year ago