Getting Started

Взаимодействие с BYTEHAND API v2 происходит по протоколу HTTPS. Для подключения необходимо использовать базовый адрес https://api.bytehand.com/v1.

При работе с BYTEHAND API следует обратить внимание, что:

• Все параметры, которые содержат специальные символы (плюс, пробел и т.д.), должны быть закодированы при помощи функции urlEncode для передачи в HTTP-запросе.
• Значение заголовка Content-Type должно быть установлено как
  application/json;charset=UTF-8.
• Если запрос требует передать данные в теле запроса, то необходимо предоставить объект или список объектов в формате JSON, кодировка UTF-8.
• Если явно не указано другого, после обработки запроса BYTEHAND API возвращает ответ в формате JSON, кодировка UTF-8.

Для выполнения всех запросов BYTEHAND API v1 требуется авторизация пользователя, для этого в запросе передаются два параметра id и key.

Значения этих параметров можно получить в личном кабинете на странице settingsНастройки → вкладка Безопасность → раздел Управление ключами доступа, версия API v1.

Если в личном кабинете на странице settingsНастройки → вкладка СМС → раздел Извещения о статусе СМС сообщений вы выбрали пункт Передавать через HTTP GET запрос по адресу, то информация об отправленных СМС сообщениях будет передаваться на указанный адрес.

При создании своего обработчика передаваемой информации необходимо учитывать:

• Все параметры передаются методом GET.
• В ответ на передачу статуса сообщений клиент должен вернуть HTTP код 200 (OK), это будет означать, что статус обработан без ошибки.
• Обработка запроса должны завершиться в течение 10 секунд, иначе BYTEHAND будет считать, что обработка закончилась с ошибкой.
• Статусы сообщений, которые были обработаны с ошибкой или не были обработаны, будут переданы повторно.
• Статусы, не обработанные в течение 48 часов с момента отправки сообщения, далее не передаются клиенту.

В параметрах запроса, в фигурных скобках, можно указать, какие поля данных вы хотите получать. Если поля данных не указаны, то передаются поля: id, key, action, message, description, parts, cost, error_code, updated_at.

В качестве адреса в Настройках указано:

http://www.somesite.com/bytehand_callback?secret=msp5Tca5vuHkSz7C&sms=${sms_id}&state=${state}

Ваш обработчик будет вызываться так:

GET http://www.somesite.com/bytehand_callback?secret=msp5Tca5vuHkSz7C&sms=33328197206816238&state=DELIVERED

В качестве адреса в Настройках указано:

http://www.somesite.com/bytehand_callback

Ваш обработчик будет вызываться так:

GET http://www.somesite.com/bytehand_callback?id=1234&key=23AD33FE&action=outgoingStatus&message=33328197206816238&description=DELIVERED&error_code0&updated_at=2013-01-20+17%3A50%3A03

Все методы BYTEHAND API возвращают дату и время в часовом поясе, заданном в настройках пользователя, в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ, пример: 2017-04-25T00:41:27.000+0300.

Все методы BYTEHAND API получают дату и время по умолчанию в часовом поясе, заданном в настройках пользователя, рекомендуемый формат yyyy-MM-dd'T'HH:mm:ss.SSSZ, пример: 2017-04-25T00:41:27.000+0300.

Кроме рекомендуемого формата возможно использовать любой из дополнительных форматов.

Также можно использовать предопределённые значения и их комбинации.

Дополнительно можно использовать модификаторы даты и времени и их комбинации.

Примеры использования различных форматов, предопределённых значений и модификаторов:

• tomorrow 14:00 - означает 14:00 завтрашнего дня.
• 2011-12-03 noon - означает 2011-12-03 12:00:00.
• 3h - означает взять текущую дату и время и прибавить к ним 3 часа.
• now -12 hours +1min - означает взять текущую дату и время, отнять 12 часов и прибавить 1 минуту.