Руководство по API AnyMessage Shop
@anymessage_helpВведение
В этом документе перечислены основные методы API, их описание, параметры и примеры ответов по работе с временными почтами. Если у Вас останутся вопросы, то мы всегда с радостью ответим Вам в Поддержке.
Навигация
FAQ
- Слова агрегаторы
- Дополнительные параметры
- Время жизни почт
- Механика возврата gmail в общий сток
- Отмена gmail под некоторые популярные сайты
- Activation Rate
- Спам для гуглов
- История
1. Общая информация
- После заказа почта активна 20мин для получения письма. Дальше автоматическая отмена по таймеру.
- Если вы не получили письмо и/или отменили почту - деньги возвращаются на баланс. Но, тут есть небольшое уточнение:
Activation rate влияет на ваш рейтинг. Если у вас одни отмены, то у вас может сниматься плата в зависимости от вашего рейтинга. Детальнее здесь.
- Если вы не получили письмо, то можете с помощью reorder попробовать получить письмо ещё раз.
- Reorder активирует почту ещё на 20мин (Время не суммируется, 2 раза отправить reorder не значит, что почта будет активна 40мин)
- После получения 1-го письма почта закрепляется за вами и вы можете получать повторные письма столько - сколько живёт сама почта. Время жизни почт здесь.
API
2. Получение баланса
- URL: https://api.anymessage.shop/user/balance
- Метод: GET
Пример запроса:
https://api.anymessage.shop/user/balance?token=$token
Где $token - это ваш личный токен (API ключ)
Пример успешного ответа:
{"status":"success","balance":"1.0"}
Примеры ошибок:
{"status":"error","value":"token"} - неверно указан ваш токен (API ключ)
3. Почты для сайта
- URL: https://api.anymessage.shop/email/quantity
- Метод: GET
- Описание: Получает список доступных почт для сайта.
Пример запроса:
https://api.anymessage.shop/email/quantity?token=$token&site=$site
Где $token - это ваш личный токен (ключ)
Где $site - сайт с которым вы работаете, например, instagram.com
Пример успешного ответа:
{
"status":"success",
"data":{
"gmx.com":{
"count":128539,"price":0.0015
},
"mail.com":{
"count":12651,"price":0.0015
},
"yandex.ru":{
"count":0,"price":0.0015
},
"rambler.ru":{
"count":34,"price":0.0015
},
"mail.ru":{
"count":0,"price":0.0015
},
"gmail.com":{
"count":0,"price":0.01
},
"email.com":{
"count":10571,"price":0.0015
},
"outlook.com":{
"count":0,"price":0.0024
},
"hotmail.com":{
"count":0,"price":0.0024
}
}
}
Примеры ошибок:
{"status":"error","value":"token"} - неверно указан ваш токен (API ключ)
{"status":"error","value":"site"} - неверно указан сайт (либо сайт специфический, обратитесь в поддержку для отладки)
4. Заказать почту
- URL: https://api.anymessage.shop/email/order
- Метод: GET
- Описание: Заказать почту для конкретного сайта.
Пример запроса:
https://api.anymessage.shop/email/order?token=$token&site=$site&domain=$domain
Где $token - это ваш личный токен (ключ)
Где $site - сайт с которым вы работаете, например, instagram.com
Где $domain - это домен, который вы хотите купить
Если стандартный парсер сервиса не работает - добавляете ®ex
Где $regex- это регулярное выражение, для поиска определенных значений в самом письме
Если Вам приходит 2 письма и получить нужно второе - указываете тему письма. В теме письма должно быть одно уникальное слово из нужного вам письма, например: ¤t_subject=verify
Где $current_subject - тема для письма. Если вам нужно найти определенное письмо из новых приходящих писем
Если вам надо получить письмо, которое УЖЕ есть на почте, то используйте $subject
Где $subject - тема для письма. Если вам нужно найти определенное письмо из ранее (старых) полученных на этой почте
Пример успешного ответа:
{"status":"success","id":"1001","email":"anymessagetest@gmx.com"}
Примеры ошибок:
{"status":"error","value":"token"} - неверно указан ваш токен (API ключ)
{"status":"error","value":"site"} - неверно указан сайт (либо сайт специфический, обратитесь в поддержку для отладки)
{"status":"error","value":"domain"} - неверно указан домен почты
{"status":"error","value":"no emails"} - нет данных почт в наличии под указанный вами сайт
{"status":"error","value":"no balance"} - недостаточно денег на балансе
5. Получить сообщение
- URL: https://api.anymessage.shop/email/getmessage
- Метод: GET
- Описание: Получить сообщение по токену и ид.
Пример запроса:
https://api.anymessage.shop/email/getmessage?token=$token&id=$id&preview=$preview
Где $token - это ваш личный токен (ключ)
Где $id - id активации
Где $preview - этот параметр указывается если вы хотите просмотреть сообщение в html формате - $preview = 1
Пример успешного ответа:
Письмо ещё не пришло
{"status":"error","value":"wait message"}
Письмо пришло
{"status":"success","value":"111111","message":"<html>...</html>"}
Примеры ошибок:
{"status":"error","value":"token"} - неверно указан ваш токен (API ключ)
{"status":"error","value":"activation canceled"} - активация отменена
{"status":"error","value":"no activation"} - нет активации почты (прошло более 20мин) либо вы неверно указали id_активации почты
6. Повторный заказ почты
- URL: https://api.anymessage.shop/email/reorder?token=$token&id=$id
- Или URL: https://api.anymessage.shop/email/reorder?token=$token&email=$email&site=$site
- Метод: GET
- Описание: Повторно заказать почту по токену и ид или по логину почты и сайту
Пример запроса с id активации:
https://api.anymessage.shop/email/reorder?token=$token&id=$id
Где $token - это ваш личный токен (ключ)
Где $id - id активации
Пример запроса с почтой и сайтом:
https://api.anymessage.shop/email/reorder?token=$token&email=$email&site=$site
Где $token - это ваш личный токен (ключ)
Где &email - почта в формате mailexample@example.com
Где &site - сайт, под который используете почту
Ниже будет описана логика работы с reorder:
1. Заказ почты order email
2. Отправка письма с сайта на почту
3. getmessage
Если получили письмо и почта живая(при реордере не будет ответа "email banned"):
1. reorder
2. Отправка письма с сайта. Если сначала отправить письмо, а потом reorder— выдаст старое письмо. Поэтому ВАЖНО сначала reorder—> отправка письма с сайта
3. getmessage
Дополнительные параметры:
$regex- это регулярное выражение, для поиска определенных значений
Если стандартный парсер сервиса не работает - добавляете ®ex
Если Вам приходит 2 письма и получить нужно второе - указываете тему письма. В теме письма должно быть одно уникальное слово из нужного вам письма, например: ¤t_subject=verify
Где $current_subject - тема для письма. Если вам нужно найти определенное письмо из новых приходящих писем
Где $subject - тема для письма. Если вам нужно найти определенное письмо из ранее (старых) полученных на этой почте
Пример успешного ответа:
{"status":"success","id":"1001","email":"anymessagetest@gmx.com"}
Примеры ошибок:
{"status":"error","value":"token"} - неверно указан ваш токен (API ключ)
{"status":"error","value":"no activation"} - нет активации почты (прошло более 20мин) либо вы неверно указали id_активации почты
{"status":"error","value":"email banned"} - почта в бане
7. Отменить почту
- URL: https://api.anymessage.shop/email/cancel
- Метод: GET
- Описание: Отменить почту по токену и ид. Под некоторые сайты отмена почты стоит 50% (касается только gmail.com под некоторые сайты. Увидеть сайты здесь).
Пример запроса:
https://api.anymessage.shop/email/cancel?token=$token&id=$id
Где $token - это ваш личный токен (ключ)
Где $id - id активации
Пример успешного ответа:
{"status":"success","value":"activation canceled"} - почта отменена
Примеры ошибок:
{"status":"error","value":"token"} - неверно указан ваш токен (API ключ)
{"status":"error","value":"activation already canceled"} - почта уже была отменена (либо по таймеру либо вы отменили ранее)
{"status":"error","value":"no activation"} - неверно указан ид_активации почты
FAQ
8. Слова агрегаторы
&domain=mailcom,gmx,hotmail,outlook,yandex,gmail
Например,
https://api.anymessage.shop/email/order?token=$token&site=$site&domain=mailcom
В ответе будет или email.com или mail.com
status"success" id"1234567890" email"example@email.com"
Или
status"success" id"1234567890" email"example@mail.com"
9. Дополнительные параметры
- URL: https://api.anymessage.shop/email/order?token=$token&site=$site&domain=$domain&save=1
- Метод: GET
- Описание: Зарезервировать сразу же после заказа почту за собой.
Пример запроса:
https://api.anymessage.shop/email/order?token=$token&site=$site&domain=$domain&save=1
Где $token - это ваш личный токен (ключ)
Где $site - сайт с которым вы работаете, например, instagram.com
Где $domain - это домен, который вы хотите купить
&save=1 - параметр резервирования почты
Важное уточнение: при работе с параметром &save=1 стоимость почты увеличивается на 20%. Например, под Instagram gmail.com стоит 0.04$. С включённым параметром цена будет 0.048$
Если почта умерла - восстановить почту уже никак
Данный параметр имеет уникальную механику на сервисе. Он работает таким образом, что резервирует почту после заказа сразу за Вами. И в случае, если не было получено письмо - почта не вернётся спустя 2 часа в общий сток(детальнее здесь). А вы при этом, сможете использовать reorder и попробовать получить письмо на неё. Также при этом не будет работать Activation Rate и за отмену списываться ничего дополнительно не будет.
10. Время жизни почт
Важное уточнение: гарантий на жизни этих почт мы не даём! Если не пришло письмо - деньги вам возвращаются (согласно вашему Activation Rate)
- Gmx.com около 3х дней
- Mail.com/Email.com 2 недели
Gmx/Email/mail.com иногда и живут дольше, но гарантировать этого не можем. Но бывали кейсы у пользователей, что reorder делали более чем через месяц.
- Hotmail.com|Outlook.com макс 6 часов
- Gmail максимум 1 день
- Rambler.ru 7 дней ( но могут и дольше)
- Yandex.com (и все его поддомены) от недели до месяца (могут дольше)
- iCloud 20 дней
Если почта умерла, восстановить её никак уже не получится
11. Механика возврата gmail в общий сток
Под популярные сайты, по типу Instagram, Facebook и Apple работает возврат в общий сток.
Если после заказа почты Вы в течении 20мин не получили письмо и почта 2 часа находилась в неактивном состоянии, то спустя эти же 2 часа почта возвращается в общий сток и её можете заказать либо вы ещё раз, либо уже другой пользователь.
Важно понимать, что если вы получили письмо на почту - другой пользователь не сможет на эту же почту под такой же сайт получить письмо. Получение письма является условием резервирования почты под вас (либо параметр &save=1. Об этом здесь)
Принцип такой: заказали почту ->20мин она активна ->не получили письмо -> возврат в общий сток спустя 2 часа
12. Отмена gmail под некоторые популярные сайты
Под сайт: Instagram.com, Apple.com отмена снимает 50% стоимости почты. Если вы заказали почту и отменили её сами (либо отмена произошла по таймеру в 20мин автоматически) списывается 50% стоимости gmail.com под этот сайт. Гуглы у нас валид 99%. В очень редких случаях может быть не валид.
13. Activation Rate
- URL: https://api.anymessage.shop/user/getratio?token=$token
- Метод: GET
- Описание: Получить информацию об Activation Rate
Activation rate — показатель доли успешных активаций относительно отмен. Список отсортирован по доле отмен по убыванию. По умолчанию отображаются только значения >= 0.5. Важно: рейтинг начинает считаться при 60% отмен (0.6), что соответствует значениям Activation rate менее 40%.
Важно: Activation rate не общий. Он рассчитывается отдельно для каждой пары «сервис + почта».
Можно игнорировать данную механику сервиса, но ценник будет +20% к стоимости почты. Также за отмены не будет возвратов. Об этом здесь.
Activation rate Плата
0% 80% <10% 60% <20% 40% <30% 20% <40% 10% ≥40% 0%
Пример расчёта:
Пример, как считать плату при отмене: 1) Покупаем почту gmx.com для instagram за 0.0015 USD. Activation rate = 40. Плата при отмене: 0.0015 × 20% = 0.0003 USD. 2) Покупаем почту gmail.com для instagram за 0.0020 USD. Activation rate = 20. Плата при отмене: 0.0020 × 40% = 0.0008 USD.
Метод: GET
Пример ответа без параметра full:
https://api.anymessage.shop/user/getratio?token=$token
{"status":"success","data":[{"site":"instagram","domain":"gmx.com","success":0,"cancels":101,"all":101,"ratio":0,"cancel_percent":80}]}
Пример ответа с параметром full:
https://api.anymessage.shop/user/getratio?token=$token&full
{"status":"success","data":[{"site":"instagram","domain":"gmx.com","success":0,"cancels":101,"all":101,"ratio":0,"cancel_percent":80},{"site":"instagram","domain":"rambler.ru","success":90,"cancels":70,"all":160,"ratio":0.562,"cancel_percent":0},{"site":"instagram","domain":"mail.com","success":60,"cancels":45,"all":105,"ratio":0.571,"cancel_percent":0},{"site":"instagram","domain":"email.com","success":100,"cancels":4,"all":104,"ratio":0.962,"cancel_percent":0},{"site":"instagram","domain":"ya.ru","success":0,"cancels":5,"all":5,"ratio":1,"cancel_percent":0},{"site":"google|gmail","domain":"gmx.com","success":0,"cancels":2,"all":2,"ratio":1,"cancel_percent":0}]}
Блокировка по Activation rate:
Опция нужна, чтобы автоматически остановить регистрации пар «сервис + почта», когда Activation rate падает. Это помогает избежать лишних расходов при росте отмен, например, когда у вас падают прокси, когда вы этого не увидели в софте.
https://api.anymessage.shop/user/enableBlockRatio?token=$token https://api.anymessage.shop/user/disableBlockRatio?token=$token
При включённой блокировке и доле отмен 0.6+ API вернёт: {"status":"error","value":"ratio block"}.
Примеры ошибок:
{"status":"error","value":"token"}
{"status":"error","value":"ratio block"}
14. Спам для гуглов
Параметр &is_spam=1. Уточню, у нас выдаёт автоматом из спама. Это для тех, кому нужно знать что письмо в спаме или нет.
Ответ такой при найденном письме, если оно попадет в спам:
{"status":"success","value":null,"message":"<div dir=\"ltr\">\r\n<div style=\"font-family:Aptos,"Aptos_EmbeddedFont","Aptos_MSFontService",Calibri,Helvetica,sans-serif;font-size:12pt;color:rgb(0,0,0)\">\r\n\u0412\u044b \u0432\u044b\u0438\u0433\u0440\u0430\u043b\u0438 1 000 000$! \u0421\u0440\u043e\u0447\u043d\u043e \u043e\u0442\u043a\u0440\u043e\u0439\u0442\u0435 \u043f\u0438\u0441\u044c\u043c\u043e!<\/div>\r\n<\/div>","is_spam":true}
Работает ТОЛЬКО на доменах GMAIL.COM
15. История
- Метод: GET
- Описание: Получить историю всех писем по вашему аккаунту; Посмотреть все письма на конкретной почте; Просмотреть конкретное письмо из истории
- URL: https://api.anymessage.shop/email/history?
- URL: https://api.anymessage.shop/email/historymessage?
Пример запроса:
https://api.anymessage.shop/email/history?token=$token&offset=1&limit=100
- История почт по вашему токену:
Где $token - ваш токен (API ключ) в нашем сервисе
Где offset - это константа, вам данный параметр менять не нужно
Где limit - кол-во отображаемых почт на странице
2. Все письма на конкретной почте:
https://api.anymessage.shop/email/historymessage?token=$token&id=$id
Где $token - ваш токен (API ключ) в нашем сервисе
Где $id- ид активации почты
3. Просмотр конкретного письма на почте:
https://api.anymessage.shop/email/historymessage?token=$token&id=$id&preview=1&message_id=0
Где $token - ваш токен (API ключ) в нашем сервисе
Где $id- ид активации почты
Где $preview - этот параметр указывается если вы хотите просмотреть сообщение в html формате - $preview = 1
Где message_id - айди письма на почте. 0 - первое письмо