Сообщения SMS

Отправка СМС

Вы должны использовать POST /sms/send

Более подробную информацию вы можете найти в Запросах

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

POST: /sms/send

{
  "message": "My message",                // string (*required)
  "phone_number": "79999999999",          // string (*required)
  "device_id": "",                        // string (*optional)
  "to_sim": 1,                            // number (*optional)
  "callback_id": ""                       // string (*optional)
}

Ключ	Тип	Маркер	Значения
`message`	string	*обязательный	Текст отправляемого сообщения
`phone_number`	string	*обязательный	Номер на который отправляется сообщения
`device_id`	string	`необязательный`	Cодержит object ID вашего устройства. Посмотреть ID устройства можно в панели управления в разделе (Мои устройства). Если данное значение установлено, то обработкой данным смс займется именно это устройства и не какое больше. Если значение остается пустым или не передается вовсе, обработкой смс займется любое устройства из вашего списка подключенных устройств. Тем самым вы можете сами задавать какому устройству обрабатывать то или иное сообщение. Это полезно, если у вас подключено хотя-бы два или более устройств. В противном случаи, оставьте значение пустым или не передавайте его вовсе.
`to_sim`	number	`необязательный`	Номер слота сим карты для отправки. Если вы явно указываете `device_id` идентификатор устройства отправителя, вы можете так же передать номер слота sim карты для отправки, если ваше устройство поддерживает несколько sim карт, если вы не укажете номер сим карты, будут использоваться настройки установленные поумолчанию в панели. Посмотреть номер слота можно так же в панели управления в разделе (Мои устройства)*
`callback_id`	string	`необязательный`	Работает аналогично `device_id`, вы сами можете указать, какой Webhook возьмет в обработку событие данного сообщение. Если значение оставить пустым, или не передавать вовсе, будут отрабатывать все веб хуки, у которых включены события на изменения смс сообщений. `callback_id` значение, вы можете посмотреть в панели управления, пункт меню (Webhook)

Успешный ответ

Более подробную информацию вы можете найти в Ответах

При успешном ответе, система вернет вам код 200 и id отправленного сообщения, который можно использовать в дальнейшем для работы с смс в системе.

HTTP 200 application-json

{ 
    "id": "6654a4e8f1527149588c89f2"  // string 
}

String значения id является соответствием primitive.ObjectID

Запрос информации об СМС

Вы должны использовать POST /sms/get

Более подробную информацию вы можете найти в Запросах

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

POST: /sms/get

{    
    "id": "6654a4e8f1527149588c89f2"  //string (*required)
}

Ключ	Тип	Маркер	Значения
`id`	string	*обязательный	Идентификатор запроса СМС, в соответствии primitive.ObjectID, который выдавался вам например при Отправки СМС

Успешный ответ

Более подробную информацию вы можете найти в Ответах

HTTP 200 application-json

{
    "id": "6654a4e8f1527149588c89f2",      // string    
    "message": "test",                     // string    
    "status": 0,                           // number    
    "callback_id": "",                     // string    
    "device_id": "",                       // string    
    "phone_number": "79999999999",         // string    
    "message_status": "Ждет обработки",    // string    
    "time_create": 1716812679,             // number
    "to_sim": null                         // number
}

Ключ	Тип	Значения
`id`	string	Идентификатор СМС, в соответствии primitive.ObjectID
`message`	string	Текст сообщения
`status`	number	Числовой статус сообщения. `0` - "ждет обработки", `1` - "взято в обработку", `2` - "отправлено", `3` - "ошибка отправки", `4` - "доставлено", `5` - "ошибка доставки"
`callback_id`	string	Идентификатор WebHook, для которого было назначена обработка этого SMS
`device_id`	string	Идентификатор Устройства для которого было назначена обработка этого SMS. Если идентификатор пустой, значит это смс отправлялось рандомными устройствами из вашей панели, если их было подключено несколько штук.
`to_sim`	number	Номер слота SIM карты которая отправила SMS. Если при отправки SMS идентификатор не был задан, возвращает `null`, это означает что устройство отправляло сообщение в соответствии с задаными настройками в панели управления.
`phone_number`	string	Номер телефона
`message_status`	string	Текстовый статус смс, в соответствии с `status`
`time_create`	number	Время создания СМС, не путать с доставкой, отправкой и другими статусами. Формат Unix

Удаление СМС

Вы должны использовать DELETE /sms/del

Более подробную информацию вы можете найти в Запросах

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

DELETE: /sms/del

{   
    "id": "6654a4e8f1527149588c89f2"  // string (*required) 
}

Ключ	Тип	Маркер	Значения
`id`	string	*обязательный	Идентификатор запроса СМС, в соответствии primitive.ObjectID, который выдавался вам например при Отправки СМС

Успешный ответ

Более подробную информацию вы можете найти в Ответах

HTTP 204 No Content

Запрос списка СМС

Вы должны использовать GET /sms

Более подробную информацию вы можете найти в Запросах

Пример запроса GET: /sms?limit=5&offset=1&search=79999999999

Ключ	Тип	Маркер	Значения
`limit`	number	*обязательный	Обозначает количество записей, которое необходимо вернуть. Минимум `1` запись и максимум `100` записей нас траницу.
`offset`	number	`необязательный`	Указывает на смещение, относительно начала списка. Если параметр не задан, поумолчанию `1`, то есть, выводить с первой страницы.
`search`	string	`необязательный`	Позволяет указать набор символов для поиска. Система ищет частичные совпадения, без учета регистра по полям: `message` - текст смс, `message_status` - текстовый статус смс, `phone_number` - номер телефона.

Успешный ответ

Более подробную информацию вы можете найти в Ответах

К примеру, вы выполнили запрос /sms?limit=2&offset=1

HTTP 200 application-json

{
  "pagination": {
    "total_records": 95,
    "limit": 2,
    "offset": 1
  },
  "sms_list": [
    {
      "id": "6658053caa16b5ca5c5d72fc",
      "message": "Hello my friends",
      "status": 0,
      "callback_id": "",
      "device_id": "",
      "phone_number": "79929999999",
      "message_status": "Ждет обработки",
      "time_create": 1717044540,
      "to_sim": 2
    },
    {
      "id": "665727c04a5fad164ea38bb2",
      "message": "Hello World",
      "status": 4,
      "callback_id": "",
      "device_id": "",
      "phone_number": "79929999988",
      "message_status": "Доставлено",
      "time_create": 1716987840,
      "to_sim": null
    }
  ]
}

Ключ	Тип	Значения
`pagination`	object	Обьект, содержащий в себе ключи `total_records`, `limit`, `offset`
`total_records`	number	Указывает на общее количество смс у вас в базе.
`limit`	number	Указывает на количество записей, которое в данный момент возвращено. Соответствует указанному параметру `limit`
`offset`	number	Указывает на смещение, относительно начала списка. Соответствует параметру offset
`sms_list`	[]object	Представляет собой массив обьектов. Каждый элемент массива `sms_list` представляет одно SMS сообщение и содержит различные свойства

Ошибки в запросах

При выполнении запроса к ресурсам, могут возникать ошибки. Более подробно ознакомиться со всеми возможными ошибками и их сценариями, вы можете на странице Коды ошибок системы