Метод, описанный в этой статье, предназначен только для SME.
В результате выполнения запроса возвращаются данные подписи SMS по ее идентификатору. Запрос может быть выполнен без параметров и тогда возвращается список всех SMS-подписей. В случае успешного выполнения запроса возвращается JSON-объект (список объектов) с данными подписи и код ответа 200 ОК. В случае неуспешного выполнения запроса возвращается один из следующих кодов ошибки:
- 400 — некорректный идентификатор подписи;
- 404 — подпись не найдена.
URL-адрес подключения
Для получения данных SMS-подписи выполняется GET-запрос на URL-адрес: https://sms.edna.ru/connector_sme/api/smsSubject/{smsSubjectId}
Параметры запроса
Запрос имеет один необязательный параметр smsSubjectId
, который передается как часть URL. Это идентификатор SMS-подписи. Если указать идентификатор, в ответ вернутся данные только этой подписи. Если не указывать, то список со всеми имеющимися подписями.
Формат ответа
В ответ на запрос возвращается JSON-объект или список JSON-объектов с данными подписей клиента.
{ "id": 1, "subject": "edna", "state": "approved", "active": true, "updatedAt": "2014-07-17T12:00:00.000Z" }
Параметры ответа
Параметр | Тип данных | Описание |
id | int (required) | Идентификатор подписи |
subject | string (required) | Текст подписи |
state | string (required) | Статус подписи. Возможные значения: • approved — подпись одобрена и может быть использована в SMS• rejected — подпись отклонена и не может быть использована в SMS• pending — на рассмотрении, не может быть использована в SMS |
active | boolean (required) | Текущий статус использования подписи: • true — подпись в данный момент используется в SMS-сообщениях• false — подпись в данный момент не используется в SMS-сообщениях (заблокирована клиентом или edna) |
updateAt | string (required) | Дата и время последнего редактирования подписи, например, 2014-07-17T12:00:00.000Z. Дата и время, разделенные буквой Т. «00.000» — количество секунд и миллисекунд. «Z» — означает время по UTC |