Получение списка всех смс

Метод	`get.sms`
Описание	Получение списка всех смс
Кому доступен	Агент, Клиент
Необходимые компоненты для работы с методом	Data API для настройки
Вес метода	1 балл

Параметры запроса

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет		Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет		Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`report_id`	number	да		Уникальный идентификатор отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list" Обязателен, если не указан `report_type`
`report_type`	enum	да		Тип отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.report_types" Обязателен, если не указан `report_id`
`date_from`	iso8601	да	YYYY-MM-DD hh:mm:ss	Дата начала основной выборки(ограничение 366 дней)
`date_till`	iso8601	да	YYYY-MM-DD hh:mm:ss	Дата окончания основной выборки
`fields`	array	нет		Список идентификаторов пользовательских столбцов, разделенных запятой. Для получения данных по SMS необходимо указывать данный параметр, и в нём названия столбцов, в зависимости от того, какую информацию по смс необходимо получить (например, sms_message для получения текста смс, virtual_phone_number - виртуальный номер, на который получено смс и т.д.). Доступный список столбцов см.раздел "Получение вложенности столбцов" . Порядок влияет на ответ.
Фильтры применяемые в отчете
`filter`	object	нет	Допустимо использовать не более `2 уровней` вложенности. Смотри примеры ниже	Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации"
`filters`	array	да		Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Получение списка возможных условий фильтрации для отчета" .
`field`	string			Поле сущности к которой будет применяться фильтрация (список заранее определён для метода)
`operator`	enum			Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации"
`value`	string			Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота.
Сортировка применяемая в отчете
`sort`	array	нет		Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных"

Параметры ответа

Внимание! Могут быть доступны не все параметры ответа, для получения полного и актуального для вас списка, воспользуйтесь списком мнемоник(id) столбцов из ответа "Получение вложенности столбцов"

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Ответ по умолчанию	Описание
`sms_id`	string		да	да	да	Уникальный идентификатор CMC
`sms_date_time`	iso8601	YYYY-MM-DD hh:mm:ss	да	да	да	Дата и время СМС
`contact_phone_number`	string		да	да	да	Номер контакта от которого поступил СМС
`virtual_phone_number`	string		да	да	да	Виртуальный номер на который поступи СМС
`sms_message`	string		да	да	да	Сообщение в СМС

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.sms",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "report_id": "number",
    "date_from":"iso8601",
    "date_till":"iso8601",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields:[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
    {
     "sms_id": "string",
     "sms_date_time": "iso8601",
     "contact_phone_string": "string",
     "virtual_phone_number": "string",
     "sms_message": "string"
    }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"