Редактирование имен отправителей

Редактирование имени отправителя

PUT https://direct.i-dgtl.ru/api/v1/sender-names/{sender_name_id}

Метод доступен для SMS-отправителей в статусах AWAITING, REJECTED, APPROVED, а также для VIBER-отправителей в статусе APPROVED.
Файлы могут быть отправлены только для AWAITING и REJECTED.

Path Parameters

Name	Type	Description
sender_name_id*	integer	Идентификатор имени отправителя

Headers

Name	Type	Description
Authorization*	string	Basic {TOKEN_2}
Content-Type*	string	multipart/form-data

Request Body

Name	Type	Description
name*	string	Имя части содержимого
filename	string	Имя прикладываемого файла Для name=file
senderName	string	Новое значение имени отправителя Только для SMS-отправителей в статусе AWAITING
commonType	string	Новое значение типа имени отправителя Только SMS-отправителей в статусе AWAITING
counteragentName	string	Новое значение имени юрлица Только для SMS-отправителей в статусе AWAITING
counteragentInn	string	Новое значение ИНН юрлица Только для SMS-отправителей в статусе AWAITING
dateFrom	string	Новое значение желаемой даты начала действия Только для SMS-отправителей в статусах AWAITING и REJECTED
dateTo	string	Дата окончания действия отправителя Только для SMS и VIBER-отправителей в статусе APPROVED

200

Возвращается объект с отредактированным именем отправителя.

{
  "id": 1,
  "senderName": "test",
  "channelType": "SMS",
  "counteragentName": "Контрагент, ООО",
  "counteragentInn": "123451729124",
  "dateFrom": "2020-07-07T21:00:00Z",
  "dateTo": "2020-10-10T00:00:00Z",
  "commonType": "MULTISIGNATURE",
  "brand": "MTS",
  "status": "CLOSED",
  "fee": 0,
  "managerComment": "комментарий менеджера",
  "rejectedAt": "2020-07-09T16:55:01Z"
}

401

Использование невалидного токена / отсутствие заголовка авторизации.

4012

{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

4010

{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}

403

Использование неподходящего токена.

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}

422

Невалидные параметры в теле запроса либо несоответствующий статус имени отправителя; ниже приведены несколько примеров ответа.

{
    "error": {
        "code": 4220,
        "msg": "Changing sender name is not allowed now"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Date from isn't greater than now"
    }
}

Возможные варианты перечислений:

Параметр	Варианты
commonType	Типы имен отправителей

Пример запроса

Редактирование наименования юрлица, ИНН и даты начала действия с прикреплением нового файла

JSON

PUT https://direct.i-dgtl/ru/api/v1/sender-names/150
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: multipart/form-data; boundary=--part
--part
Content-Disposition: form-data; name="file1"; filename="document1.pdf"
< ./path/new_document.pdf
--part
Content-Disposition: form-data; name="body"
Content-Type: application/json
{
  "dateFrom": "2020-10-07T21:00:00Z",
  "counteragentName": "Новый контрагент, ООО",
  "counteragentInn": "123451729124"
}

cURL

curl -X PUT 'https://direct.i-dgtl.ru/api/v1/sender-names/150' \
-H 'Content-Type: multipart/form-data;boundary=--part' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-F 'body={"dateFrom":"2020-10-07T21:00:00Z","counteragentName":"Новый контрагент, ООО","counteragentInn":"123451729124"}' \
-F 'file1=@path/new_document.pdf'