Webcom Mobi API Документация
EN
  • Введение
  • Способы взаимодействия с А2P платформой
    • Спецификация JSON
      • Отправка SMS, Viber, Flash SMS, WAP-Push
      • Запрос статуса SMS
        • POST запрос
        • Webhook
      • Запрос проверки баланса
    • Спецификация HTTP GET
      • Отправка SMS
      • Отправка Viber
      • Отправка Каскада
      • Запрос статуса сообщения
      • Регистрация
    • Спецификация XML
      • Отправка SMS, Viber, Flash SMS, WAP-Push
      • Запрос статуса SMS
        • POST запрос
        • Webhook
      • Запрос проверки баланса
      • Запрос на получение списка отправителей
      • Запрос на добавление отправителей
      • Запрос входящих SMS
      • Запрос на получение информации по номеру телефона
      • Запрос на получение списка баз
      • Запрос на изменение параметров, добавление/удаление баз
      • Запрос на получение списка абонентов базы
      • Запрос на добавление/редактирование/удаление абонентов базы
      • Запрос на получение списка номеров из СТОП-листа
      • Запрос на добавление/удаление абонентов в СТОП-лист
      • Запрос на получение списка запланированных SMS
      • Запрос на удаление запланированной SMS
      • Запрос на получение времени изменения чего-либо
      • Запрос проверки времени
      • Запрос на загрузку файлов
      • Запрос на пополнение баланса пользователям
  • ВЗАИМОДЕЙСТВИЕ С ПЛАТФОРМОЙ MSG (НЕОФ КАНАЛЫ)
    • Спецификация JSON
      • Чекинг базы номеров
Powered by GitBook
On this page
  • Создание заявки на проверку номеров
  • POST /api/checking/create
  • Заголовки
  • Проверка статуса заявки
  • POST /api/checking/get-status
  • Запрос на получение данных фильтрации
  • GET /api/checking/get-file/<hash>
  1. ВЗАИМОДЕЙСТВИЕ С ПЛАТФОРМОЙ MSG (НЕОФ КАНАЛЫ)
  2. Спецификация JSON

Чекинг базы номеров

Основной адрес https://msg.webcom.mobi

Создание заявки на проверку номеров

POST /api/checking/create

Заголовки

Authorization

Bearer <you-token>

Content-type

multipart/form-data;

Тело запроса

Name
Type
Description
Possible options

type

string

обязательное

WA_cheking

Viber_cheking

Telegram_cheking

name

string

необязательное

phones

string

обязательное в случае если не заполнено поле phones_file

Номера в международном формате по 1-му номеру в каждой строке

phones_file

file

обязательное в случае если не заполнено поле

phones

Наполнение текстового файла: Номера в международном формате по 1-му номеру в каждой строке

Ответ 200

Name
Type
Description

success

boolean

Результат обработки

data.id

integer

id созданной заявки

data.status

string

Status созданной заявки

data.total_phones

integer

Количество загруженных номеров заявки

Ответ 400 и другие ошибки

{
   "name": "Bad Request",
   "message": "Wrong data phones",
   "code": 0,
   "status": 400 
}

Пример

import requests url = "https://msg.webcom.mobi/api/checking/create" payload = {
   'name': 'Проверка текста',
   'type': 'WA_cheking',
   'phones': ''
} files=[
   ('phones_file', ('users.txt', open('users.txt','rb'), 'text/plain'))
]
headers = {
   'Authorization': 'Bearer <you-token>',
}
response = requests.request("POST", url, headers=headers, data=payload, files=files) print(response.text)

Проверка статуса заявки

POST /api/checking/get-status

Заголовки

Authorization

Bearer <you-token>

Content-type

multipart/form-data;

Тело запроса

Name
Type
Description
Possible options

ids

integer[]

обязательное

Массив id заявок

Ответ 200

Name
Type
Description

success

boolean

Результат обработки

data.*.id

integer

id заявки

data.*.status

string

Status заявки

new - Новая, inwork - В работе, complete - Выполнено, rejected - Отклонено, waittopay - Ожидает оплаты

data.*.total_phones

integer

Количество загруженных номеров заявки

data.*.filtered_phones

integer

Количество отфильтрованных номеров заявки

data.*.hash

string

Хеш для запроса результата фильтрации

Ответ 400 и другие ошибки

{
   "name": "Bad Request",
   "message": "Wrong data phones",
   "code": 0,
   "status": 400 
}

Пример

import requests url = "https://msg.webcom.mobi/api/checking/get-status" payload = {'ids': '[5980]'} headers = {
   'Authorization': 'Bearer <you-token>',
}
response = requests.request("POST", url, headers=headers, data=payload) print(response.text)

Запрос на получение данных фильтрации

GET /api/checking/get-file/<hash>

Заголовки

Authorization

Bearer <you-token>

Ответ 200

Загрузка текстового файла в формате .txt

Ответ 400 и другие ошибки

{
   "name": "Bad Request",
   "message": "Wrong data",
   "code": 0,
   "status": 400 
}

Пример

import requests url = 
"https://msg.webcom.mobi/api/checking/get-file/gIn3meHo-uLVE-11pG-Mksm-20ff33d54cc9" payload = {} headers = {
   'Authorization': 'Bearer <you-token>',
}
response = requests.request("GET", url, headers=headers, data=payload) with open("resp_text.txt", "w") as file: 
file.write(response.text)

Last updated 4 months ago